Node.js 裡有兩個容易混淆的內建變數:__dirname 與 __filename。前者是當前檔案所在的目錄絕對路徑,後者則是包含檔名的完整路徑。本文示範 __dirname 在組裝檔案路徑時的作用。
建立 app.js,內容如下:
console.log(__dirname + '/example.db');
console.log('example.db');
若 app.js 位於根目錄,執行 node app.js 輸出:
/Users/durban/nodejs/koa-mysql-orm-model/example.db example.db
建立 app 資料夾,並在其中建立同名檔案,內容完全相同。同樣執行 node app.js:
/Users/durban/nodejs/koa-mysql-orm-model/app/example.db example.db
差別一目了然:__dirname 會自動帶上檔案自身所在的目錄路徑,而單純寫相對路徑的 'example.db' 則維持原樣。
相對路徑在 Node.js 中是以「執行指令時的工作目錄」(process.cwd())為基準解析的,而不是以檔案位置為基準。這代表同一份程式碼,從專案根目錄執行與從其他目錄執行,可能會指向完全不同的檔案——這正是「找不到檔案」類錯誤最常見的來源。
以 __dirname 組裝路徑的好處,就是讓檔案定位不受啟動位置影響,避免不同模組之間互相干擾。更推薦寫法是使用內建的 path 模組:
const path = require('path');
path.join(__dirname, 'example.db');
path.join() 會自動處理不同平台的斜線差異(Windows 用反斜線、類 Unix 用正斜線),比字串拼接更穩妥。
在 ES Module(.mjs 或 package.json 標註 "type": "module")中,__dirname 已被移除,需自行取得:
import { fileURLToPath } from 'url';
import { dirname } from 'path';
const __dirname = dirname(fileURLToPath(import.meta.url));
凡是需要讀寫本地檔案(設定檔、資料庫、模板、靜態資源),一律用 __dirname 搭配 path.join() 組裝絕對路徑,就不會再被啟動目錄影響。