寫元件時,你一定遇過這種場景:需要對外開放一組事件,讓使用者在初始化前、渲染後插入自己的邏輯。多數教學會叫你用「發布—訂閱」模式解決,於是每個元件都長出一套 on、off、trigger 的自製實作。本文想談的是另一條路:把事件管理整個委託給 jQuery,讓普通物件享有和 DOM 元素完全相同的事件語義——包含冒泡、命名空間、事件物件與 preventDefault()。
結論先講:只要 $({}) 傳入一個空物件,jQuery 就會回傳一個完整支援事件管理的 jQuery 物件。看起來平淡無奇,但把這招用在元件設計上,靈活度與可擴充性都會明顯提升。
早期我完全信奉「自定義事件就該用發布—訂閱」,於是拿 $.Callbacks 寫了一個事件基類:
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('./class'); function isFunc(f) { return Object.prototype.toString.apply(f) === '[object Function]'; } /** * 這個基類可以讓普通的類具備事件驅動的能力 * 提供類似jq的on off trigger方法,不考慮one方法,也不考慮命名空間 * 舉例: * var e = new EventBase(); * e.on('load', function(){ * console.log('loaded'); * }); * e.trigger('load');//loaded * e.off('load'); */ var EventBase = Class({ instanceMembers: { init: function () { this.events = {}; //把$.Callbacks的flag設置成一個實例屬性,以便子類可以覆蓋 this.CALLBACKS_FLAG = 'unique'; }, on: function (type, callback) { type = $.trim(type); //如果type或者callback參數無效則不處理 if (!(type && isFunc(callback))) return; var event = this.events[type]; if (!event) { //定義一個新的jq隊列,且該隊列不能添加重復的回調 event = this.events[type] = $.Callbacks(this.CALLBACKS_FLAG); } //把callback添加到這個隊列中,這個隊列可以通過type來訪問 event.add(callback); }, off: function (type, callback) { type = $.trim(type); if (!type) return; var event = this.events[type]; if (!event) return; if (isFunc(callback)) { //如果同時傳遞type跟callback,則將callback從type對應的隊列中移除 event.remove(callback); } else { //否則就移除整個type對應的隊列 delete this.events[type]; } }, trigger: function () { var args = [].slice.apply(arguments), type = args[0];//第一個參數轉為type type = $.trim(type); if (!type) return; var event = this.events[type]; if (!event) return; //用剩下的參數來觸發type對應的回調 //同時把回調的上下文設置成當前實例 event.fireWith(this, args.slice(1)); } } }); return EventBase; });(搭配 seajs 與 class.js 這套繼承庫使用)
任何元件只要繼承 EventBase,就免費獲得訂閱、發布、取消訂閱的能力。以我想做的 FileUploadBaseView 為例:
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('./class'); var EventBase = require('./eventBase'); var DEFAULTS = { data: [], //要展示的數據列表,列表元素必須是object類型的,如[{url: 'xxx.png'},{url: 'yyyy.png'}] sizeLimit: 0, //用來限制BaseView中的展示的元素個數,為0表示不限制 readonly: false, //用來控制BaseView中的元素是否允許增加和刪除 onBeforeRender: $.noop, //對應beforeRender事件,在render方法調用前觸發 onRender: $.noop, //對應render事件,在render方法調用後觸發 onBeforeAppend: $.noop, //對應beforeAppend事件,在append方法調用前觸發 onAppend: $.noop, //對應append事件,在append方法調用後觸發 onBeforeRemove: $.noop, //對應beforeRemove事件,在remove方法調用前觸發 onRemove: $.noop //對應remove事件,在remove方法調用後觸發 }; /** * 數據解析,給每個元素的添加一個唯一標識_uuid,方便查找 */ function resolveData(ctx, data){ var time = new Date().getTime(); return $.map(data, function(d){ d._uuid = '_uuid' + time + Math.floor(Math.random() * 100000); }); } var FileUploadBaseView = Class({ instanceMembers: { init: function (options) { this.base(); this.options = this.getOptions(options); }, getOptions: function(options) { return $.extend({}, DEFAULTS, options); }, render: function(){ }, append: function(data){ }, remove: function(prop){ } }, extend: EventBase }); return FileUploadBaseView; });實測如下:


過程中實例化了一個 f,透過 on 掛上 hello 的監聽器,再用 trigger('hello', ...) 觸發並帶入兩個額外參數。監聽器內部既能用參數取值,也能用 this 指回 f 本身。看起來很美好,直到我繼續往下實作。
我在設計元件時開了一組成對的訂閱選項:

規則是這樣的:帶 before 的訂閱在對應實例方法(如 render)執行前觸發,不帶的則在執行後觸發;而且 before 若回傳 false,就應該中止後續的方法呼叫與事件。這個需求很實際——例如 remove 時某些資料不允許刪除,就可以在 beforeRemove 裡做校驗。

問題是:這套寫法只在「單一回呼函數」的模式下成立。發布—訂閱裡,同一個訊息可以有多個訂閱者,當你呼叫 this.trigger('beforeRender'),所有掛在 beforeRender 上的回調都會被執行一遍——那到底該採信誰的返回值?
你可能會說:取最後一個訂閱的返回值不就好了?多數情況確實沒問題。但一旦把「以最後一個訂閱的返回值為準」寫進 EventBase,就等於對使用者加上一條隱性契約:你必須確保校驗類的訂閱永遠排在隊伍尾端。這種跟語法、編譯無關,純靠人肉遵守順序的約定,是軟體裡很典型的隱患。誰能保證任何場景下順序都不會被打亂?更何況團隊裡隨時可能來一個不知道有這規矩的新人。
真正漂亮的解法,其實 DOM 早就給過我們了:發布時不要只丟一個字串,而是把訊息封裝成一個事件物件傳給所有訂閱者;誰認為該中止後續邏輯,就在自己身上呼叫 preventDefault(),發布方在 trigger 之後用 isDefaultPrevented() 判斷即可:

Bootstrap 的元件就是這個思路,例如 alert 在執行 close 時的那段判斷:

照這個方向改造 EventBase 可行,但 jQuery 還藏著一個更省事的小技巧。
如果元件本身就跟某個 DOM 元素綁定,例如:

那麼直接幫元件補上 on、off、one、trigger,並把呼叫轉發給 $element:

呼叫元件的 on,實際跑的是 $element.on,事件管理立刻完整。
那如果元件跟 DOM 毫無關係呢?這招我以前真的沒想過:

如圖框起來的那段——把空物件交給 jQuery 建構函數,它就回傳一個完整支援事件管理的 jQuery 物件。而且因為它本身就是 jQuery 物件,將來想借用 jQuery 上任何與 DOM 無關的工具方法,也能沿用同一套路。
把兩個技巧合起來,就同時覆蓋了「有 DOM」與「無 DOM」兩類元件:
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('./class'); /** * 這個基類可以讓普通的類具備jquery對象的事件管理能力 */ var EventBase = Class({ instanceMembers: { init: function (_jqObject) { this._jqObject = _jqObject && _jqObject instanceof $ && _jqObject || $({}); }, on: function(){ return $.fn.on.apply(this._jqObject, arguments); }, one: function(){ return $.fn.one.apply(this._jqObject, arguments); }, off: function(){ return $.fn.off.apply(this._jqObject, arguments); }, trigger: function(){ return $.fn.trigger.apply(this._jqObject, arguments); } } }); return EventBase; });define(function(require, exports, module) { var $ = require('jquery'); var Class = require('mod/class'); var EventBase = require('mod/eventBase'); var Demo = window.demo = Class({ instanceMembers: { init: function (element,options) { this.$element = $(element); this.base(this.$element); //添加監聽 this.on('beforeRender', $.proxy(options.onBeforeRender, this)); this.on('render', $.proxy(options.onRender, this)); }, render: function () { //觸發beforeRender事件 var e = $.Event('beforeRender'); this.trigger(e); if(e.isDefaultPrevented())return; //主要邏輯代碼 console.log('render complete!'); //觸發render事件 this.trigger('render'); } }, extend: EventBase }); var demo = new Demo('#demo', { onBeforeRender: function(e) { console.log('beforeRender event triggered!'); }, onRender: function(e) { console.log('render event triggered!'); } }); demo.render(); });這裡的 Demo 繼承 EventBase,為 beforeRender 與 render 各掛一個監聽,render 內有印 statement 模擬真實業務。結果:

與預期一致。
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('mod/class'); var EventBase = require('mod/eventBase'); var Demo = window.demo = Class({ instanceMembers: { init: function (element,options) { this.$element = $(element); this.base(this.$element); //添加監聽 this.on('beforeRender', $.proxy(options.onBeforeRender, this)); this.on('render', $.proxy(options.onRender, this)); }, render: function () { //觸發beforeRender事件 var e = $.Event('beforeRender'); this.trigger(e); if(e.isDefaultPrevented())return; //主要邏輯代碼 console.log('render complete!'); //觸發render事件 this.trigger('render'); } }, extend: EventBase }); var demo = new Demo('#demo', { onBeforeRender: function(e) { console.log('beforeRender event triggered!'); }, onRender: function(e) { console.log('render event triggered!'); } }); demo.on('beforeRender', function(e) { e.preventDefault(); console.log('beforeRender event triggered 2!'); }); demo.on('beforeRender', function(e) { console.log('beforeRender event triggered 3!'); }); demo.render(); });結果:

render 的主體邏輯與後續 render 事件都沒執行,而三個 beforeRender 監聽全部跑完——關鍵就在這裡:那個呼叫 preventDefault() 的回調並不是最後一個,卻依然生效,而且沒有破壞事件隊列。順序依賴的問題被徹底消掉了。
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('mod/class'); var EventBase = require('mod/eventBase'); var Demo = window.demo = Class({ instanceMembers: { init: function (options) { this.base(); //添加監聽 this.on('beforeRender', $.proxy(options.onBeforeRender, this)); this.on('render', $.proxy(options.onRender, this)); }, render: function () { //觸發beforeRender事件 var e = $.Event('beforeRender'); this.trigger(e); if(e.isDefaultPrevented())return; //主要邏輯代碼 console.log('render complete!'); //觸發render事件 this.trigger('render'); } }, extend: EventBase }); var demo = new Demo({ onBeforeRender: function(e) { console.log('beforeRender event triggered!'); }, onRender: function(e) { console.log('render event triggered!'); } }); demo.render(); });
把 init 裡的 this.base() 換成無參數呼叫(走 $({}) 分支),再加上兩個额外的 beforeRender 監聽,其中一個呼叫 preventDefault():
define(function(require, exports, module) { var $ = require('jquery'); var Class = require('mod/class'); var EventBase = require('mod/eventBase'); var Demo = window.demo = Class({ instanceMembers: { init: function (options) { this.base(); //添加監聽 this.on('beforeRender', $.proxy(options.onBeforeRender, this)); this.on('render', $.proxy(options.onRender, this)); }, render: function () { //觸發beforeRender事件 var e = $.Event('beforeRender'); this.trigger(e); if(e.isDefaultPrevented())return; //主要邏輯代碼 console.log('render complete!'); //觸發render事件 this.trigger('render'); } }, extend: EventBase }); var demo = new Demo({ onBeforeRender: function(e) { console.log('beforeRender event triggered!'); }, onRender: function(e) { console.log('render event triggered!'); } }); demo.on('beforeRender', function(e) { e.preventDefault(); console.log('beforeRender event triggered 2!'); }); demo.on('beforeRender', function(e) { console.log('beforeRender event triggered 3!'); }); demo.render(); });
行為與 DOM 版完全一致。也就是說,改造後的 EventBase 讓任意物件都具備了 jQuery 等級的事件管理:命名空間、one、事件冒泡、事件物件與 preventDefault 全都可用,而且更穩定、更貼近你日常操作 DOM 的直覺。
兩點補充:
1)不用 jQuery 也行。依照第一部分末尾的思路自行改造發布—訂閱同樣做得到,只是用 jQuery 更簡潔。
2)最終方案本質上仍是發布—訂閱,只是把「事件物件的封裝、隊列管理、命名空間」這些瑣碎細節交給 jQuery 完成;代理模式負責把元件的呼叫轉接進去。
希望這個小技巧能幫你在下一個元件裡少寫幾百行事件程式碼。