jQuery.Callbacks 是 jQuery 1.7 才加入的模組,程式碼是從 1.6 版的 _Deferred 中抽出來的。它的職責很單純:管理一個函式佇列,提供 add、remove、fire、lock 等操作,並透過四個選項控制行為。
Callbacks 幾乎不直接面向應用開發者,它是給其他模組用的。真正在檯面上發光的是 Deferred,而 Deferred 內部正是靠 Callbacks 在支撐。
once:回呼只會被執行一次,fire 過之後佇列即清空。
unique:同一個函式不能重複加入佇列。
memory:記憶狀態。若在 fire 之後才 add,新加入的函式會立刻被執行。
stopOnFalse:某個函式回傳 false 時,停止後續函式的執行。
使用方式是把選項字串傳進工廠函式:
var cb = Callback('memory once'); // 具備記憶功能、且只執行一次的回呼模組
因為要依不同選項回傳不同行為的實例,先用一個物件快取所有狀態:
var callbackState = {}
接著把 'memory once' 這種字串轉成可用來判斷的結構:
var createCallbackState = function (options) {
var states = options.split(' ');
var obj = {};
for (var i = 0; i < states.length; i++) {
obj[states[i]] = true;
}
return obj;
}
於是 'memory once' 就變成 {memory: true, once: true}。若快取中已有,直接回傳,否則先建立再回傳。
var Callback = function (options) {
var state = callbackState[options]
if (!state) {
callbackState[options] = state = createCallbackState(options);
}
var list = [], // 回呼函式佇列
memory, // 是否處於記憶狀態
has = function (fn) {
for (var i = 0; i < list.length; i++) {
if (list[i] === fn) { return true; }
}
return false;
},
add = function () {
var i = 0, args = arguments, len = args.length;
for (; i < len; i++) {
if (state.unique && has(args[i])) {
continue;
}
list.push(args[i]);
}
},
fire = function (context, args) {
var i = 0, len = list.length, item;
for (; i < len; i++) {
item = list[i];
if (item.apply(context, args) === false && state.stopOnFalse) {
break;
}
}
};
return {
add: function () {
add.apply(null, arguments);
if (state.memory && memory) {
fire(memory[0], memory[1]);
list = [];
}
},
fire: function (context, args) {
if (state.memory && !list.length) {
memory = [context, args];
return;
}
fire(context, args);
if (state.once) {
this.clear();
}
},
has: function (fn) {
return has(fn);
},
clear: function () {
list = [];
}
};
}
回傳物件上的 add 與 fire 需要實作 once、memory 這些狀態邏輯,而內部那組同名的函式則是純粹的「塞進去」與「跑一遍」。把兩者分開,狀態判斷就不會污染核心邏輯。
add 支援傳入多個函式,所以用 add.apply(null, arguments) 轉發。轉發之後的關鍵判斷是:
// 若處於 memory 模式且已有記憶,立刻觸發
if (state.memory && memory) {
fire(memory[0], memory[1]);
list = [];
}
理解 Deferred 的話會比較容易懂:它是 Promise 模式,先訂閱成功或失敗的回呼,之後再由某個時刻觸發。這個模式借用的正是 memory 狀態下的 Callbacks。它的特殊之處在於——如果你先發布了成功,但當時佇列裡空空的,程式不會就這樣算了,而是把這次發布記住,等待回呼函式加入,一旦加入立刻執行。
var cb = Callback('memory'); // 具記憶功能的回呼模組
cb.fire(); // 先觸發,此時佇列是空的
cb.add(fn); // 加入回呼,會被立刻執行!
function fn () { console.log('fn'); }
若不在 memory 模式下,上面這段程式碼不會有任何畫面,必須再呼叫一次 fire 才會執行。
對應的 fire 邏輯是:
// memory 模式下且佇列為空,代表觸發早於添加,先把狀態存起來
if (state.memory && !list.length) {
memory = [context, args];
return;
}
把當時的上下文與參數組態存下,等到 add 時再原封不動地播放一次。
整個 Callbacks 的公開介面就是 add、fire、has、clear 四個方法,實作難度不高。真正需要想一下的只有 memory:它讓「事件先發生、訂閱後到場」這種順序顛倒的情況也能正確運作,而這正是 Deferred 得以成立的基礎。