JavaScript 早期沒有模塊機制,所有變量都活在全局作用域裡,稍不注意就會互相覆蓋。本文按演進順序梳理模塊化的幾種寫法,並講清 CommonJS 與 AMD 的分野,以及 require.js 的實際用法。
function m1() { /* ... */ }
function m2() { /* ... */ }
把幾個函數放在一起就算一個模塊。問題是污染全局變量,無法避免命名沖突,模塊成員之間也看不出內聚關係。
var module = new Object({
_count: 0,
m1: function () { /* ... */ },
m2: function () { /* ... */ }
});
module.m1();
成員被封裝進對象,但所有屬性對外可見,內部狀態可以被随意改寫:module._count = 4;
var module = (function () {
var _count = 0; // 私有變量
var m1 = function () { /* ... */ };
var m2 = function () { /* ... */ };
return { m1: m1, m2: m2 }; // 只暴露需要的成員
})();
console.info(module._count); // undefined
這是 JavaScript 模塊最基礎也最重要的寫法,依賴閉包實現真正的私有狀態。
模塊很大需要拆分,或者需要給已有模塊擴充方法時:
var module = (function (mod) {
mod.m3 = function () { /* ... */ };
return mod;
})(module);
瀏覽器裡各個模塊文件異步下載,誰先加載完並不確定。此時立即執行函數的參數要給一個兜底值:
var module = (function (mod) {
// ...
return mod;
})(window.module || {});
var module = (function ($, YAHOO) {
// ...
})(jQuery, YAHOO);
把依賴顯式聲明為參數,既保證模塊獨立性,又讓依賴關係一目了然。
CommonJS 由 Node.js 帶動普及,核心方法是同步的 require():
var math = require('math');
math.add(2, 3);
這在服務端沒問題,但搬到瀏覽器就會卡住:必須等 math.js 下載完才能繼續執行,網絡稍慢頁面就假死。
AMD(Asynchronous Module Definition)因此而生,采用異步加載:
require(['math'], function (math) {
math.add(2, 3);
});
第一個參數是依賴數組,第二個是加載完成後的回調。依賴沒到位之前,瀏覽器不會阻塞渲染。
傳統按順序引入多個 script 有兩個痛點:加載期間頁面停止渲染;依賴複雜時加載順序極難維護。require.js 正好解決這兩點。
<!-- 引入自身,async 避免阻塞;IE 不支援 async,故同時寫 defer -->
<script src="js/require.js" defer async="true"></script>
<!-- data-main 指定主模塊,後綴名可省略 -->
<script src="js/require.js" data-main="js/main"></script>
主模塊 main.js 中同樣用 require 聲明依賴:
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC) {
// 三個模塊都加載成功後才會執行這裡
});
require.config({
baseUrl: "js/lib", // 改變基目錄
paths: {
"jquery": "jquery.min",
"underscore": "underscore.min",
"backbone": "backbone.min"
}
});
模塊在別的主機上時也可以直接寫完整 URL。另外 require.js 要求每個模塊獨立成文件,多模塊會產生多次 HTTP 請求,因此官方提供了合併壓縮工具,部署後可減少請求數。
// 無依賴
define(function () {
var add = function (x, y) { return x + y; };
return { add: add };
});
// 有依賴:第一個參數是依賴數組
define(['myLib'], function (myLib) {
function foo() { myLib.doSomething(); }
return { foo: foo };
});
老庫不遵循 AMD,需要用 shim 配置:
require.config({
shim: {
'underscore': { exports: '_' },
'backbone': {
deps: ['underscore', 'jquery'], // 依賴聲明
exports: 'Backbone' // 對外暴露的變量名
}
}
});
jQuery 插件也是同理:deps: ['jquery'] 保證順序,exports 指定導出對象。
// domready:DOM 就緒後再執行回調
require(['domready!'], function (doc) { /* ... */ });
// text / image:允許加載文本與圖片資源
define(['text!review.txt', 'image!cat.jpg'], function (review, cat) {
console.log(review);
document.body.appendChild(cat);
});
補充一句現狀:如今新項目基本已經全面轉向 ES Module(import / export),AMD 與 require.js 主要存在於存量項目中。但理解這套演進邏輯,對看懂老代碼、理解打包工具的模塊處理方式仍然很有幫助。