模塊化算不上什麼高深技術,卻是公認的編程最佳實踐之一。有了模塊,我們才能按需引入別人的成果——要什麼功能就載入什麼模塊,不必把整份程式碼搬進自己的專案,開發效率自然水漲船高。
把模塊想像成積木就更直觀了:積木的特點是「小而簡單」,一塊只承擔一種形狀。程式裡的模塊也該如此,每個函數一次只做好一件事。這樣的設計帶來的直接好處是,別人調試和修改時不需要通读全部程式碼,就能明白每一塊在做什麼。
JavaScript 的作用域以函數為單位,所以最直接的想法就是把功能包進函數:
function fn1() { /* code */ }
function fn2() { /* code */ }
問題很明顯:這些函數都掛在全局對象上,等于污染了全局命名空間,一旦與其他模塊出現同名,就會互相覆蓋。
var myModule1 = {
fn1: function () { /* code */ },
fn2: function () { /* code */ }
};
命名衝突的問題緩解了,但新的毛病冒出來:所有成員都是公開的,外部程式可以隨意讀寫內部狀態,封裝性形同虛設。
var myModule = (function () {
function fn1() { /* code */ }
function fn2() { /* code */ }
return {
fn1: fn1,
fn2: fn2
};
})();
這是最經典的模塊寫法:內部變量天然屬於私有作用域,只有 return 出來的成員才對外可見。後來的 AMD、CMD 乃至 CommonJS 的瀏覽器端方案,思想根源都在這裡。
看一個例子。假設要寫一個創建超連結的函數,並給 mailto 類型加上樣式類:
function addLink(text, url, parentElement) {
var newLink = document.createElement('a');
newLink.setAttribute('href', url);
newLink.appendChild(document.createTextNode(text));
if (url.indexOf("mailto:") == -1) {
newLink.className = 'mail';
}
parentElement.appendChild(newLink);
}
它能跑,但耦合了三件事:建節點、判斷協議、插入 DOM。哪天需求變成「只創建但不插入」,或者「插入到別的位置」,這個函數就得重寫。函數承擔的職責越特殊,可複用性就越差。
按「一個函數只乾一件事」的原則拆開:
function createLink(text, url) {
var newLink = document.createElement('a');
newLink.setAttribute('href', url);
newLink.appendChild(document.createTextNode(text));
return newLink;
}
現在 createLink 只負責造出一個節點並返回,插入哪裡、要不要加樣式,交給調用方決定。這才是模塊化真正想要的效果。
瀏覽器端沒有模塊系統,勉强还能凑合,畢竟網頁的複雜度有限;伺服器端則完全不行,程式必須與作業系統和其他應用協作,沒有模塊根本無法組織。
有意思的是,第一個真正流行起來的模塊化規範並非來自瀏覽器,而是出自伺服器端——CommonJS 由 Node.js 發揚光大,標誌著 JavaScript 模塊化編程正式登上歷史舞台。Node 的模塊系統正是基於它實現的。
CommonJS 用一個全局方法 require() 來載入模塊:
var math = require('math'); // 載入模塊
math.add(2, 3); // 調用模塊方法
它的局限也很清楚:上面第二行程式必須等 math.js 完全載入後才能執行,屬於同步加載。放在伺服器端沒問題,因為模塊都在本地硬盤,等待時間就是磁盤讀取的時間;但搬到瀏覽器,網路延遲會讓頁面卡住數秒,體驗很差。
異步模塊定義,代表實現是 require.js。它的目標有兩個:一是異步載入 js 文件,避免頁面失去響應;二是管理模塊間的依賴關係,讓程式碼更易維護。
// 定義模塊
define(["./cart", "./inventory"], function (cart, inventory) {
return {
color: "blue",
size: "large",
addToCart: function () {
inventory.decrement(this);
cart.add(this);
}
};
});
// 載入模塊
require(["some/module", "my/module", "a.js", "b.js"], function (someModule, myModule) {
// 所有依賴就緒後才會執行這個回調
});
通用模塊定義,由國內社區推動發展,代表實現是 sea.js。
// 定義模塊
define(function (require, exports, module) {
var $ = require('jquery');
var Spinning = require('./spinning');
exports.doSomething = ...; // 通過 exports 對外提供接口
module.exports = ...; // 或者整體導出
});
// 載入模塊
seajs.use("../static/hello/src/main");
· 依賴執行時機:AMD 依賴前置、提前執行;CMD 依賴就近、延遲執行(RequireJS 從 2.0 起也支持延遲,具體取決於寫法)。
· 設計哲學:AMD 推崇依賴前置,一眼能看清模塊需要什麼;CMD 推崇「as lazy as possible」,只有真正用到時才去載入。
放到今天看,Node 環境裡 CommonJS 仍是主流,瀏覽器端則早已被 ES Module(import/export)取代,AMD 與 CMD 更多作為理解模塊化演進的坐標存在。但無論規範如何更替,「小而簡單、職責單一、顯式聲明依賴」這幾條原則始終沒變。