代碼的本質是順序與有序,在 JavaScript 裡尤其如此——畢竟它是單線程引擎。我們寫的函數總是按某種次序執行,優秀的代碼會把功能切成獨立模塊,再在特定條件下按序觸發。既然如此,為什麼不寫一個統一管理的對象來負責這件事?這就是 jQuery 裡 Callbacks 的由來。
最直觀的場景是 window.onload。直接賦值只能掛一個函數,如果有多件事要在加載完成後做,就得這樣寫:
function a(elem) {
elem.innerHTML = '我是函數 a,我要改變 Element 的 HTML 結構';
};
function b(elem) {
elem.innerHTML = '我的函數 b,我要改變 Element 的 style';
}
window.onload = function () {
var elem = document.getElementById('test');
a(elem);
b(elem);
};
回調列表的初衷就是不要再把這些函數散落各處,而是集中管理、按序執行。而 Callbacks 的野心不止於此:在 jQuery 源碼中,它為 Deferred(異步隊列)提供基礎,同時服務於 Queue(同步隊列)。Deferred 用來抹平大量回調嵌套造成的「金字塔」,Queue 則驅動著 jQuery.animate 動畫引擎。
JavaScript 同一時間只有一處代碼在運行。即便是 Ajax、setTimeout 這類看似異步的操作,本質也只是被有序壓入一個隊列,瀏覽器從隊列裡逐個取出執行。Callbacks 正是順應了這個模型。
容器很簡單:一個數組,每個回調函數 push 進去,執行時循環遍歷。真正精妙的是它的三種執行模型:
once(單次執行):所有函數只執行一次,之後釋放。這能為使用方提供一個穩定可靠的保證——函數不會被重複觸發。
auto / memory(自動執行):第一次 fire 之後,每次新 add 進來的函數會被立即執行,並拿到最後一次的調用參數。這抹平了「後加入的函數依賴先前結果」的問題,不用再反覆手動觸發。
once & auto:兩者結合——新函數加入時立即執行,然後被釋放,後續不再重複,兼得穩定性與便利性。
· add(fn) 添加一個或多個回調函數;
· remove(fn) 移除指定函數;
· has(fn) 判斷是否包含某函數;
· empty() 清空列表;
· disable() 徹底廢棄對象;
· disabled() 查詢是否已廢棄;
· lock() 鎖定列表,防止內容變動;
· fire(data) 執行所有回調;
· fireWith(context, data) 執行並指定上下文;
· fired() 查詢是否已執行過。
(function (window, undefined) {
var Callbacks = function () {
var list = [], // 回調函數列表
fired; // 是否執行過
return {
add: function (fn) {
if (list) {
list.push(fn);
}
return this; // 支持鏈式調用
},
fireWith: function (context, data) {
if (list) {
fired = true;
for (var i = 0, len = list.length; i < len; i++) {
// 某個函數返回 false 時中斷後續執行
if (list[i].apply(context, data) === false) break;
}
}
return this;
},
fire: function () {
return this.fireWith(this, arguments);
},
empty: function () {
if (list) list = [];
return this;
},
disable: function () {
list = undefined; // 置空後 add 與 fire 都自然失效
return this;
},
disabled: function () {
return !list;
},
fired: function () {
return !!fired;
}
};
};
window.Callbacks = Callbacks;
}(window));
這裡有個值得學習的技巧:disable() 並沒有加什麼標志位,而是直接把 list 置為 undefined,後續所有方法裡的 if(list) 判斷自動生效,優雅且不易遺漏。
實現非常簡單,只需在 fireWith 結束後把 list 置空:
fireWith: function (context, data) {
if (list) {
fired = true;
for (var i = 0, len = list.length; i < len; i++) {
if (list[i].apply(context, data) === false) break;
}
}
if (once) list = undefined; // 執行完就釋放
return this;
}
auto 的直觀寫法是記住最後一次參數,add 時判斷是否已 fire 過再補執行:
add: function (fn) {
if (list) {
list.push(fn);
if (auto) this.fire(lastData); // 自動補執行
}
return this;
}
但這裡有個問題:自動執行時丟失了上下文(context)。jQuery 的解法堪稱巧妙——它不新增變量,而是讓 auto 這個參數本身兼任「模式標志」和「參數容器」:
(function (window, undefined) {
var Callbacks = function (auto) {
var list = [],
fired,
memory, // 既表示是否 auto,又保存最後一次參數
coreFire = function (data) {
if (list) {
memory = auto && data; // auto 模式下才記錄參數
fired = true;
for (var i = 0, len = list.length; i < len; i++) {
if (list[i].apply(data[0], data[1]) === false) break;
}
}
};
return {
add: function (fn) {
if (list) {
list.push(fn);
if (memory) coreFire(auto); // memory 有值才自動執行
}
return this;
},
fireWith: function (context, data) {
coreFire([context, data]); // 參數打包成數組
return this;
}
/* 部分代碼省略 */
};
};
window.Callbacks = Callbacks;
}(window));
兩個關鍵設計值得細看。第一,上下文修復。把 fireWith 中真正執行函數的邏輯抽成 coreFire,參數統一打包成 [context, data] 這樣的二元數組,於是上下文和參數一起被記憶,自動執行時不會丟失 this。第二,一石二鳥。因為 coreFire 裡寫的是 memory = auto && data,非 auto 模式下 memory 恆為 false,永不觸發自動執行;auto 模式下 memory 變成那個參數數組,天然為真。而且賦值發生在 coreFire 內部而非 add 裡,正好保證「必須先 fire 過一次才開啟自動執行」這條語義。jQuery 作者顯然也對這個寫法頗為得意,所以才把模型命名為 memory。
至於 once & auto 的組合,只需在 coreFire 中判斷:auto 模式下把 list 重置為新數組(保留可用性),否則置為 undefined(徹底釋放)。
Callbacks 的設計給人的啟發有三層:用數組這個最樸素的結構承接有序執行;用「置空代替標志位」的方式簡化狀態管理;用一個變量承擔雙重職責來消除冗餘狀態。這三者都是值得借鑒的工程手法。如果你想深入,建議直接對照 jQuery 源碼的 jQuery.Callbacks 部分閱讀,它在此基礎上還處理了棧(stack)與執行中增刪元素的邊界情況。