jQuery 的 $.Callbacks() 是一個功能強大的多用途回呼清單物件,ajax 與 Deferred 底層都靠它支撐。本文嘗試從零打造一個用法幾乎一致的版本,先實作 add、remove、fire、empty、has 以及帶參數的建構函式,再逐步補上 disable、disabled、fireWith、fired、lock、locked 等方法。
String.prototype.trim = function () {
return this.replace( /^\s+|\s+$/g, '' );
};
// 模擬 jQuery.Callbacks 物件
function MyCallbacks( options )
{
var ops = { once: false, memory: false, unique: false, stopOnFalse: false };
if ( typeof options === 'string' && options.trim() !== '' )
{
var opsArray = options.split( /\s+/ );
for ( var i = 0; i < options.length; i++ )
{
if ( opsArray[i] === 'once' ) ops.once = true;
else if ( opsArray[i] === 'memory' ) ops.memory = true;
else if ( opsArray[i] === 'unique' ) ops.unique = true;
else if ( opsArray[i] === 'stopOnFalse' ) ops.stopOnFalse = true;
}
}
var ar = [];
var lastArgs = null;
var firedTimes = 0;
// ……後續 add / remove / empty / has / fire 等方法實作
};
其中四個旗標的意義如下:
once:回呼清單只能觸發一次(類似 Deferred)。
memory:會記住先前傳入的值,之後新增的回呼會立刻用最近一次的值被呼叫。
unique:確保同一個回呼只能加入一次,避免重複。
stopOnFalse:當某個回呼回傳 false 時,中斷後續呼叫。
測試用的三個函數(fn1、fn2 為匿名函數且 fn2 回傳 false,fn3 為具名函數):
var fn1 = function ( v ) { console.log( 'fn1 ' + ( v || '' ) ); };
var fn2 = function ( v ) { console.log( 'fn2 ' + ( v || '' ) ); return false; };
function fn3( v ) { console.log( 'fn3 ' + ( v || '' ) ); };
add 與 fire 的測試,會依序輸出 fn1、fn2、fn3;once 模式下第二次 fire 則不再有任何輸出;memory 模式下後加入的 fn2 會被立即呼叫;stopOnFalse 模式下,fn2 回傳 false 後 fn3 便不會執行;unique 模式下重複加入的 fn3 只會被觸發一次。四個旗標也可以任意組合使用。
構造函式:jQuery.Callbacks( flags ),flags 是一組以空白分隔的旗標字串,用來改變回呼清單的行為。最常搭配使用的是 .add() 與 .fire():前者負責加入新的回呼,後者負責執行清單中的函數並傳入參數。
利用 Callbacks 可以輕鬆實作發布訂閱模式:
var topics = {};
jQuery.Topic = function ( id )
{
var callbacks, method, topic = id && topics[id];
if ( !topic )
{
callbacks = jQuery.Callbacks();
topic = {
publish: callbacks.fire,
subscribe: callbacks.add,
unsubscribe: callbacks.remove
};
if ( id ) topics[id] = topic;
}
return topic;
};
最後,把 disable、disabled、fired、fireWith、lock、locked 等方法全部補齊後,將實作包進匿名函數,並透過 window.callbacks 這個工廠方法回傳實例,就不必每次使用都 new 一次,整體結構也更貼近 jQuery 官方版本。