模組化是很常見的 JavaScript 編程模式,能讓程式碼更易於理解。不過其中有不少相當實用的技巧,至今仍未被廣泛採用。
自從三年前 YUI 開發者 Eric Miraglia 第一次寫文章描述模組模式以來,這個領域已經累積了不少玩法。如果你對基礎已經很熟,可以直接跳到「進階模式」。
這是一切可能的起點,也是 JavaScript 最棒的特性之一。我們建立一個匿名函數並立刻執行它,所有程式碼都跑在這個函數內部,生存在一個私有化的閉包裡,足以讓其中的變數貫穿整個應用的生命週期。
(function () {
// ... all vars and functions are in this scope only
// still maintains access to all globals
}());
最外層那對括號不是裝飾,而是必須的。JavaScript 的語法規則是:以 function 關鍵字開頭的敘述一律被視為函數宣告;用括號包起來,直譯器才會把它當成函數運算式。
JavaScript 有所謂的隱式全域變數:直譯器遇到一個變數時,會沿著作用域鏈往外找它的 var 宣告;找不到就視為全域變數。若這時它正出現在賦值敘述左側且不存在,就會被憑空創造出來。這代表在匿名閉包裡使用或建立全域變數非常容易——也非常危險,因為光看程式碼根本分不清哪些是全域的。
匿名函數剛好提供了簡潔的解法:把全域變數當參數傳進來。
(function ($, YAHOO) {
// now have access to globals jQuery (as $) and YAHOO in this code
}(jQuery, YAHOO));
這樣既比隱式全域清晰,也因為是區域變數而查找更快。
如果目的不只是使用全域變數,而是宣告並對外提供,那就靠匿名函數的返回值來導出。這就構成了模組模式的雛形:
var MODULE = (function () {
var my = {},
privateVariable = 1;
function privateMethod() {
// ...
}
my.moduleProperty = 1;
my.moduleMethod = function () {
// ...
};
return my;
}());
MODULE 是一個全域模組,對外公開 moduleMethod 與 moduleProperty 兩個成員;同時透過閉包維護私有狀態,privateVariable 與 privateMethod 都無法從外部觸及。
具備以上基礎就足以應付不少情況,但我們可以把它再往前推,做出更強大、可擴展的結構。以下都從 MODULE 出發。
「整個模組必須寫在一個檔案裡」是基本模式的限制。參與過大型專案的人都懂拆分檔案的價值。放大模式的做法是:先導入既有模組,為它添加屬性,再導出。
var MODULE = (function (my) {
my.anotherMethod = function () {
// added method...
};
return my;
}(MODULE));
這裡用 var 只是為了風格一致,實際上並非必要。執行完之後,MODULE 就多了 anotherMethod 這個公開方法,而這個檔案也能維護自己的私有狀態。
上面的例子要求初始化模組必須先執行完,放大模組才能動手。但提升效能最有效的手法之一,正是讓 JavaScript 非同步載入。寬放大模式讓多個模組片段可以按任意順序載入:
var MODULE = (function (my) {
// add capabilities...
return my;
}(MODULE || {}));
MODULE || {} 是關鍵:若模組尚未初始化,這行會順手把它建起來。因此你可以用 LABjs 這類工具並行載入所有模組檔而不互相阻塞。
寬放大很好用,但伴隨兩個限制:你無法安全地覆寫模組既有屬性,也無法在初始化階段使用其他檔案提供的屬性(執行期則可以)。緊放大模式導入固定的載入順序,並允許覆寫:
var MODULE = (function (my) {
var old_moduleMethod = my.moduleMethod;
my.moduleMethod = function () {
// method override, has access to old through old_moduleMethod...
};
return my;
}(MODULE));
這裡覆寫了 moduleMethod,但保留了對原實作的引用,需要時仍能呼叫舊行為。
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 () {
// override method on the clone, access to super through super_moduleMethod
};
return my;
}(MODULE));
這可能是彈性最差的一種選擇。程式碼看起來整齊,代價是靈活性。如你所見,若某個屬性是物件或函數,它不會被複製,而是變成同一份東西的第二個引用——改動其中一個,另一個也跟著變。物件可以靠遞迴克隆解決,函數就難辦了(也許 eval 有辦法)。我把它寫進來,純粹是為了完整性。
模組拆成多檔有個重大限制:每個檔案各自維護私有變數,彼此無法存取。這問題有解。以下是一個支援跨檔案私有狀態的寬放大模組:
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;
};
// permanent access to _private, _seal, and _unseal
return my;
}(MODULE || {}));
所有檔案都能在各自的 _private 上掛屬性,也能讀到別人掛的。模組全部載入後,應用程式呼叫 MODULE._seal() 就能把 _private 從公開介面上抹掉,防止外部存取。若之後還要再放大,任何內部方法都可以在載入新檔案前呼叫 _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) {
// ok, so I'm cheating a bit :)
return $.getJSON(url, params, callback);
};
// etc...
return parent;
}(UTIL || {}, jQuery));
本文整理了當前 JavaScript 模組化編程的最佳實踐,以及如何將它們付諸實用。這不是入門教學,但只要懂基本的 JavaScript 語法,讀起來不會有障礙。