JavaScript 是 Web 世界最普及的語言,但它的誕生幾乎是一場「備戰式」的產物——Netscape 為了在當年的瀏覽器大戰中對抗 Microsoft,在極短的時間內把語言核心趕了出來。時間壓縮帶來了效率,也留下了歷史包袱,其中最讓後人頭痛的一條,就是所有腳本共用同一個全域命名空間。
當一個頁面載入了多段 JavaScript 程式碼,它們會被一併注入到同一個全域環境裡,共享同一塊位址空間。變數名撞車、函式被後載入的腳本悄悄覆蓋、第三方程式庫彼此干擾……這類問題不但難以預防,一旦發生又極難追蹤。
Node.js 的選擇很乾脆:不繼承這個包袱。它採用了 CommonJS 模組規範,讓每個檔案擁有自己獨立的上下文。既然根本不存在全域作用域,模組之間自然也就不會互相污染。
把程式碼切成職責清晰的模組,是掌控專案複雜度的第一步。接下來我們看看 Node 到底怎麼載入模組,以及怎麼寫出自己的模組。
在 Node 裡引用模組有兩種寫法:給路徑,或者給名稱。給名稱時,若非核心模組,Node 會把這個名稱逐步映射到實際的檔案路徑上;而核心模組在 Node 啟動時就已經被預先載入,屬於「問就有」的一類。
所謂非核心模組,包含用 NPM(Node Package Manager)安裝的第三方套件,以及你或同事自己寫的本地模組。載入方式就是 require:
var module = require('module_name');
require 會回傳一個物件,裡面裝著該模組對外公開的 API。這個回傳值可以是任何 JavaScript 值:一個函式、一個陣列,或是一個掛滿屬性的物件,完全取決於模組作者怎麼設計。
CommonJS 是 Node 檔案之間共享物件與函式的唯一途徑。當專案長大,你應該主動把類別、物件、函式重構成定義清楚、可重複使用的模組;而模組只會把它「願意」給的部分暴露出來。
Node 裡檔案與模組是一一對應的。以下建立一個 circle.js,只導出一個 Circle 建構函式:
function Circle(x, y, r) {
function r_squared() {
return Math.pow(r, 2);
}
function area() {
return Math.PI * r_squared();
}
return { area: area };
}
module.exports = Circle;
關鍵是最後一行。module 是一個特殊變數,代表當前模組本身;module.exports 則是這個模組對外輸出的物件。在這個例子中我們導出了 Circle 建構函式,使用者拿到它就能建立 Circle 實例。
你也可以導出結構更豐富的物件。module.exports 預設被初始化為一個空物件,任何想對外公開的東西,掛成它的屬性即可:
function printA() {
console.log('A');
}
function printB() {
console.log('B');
}
module.exports.printA = printA;
module.exports.printB = printB;
module.exports.pi = Math.PI;
這個模組對外提供了兩個函式與一個數值,使用起來是這樣:
var myModule2 = require('./myModule2');
myModule2.printA(); // -> A
myModule2.printB(); // -> B
console.log(myModule2.pi); // -> 3.141592653589793
只要模組存在、沒有語法錯誤、初始化過程也沒炸,require 就會把模組物件交回給你,你可以把它賦給任何區域變數。依模組類型不同,解析規則也不一樣。
Node 有一批被編譯進二進位檔的核心模組,只能用名稱引用、不能用路徑引用。核心模組的優先級最高:即使你安裝了一個同名的第三方套件,Node 依然先載入核心模組。
var http = require('http');
這行會回傳 http 模組物件,上面掛著官方 API 文件中定義的那些方法。
你可以用絕對路徑:
var myModule = require('/home/pedro/my_modules/my_module');
也可以用相對於當前檔案的相對路徑:
var myModule = require('../my_modules/my_module');
var myModule2 = require('./lib/my_module_2');
值得注意的是副檔名可以省略。若 Node 找不到該檔案,它會自動補上 .js 再找一次(實際上還會嘗試 .json 與 .node)。所以下面兩種寫法完全等價:
var myModule = require('./my_module');
var myModule = require('./my_module.js');
路徑也可以指向一個目錄:
var myModule = require('./myModuleDir');
Node 會把這個目錄當成一個套件,先找其中的 package.json。若找不到,就退回預設入口 index.js(也會嘗試 index.node)。
若 package.json 存在,Node 會解析它並讀取 main 欄位,把它的值當成入口檔的相對路徑。例如:
{
"name" : "myModule",
"main" : "./lib/myModule.js"
}
那麼 require('./myModuleDir') 實際載入的就是 ./myModuleDir/lib/myModule.js。
如果 require 的參數既不是相對路徑也不是核心模組名,Node 會往 node_modules 裡找:
var myModule = require('myModule.js');
它先在當前目錄的 ./node_modules 下尋找,找不到就往外層目錄的 node_modules 繼續找,一層層往上直到根目錄。這個「向上遞歸」的機制讓依賴可以自然分層。
實務上,與其手動維護 node_modules,不如把這份工作交給 NPM——本地 node_modules 正是 NPM 安裝套件的預設位置,兩者的設計天生綁在一起。
模組第一次載入成功後會被快取。也就是說,只要模組名解析到同一個檔案路徑,後續每次 require 拿到的都是同一個物件。
假設有個 my_module.js:
console.log('module my_module initializing...');
module.exports = function() {
console.log('Hi!');
};
console.log('my_module initialized.');
載入一次:
var myModuleInstance1 = require('./my_module');
輸出:
module my_module initializing...
my_module initialized.
載入兩次:
var myModuleInstance1 = require('./my_module');
var myModuleInstance2 = require('./my_module');
輸出依然只有上面那兩行——初始化程式碼只跑了一次,兩個變數指向同一個物件。這在設計單例、連線池時非常好用;但反過來說,如果你的模組初始化階段藏著有副作用的程式碼(例如建立連線、註冊全域計時器),一定要清楚它只會被觸發一次。
Node 拿掉了 JavaScript 預設的全域作用域,改用 CommonJS 模組系統,讓程式碼組織更清楚,也順帶解決了一整批命名衝突與安全問題。核心模組、第三方模組、自寫的檔案與目錄模組,都可以透過 require 載入;放在 node_modules 底下或用 NPM 安裝的模組,還能直接用名稱引用。
Node 官方文件把整個流程寫得比多數書都清楚,值得直接讀一遍。核心邏輯整理如下:
require(X) —— 從路徑 Y 載入模組 X
1. 若 X 是核心模組 -> 載入並回傳,結束
2. 若 X 以 './'、'/' 或 '../' 開頭
a. LOAD_AS_FILE(Y + X)
b. LOAD_AS_DIRECTORY(Y + X)
3. LOAD_NODE_MODULES(X, dirname(Y))
4. 丟出例外:not found
LOAD_AS_FILE(X)
1. X 是檔案 -> 當作 JavaScript 腳本載入,結束
2. X.js 是檔案 -> 載入 X.js,結束
3. X.node 是檔案 -> 當作 Node 二進位插件載入,結束
LOAD_AS_DIRECTORY(X)
1. 若 X/package.json 存在
a. 解析並取出 main 欄位
b. M = X + main 的值
c. LOAD_AS_FILE(M)
2. 若 X/index.js 存在 -> 載入,結束
3. 若 X/index.node 存在 -> 載入,結束
LOAD_NODE_MODULES(X, START)
1. DIRS = NODE_MODULES_PATHS(START)
2. 對 DIRS 中每個 DIR
a. LOAD_AS_FILE(DIR/X)
b. LOAD_AS_DIRECTORY(DIR/X)
把這份清單記在手邊,之後遇到「明明檔案就在那裡卻載不到」的狀況,照著順序排查即可。