模組化是最常見的 JavaScript 編程模式之一,它能讓程式碼結構更清楚、 easier to maintain。本文從基礎模式談到進階技巧,說明如何在真實專案中組織程式碼。
這是整個模組化體系的地基,也是最能體現 JavaScript 特性的寫法:建立一個匿名函式並立刻執行它。所有程式碼跑在這個函式內部,生存在一個私有閉包裡,其中的變數不會外洩,卻能貫穿整個應用程式的生命週期。
(function () {
// 這裡的所有變數與函式都只在這個範圍內可見
// 同時仍可存取所有全域變數
}());
最外層那對括號不是裝飾,而是必要的。因為 JavaScript 語法中,以 function 開頭的敘述一律會被當成函式宣告;用括號包起來,直譯器才會把它視為函式表達式。
JavaScript 有所謂的隱含全域變數:直譯器會沿著作用域鏈往外找某個變數的 var 宣告,找不到就當它是全域;如果它出現在指派敘述左邊且不存在,就會憑空創造一個全域變數。這讓在閉包中誤建全域變數變得非常容易,而人的眼睛根本分不出哪些變數是全域的。
匿名函式提供了簡潔的解法:把需要的全域變數當參數傳進來。
(function ($, YAHOO) {
// 這段程式碼中的 $ 與 YAHOO 都是明確的傳入參數
}(jQuery, YAHOO));
有時你不只是要「用」全域變數,還要「宣告」自己的模組給外部使用。做法是把要暴露的東西掛到一個物件上,再從匿名函式回傳它:
var MODULE = (function () {
var my = {},
privateVariable = 1;
function privateMethod() {
// 外部無法存取
}
my.moduleProperty = 1;
my.moduleMethod = function () {
// 這裡可以存取 privateVariable 與 privateMethod
};
return my;
}());
這樣就得到一個全域模組 MODULE,對外公開 moduleProperty 與 moduleMethod 兩個成員,同時用閉包維護私有狀態。這就是最基本的模組模式雛形。
「整個模組必須寫在同一個檔案」是基本模式的限制。大型專案中把 JavaScript 拆成多檔是必要之舉,放大模式正是為此而生:先導入既有模組,為它加上屬性,再導出。
var MODULE = (function (my) {
my.anotherMethod = function () {
// 新增的方法
};
return my;
}(MODULE));
執行完之後,MODULE 就多了 anotherMethod。這個檔案可以維護自己的私有狀態與導入的依賴。
上面的寫法要求原模組必須先被執行過,模組才能放大。但 JavaScript 應用效能優化的重要手段之一就是讓腳本非同步、任意順序載入。寬放大模式解決了這個問題:
var MODULE = (function (my) {
// 新增能力
return my;
}(MODULE || {}));
關鍵在 MODULE || {}:即使模組還沒被初始化,這行也會先幫你建一個空物件。因此你可以用 LABjs 這類工具並行載入所有模組檔而不互相阻塞。
寬放大模式很棒,但有兩個限制:無法安全地覆寫模組既有屬性,也無法在初始化階段使用其他檔案定義的屬性(執行期可以)。緊放大模式引入了載入順序,允許覆寫:
var MODULE = (function (my) {
var old_moduleMethod = my.moduleMethod; // 保留舊實作的參照
my.moduleMethod = function () {
// 覆寫,需要時仍可透過 old_moduleMethod 呼叫原方法
};
return my;
}(MODULE));
var MODULE_TWO = (function (old) {
var my = {}, key;
for (key in old) {
if (old.hasOwnProperty(key)) my[key] = old[key];
}
var super_moduleMethod = old.moduleMethod;
my.moduleMethod = function () {
// 在複製品上覆寫,仍可透過 super_moduleMethod 存取原方法
};
return my;
}(MODULE));
這個模式靈活性最差。它看起來整齊,但代價是:屬性若為物件或函式,複製的其實是參照而非內容,改動其中一個會同時影響另一個。物件部分可以用遞迴複製解決,函式則幾乎無解。列出來只是為了完整性。
模組拆成多檔有個重大限制:每個檔案各自維護私有變數,彼此無法存取。解法是刻意把私有狀態掛在模組上,並提供封裝/解封的開關:
var MODULE = (function (my) {
var _private = my._private = my._private || {},
_seal = my._seal = my._seal || function () {
delete my._private;
delete my._seal;
delete my._unseal;
},
_unseal = my._unseal = my._unseal || function () {
my._private = _private;
my._seal = _seal;
my._unseal = _unseal;
};
// 這個檔案內部可以永久存取 _private、_seal、_unseal
return my;
}(MODULE || {}));
所有檔案都能在自己的 _private 上設定屬性,也都能讀到其他檔案設定的內容。模組全部載入後,應用程式呼叫 MODULE._seal() 就把入口收起來,外部再也碰不到內部狀態;若之後還要繼續放大,任何內部方法都可以先 _unseal()、載完新檔再 _seal()。這是相當實用但少見的寫法。
MODULE.sub = (function () {
var my = {};
// ...
return my;
}());
寫法最簡單,但別小看它——子模組同樣享有放大模式與私有狀態的所有好處,很適合把龐大模組做職責切分。
多數進階模式可以組合使用。若真要推薦一套處理複雜應用程式的組合,我會選:寬放大模式 + 私有變數 + 子模組。
效能方面我沒有做過量化測試,但可以用一個更直覺的判準來思考:好的模組模式應該能被壓縮得很乾淨,讓腳本下載更快。寬放大模式允許非阻塞並行下載,這本身就加快了載入;初始化時間可能略慢,但整體權衡下來值得。只要全域變數導入得準確,執行期效能不會受影響,甚至還能靠子模組中的私有變數縮短參照鏈而跑得更快。
最後是一個子模組動態掛載到父模組的範例(父模組不存在就順手建起來):
var UTIL = (function (parent, $) {
var my = parent.ajax = parent.ajax || {};
my.get = function (url, params, callback) {
return $.getJSON(url, params, callback);
};
// 其他方法...
return parent;
}(UTIL || {}, jQuery));
這種寫法讓一整個複雜的層級結構可以透過子模組並行載入完成。它不是初階教學,但只要懂 JavaScript 基本語法就能讀懂,值得放進你的專案骨架裡。