JavaScript 在設計之初並沒有語言層級的模塊機制,不像 Java 有 package 與 import。ES6 雖然引進了 class 與 import,但瀏覽器全面支援還需時間。因此在很長一段時間裡,社區靠 CommonJS 與 AMD 兩套規範撐起了前端工程化。
所謂模塊化,就是把系統拆成多個高內聚、低耦合的功能單元,各自存放在不同檔案中,透過明確的介面互相引用。隨著 JavaScript 應用日益大型化,這種組織方式從「加分項」變成了「必需品」。
CommonJS 起源於「在瀏覽器之外構建 JavaScript 系統」的訴求,主要特點是同步加載、運行在服務端。Node.js 就是它最具代表性的實作。
它的定義非常精簡,只由三部分構成:模塊定義(exports)、模塊引用(require)、模塊標識。
// 定義行為
function Foobar() {
this.foo = function () { console.log('Hello foo'); };
this.bar = function () { console.log('Hello bar'); };
}
// 把 Foobar 暴露給其他模塊
exports.Foobar = Foobar;
// 假設檔案與當前模塊位於同一目錄
var Foobar = require('./foobar').Foobar;
var test = new Foobar();
test.bar(); // 'Hello bar'
模塊標識就是傳給 require 的路徑參數,用來指定要加載的檔案,副檔名 .js 可以省略。
為了把 CommonJS 帶進瀏覽器,社區出現了 Browserify 這類工具:它把依賴的眾多 js 檔打包成單一檔案,再統一交給瀏覽器加載。
AMD(Asynchronous Module Definition,異步模塊定義)是為瀏覽器環境設計的,採用異步加載。模塊的加載不阻塞後續語句執行,所有依賴該模塊的程式都寫在回呼函數裡,等加載完成後才執行。
define( id?: String, // 可選,模塊名稱 dependencies?: String[], // 可選,依賴模塊清單 factory: Function | Object // 用來初始化模塊的函數或物件 );
dependencies 中列出的每個模塊,其輸出會依序作為參數傳入 factory。若 factory 是函數,其回傳值就是模塊的對外介面。
define('myModule',
// 依賴
['foo', 'bar'],
// foo 與 bar 被映射為函數參數
function (foo, bar) {
// 在這裡建立模塊並回傳
var myModule = {
doSomething: function () {}
};
return myModule;
}
);
define(function () {
return {
doSomething: function () {}
};
});
require(['foo', 'bar'], function (foo, bar) {
foo.doSomething();
});
define(function (require) {
var isReady = false, foobar;
require(['foo', 'bar'], function (foo, bar) {
isReady = true;
foobar = foo() + bar();
});
return {
isReady: isReady,
foobar: foobar
};
});
這段程式有個值得注意的細節:foo 與 bar 加載完成之前,isReady 一直是 false。這是異步載入的必然結果,也是 AMD 最容易踩的坑——模塊的 return 執行在依賴就緒之前。
實作 AMD 規範的主要有 require.js 與 curl.js 兩套庫,其中 RequireJS 的作者 James Burke 也正是 AMD 規範的制訂者。
在 ES Module 成為標準之前,正是這兩套規範讓 JavaScript 工程化成為可能。今天我們寫 import / export,背後的思想血脈仍可追溯到它們。理解 CommonJS 與 AMD,等於理解了「為什麼模塊需要被定義、被引用、被快取」這三個根本問題。