使用 addEventListener() 或 attachEvent() 綁定事件時,常會遇到幾個惱人的問題。本文分享一套自製的跨瀏覽器事件綁定模組,用事件隊列機制優雅地解決這些痛點。
問題一:用 addEventListener() 或 attachEvent() 綁定的匿名函數無法移除。因為 removeEventListener 需要傳入與綁定時「完全相同」的函數參考,而匿名函數每次都不同,自然移除不掉。
問題二:在 IE6~8 中,用 attachEvent() 綁定多個同類事件時會「倒序執行」。例如依序綁定 alert(1)、alert(2)、alert(3),IE9+ 會照 1、2、3 觸發,但 IE6~8 卻是 3、2、1。
我的做法是:把「事件隊列」作為 DOM 元素的屬性掛上去,這樣既不污染全域環境,又能解決「不同元素、不同事件類型、多個處理函數」的資料儲存問題。觸發事件時只執行一次 handler,由 handler 去遍歷並依序執行隊列中的所有函數。
DOM 上的隊列結構大致如下:
dom {
eventQueue : {
'click' : { fnQueue1 : function, myfn : function, fnQueue3 : function },
'mouseover' : { fnQueue1 : function, fnQueue2 : function }
}
}
/* 綁定事件的介面
* @param {dom} {type} {fn} 可選參數 {fnName}
* 建立事件隊列並掛到 DOM 上,將處理函數加入隊列
* 可為處理函數加上標識符,方便日後刪除
*/
function bind(dom, type, fn, fnName) {
dom.eventQueue = dom.eventQueue || {};
dom.eventQueue[type] = dom.eventQueue[type] || {};
dom.handler = dom.handler || {};
if (!fnName) {
var index = queueLength(dom, type);
dom.eventQueue[type]['fnQueue' + index] = fn;
} else {
dom.eventQueue[type][fnName] = fn;
}
if (!dom.handler[type]) bindEvent(dom, type);
}
/* 只綁定一次事件,handler 負責遍歷執行隊列中的處理函數 */
function bindEvent(dom, type) {
dom.handler[type] = function() {
for (var guid in dom.eventQueue[type]) {
dom.eventQueue[type][guid].call(dom);
}
};
if (window.addEventListener) {
dom.addEventListener(type, dom.handler[type], false);
} else {
dom.attachEvent('on' + type, dom.handler[type]);
}
}
/* 移除事件的介面
* 無標識符則移除全部;有標識符則只刪該函數,隊列清空後再移除綁定 */
function unBind(dom, type, fnName) {
var hasQueue = dom.eventQueue && dom.eventQueue[type];
if (!hasQueue) return;
if (!fnName) {
unBindEvent(dom, type);
} else {
delete dom.eventQueue[type][fnName];
if (queueLength(dom, type) == 0) unBindEvent(dom, type);
}
}
/* 移除綁定的 handler 並清空隊列 */
function unBindEvent(dom, type) {
if (window.removeEventListener) {
dom.removeEventListener(type, dom.handler[type]);
} else {\br /> dom.detachEvent(type, dom.handler[type]);
}
delete dom.eventQueue[type];
}
/* 判斷事件隊列長度 */
function queueLength(dom, type) {
var index = 0;
for (var length in dom.eventQueue[type]) { index++; }
return index;
}
var oBtn = document.getElementById('btn');
// 綁定三個 click,IE6-8 下執行順序不變
bind(oBtn, 'click', function(){ alert(1); });
bind(oBtn, 'click', function(){ alert(2); }, 'myFn');
bind(oBtn, 'click', function(){ alert(3); });
// 移除所有 click(含匿名函數)
unBind(oBtn, 'click');
// 只移除標識符為 myFn 的函數
unBind(oBtn, 'click', 'myFn');
整體邏輯並不複雜,既能移除匿名函數、又統一了跨瀏覽器的執行順序,是理解事件管理機制相當實用的一課。