在設計 JavaScript xxSDK 時,考慮到讓調用者能參與到工作流程中,一開始用了回調函數:
this.foo = function(args,callbackFn) { //do something //then if callbackFn is a function callbackFn(); };
或者在初始化時傳入 config:
function SDK(config) { var configs = { onInit: function() { }, onFoo: function () { }, // on.... }; //合並參數 configs = $.extend(configs, config); this.foo = function (args) { //do something configs.onFoo(); }; }
但問題來了:隨著方法越來越多,第一種方式顯得很繁瑣,每個方法參數後面都要跟一個或多個回調,代碼不夠乾淨,而且只有用戶主動調用時才會執行回調,對沒暴露給用戶的內部方法就無能為力。第二種方式裡,方法越多 config 就越長,構造代碼難看,而且一個方法只能觸發一個回調。最後我採用了下面的方式。
先定義一個事件管理器,核心思路是讓每一個事件類型對應一個回調列表,這樣外部就能對同一個事件關聯多次。取消某個關聯,就是在該事件類型的函數列表中移除某個回調;觸發,則是把列表中所有函數執行一遍,並帶上參數。
var eventManger = { handlers: {}, //類型,綁定事件 addHandler:function(type,handler) { if (typeof this.handlers[type] == "undefined") { this.handlers[type] = [];//每個事件都可以綁定多次 } this.handlers[type].push(handler); }, removeHandler:function(type, handler) { var events = this.handlers[type]; for (var i = 0, len = events.length; i < len; i++) { if (events[i] == handler) { events.splice(i, 1); break; } } }, trigger: function (type) { if (this.handlers[type] instanceof Array) { var handlers = this.handlers[type]; var args = Array.prototype.slice.call(arguments, 1); for (var i = 0, len = handlers.length; i < len; i++) { handlers[i].apply(null, args); } } } };
然後在 SDK 中對外公布綁定和移除的方法:
//給外部綁定事件 this.on = function(type, event) { eventManger.addHandler(type,event); }; //移除事件 this.off = function(type, event) { eventManger.removeHandler(type, event); };
在執行過程中分別觸發事件:
this.init = function() { //do init eventManger.trigger('init'); }; this.start = function() { //do start eventManger.trigger('start'); }; this.connect = function() { eventManger.trigger('connect'); }; this.messages = function() { var msgs = []; msgs.push("你好嗎"); msgs.push("我很好"); eventManger.trigger('messages',msgs); }; this.disconnect = function() { eventManger.trigger('disconnect'); };
這樣用戶使用起來就方便多了:
//綁定connect sdk.on('connect', function () { console.log('connect'); }); //綁定messages sdk.on('messages', function (data) { if (!data) return; if (data instanceof Array) { for (var i = 0; i < data.length; i++) { console.log(data[i]); } } else { console.log(data); } });
還可以先綁定、移除再綁定:
var oninit = function() { console.log('init...'); }; sdk.on('init', oninit); sdk.on('init', function () { console.log('other init'); }); sdk.off('init', oninit); sdk.init();
全部代碼:

function SDK() { var eventManger = { handlers: {}, //類型,綁定事件 addHandler:function(type,handler) { if (typeof this.handlers[type] == "undefined") { this.handlers[type] = [];//每個事件都可以綁定多次 } this.handlers[type].push(handler); }, removeHandler:function(type, handler) { var events = this.handlers[type]; for (var i = 0, len = events.length; i < len; i++) { if (events[i] == handler) { events.splice(i, 1); break; } } }, trigger: function (type) { if (this.handlers[type] instanceof Array) { var handlers = this.handlers[type]; var args = Array.prototype.slice.call(arguments, 1); for (var i = 0, len = handlers.length; i < len; i++) { handlers[i].apply(null, args); } } } }; //給外部綁定事件 this.on = function(type, event) { eventManger.addHandler(type,event); }; //移除事件 this.off = function(type, event) { eventManger.removeHandler(type, event); }; this.init = function() { //do init eventManger.trigger('init'); }; this.start = function() { //do start eventManger.trigger('start'); }; this.connect = function() { eventManger.trigger('connect'); }; this.messages = function() { var msgs = []; msgs.push("你好嗎"); msgs.push("我很好"); eventManger.trigger('messages',msgs); }; this.disconnect = function() { eventManger.trigger('disconnect'); }; this.autoRun = function() { this.init(); this.start(); this.connect(); this.messages(); this.disconnect(); }; } var sdk = new SDK(); var oninit = function() { console.log('init...'); }; sdk.on('init', oninit); sdk.on('start', function () { console.log('start'); }); sdk.on('connect', function () { console.log('connect'); }); sdk.on('messages', function (data) { if (!data) return; if (data instanceof Array) { for (var i = 0; i < data.length; i++) { console.log(data[i]); } } else { console.log(data); } }); sdk.on('disconnect', function () { console.log('disconnect'); }); sdk.autoRun(); sdk.on('init', function () { console.log('other init'); }); sdk.off('init', oninit); sdk.init();
執行結果:

小結:事件驅動的處理方式更加簡潔、更具擴展性。jQuery 的事件機制並沒有把監聽函數直接綁到 DOM 元素上,而是基於數據緩存模塊來管理,這裡也借鑑了這一思路——把同一事件類型 type 的所有監聽對象 handleObj 構成監聽數組 handles。由於不涉及 DOM 操作,實現相對簡單。