事件綁定有三種基本寫法:傳統的事件屬性、W3C 的 addEventListener、IE 的 attachEvent。但真正實務上需要的,是一個跨瀏覽器且行為可預期的通用方法。網路上流傳的版本很多,以下三個最具代表性。
評估之前,先把標準列出來:
a. 同一元素的同一事件可以綁定多個監聽函式;
b. 同一函式重複註冊時,第一次之後的註冊應被忽略;
c. 函式體內的 this 應指向正在處理事件的節點;
d. 監聽函式應依綁定順序執行;
e. 函式體內不需要再寫 event = event || window.event 來正規化事件物件。
function addEvent(obj, type, fn) {
if (obj.attachEvent) {
obj['e' + type + fn] = fn;
obj[type + fn] = function(){ obj['e' + type + fn](window.event); }
obj.attachEvent('on' + type, obj[type + fn]);
} else {
obj.addEventListener(type, fn, false);
}
}
function removeEvent(obj, type, fn) {
if (obj.detachEvent) {
obj.detachEvent('on' + type, obj[type + fn]);
obj[type + fn] = null;
} else {
obj.removeEventListener(type, fn, false);
}
}
簡短到令人驚訝。它的做法是替 IE 補上一層包裝,把 window.event 主動餵進去,藉此同時滿足 a、c、e 三點。但 b 沒有解決——addEventListener 會忽略重複註冊,attachEvent 不會。至於 d,DOM 標準本來就沒有規範同一元素多個處理函式的呼叫順序,所以不該預設它們會照註冊順序執行。即使如此,這仍是一個非常優秀的實作。
function addEvent(element, type, handler) {
if (!handler.$$guid) handler.$$guid = addEvent.guid++;
if (!element.events) element.events = {};
var handlers = element.events[type];
if (!handlers) {
handlers = element.events[type] = {};
if (element["on" + type]) {
handlers[0] = element["on" + type];
}
}
handlers[handler.$$guid] = handler;
element["on" + type] = handleEvent;
}
addEvent.guid = 1;
function removeEvent(element, type, handler) {
if (element.events && element.events[type]) {
delete element.events[type][handler.$$guid];
}
}
function handleEvent(event) {
var returnValue = true;
event = event || fixEvent(window.event);
var handlers = this.events[event.type];
for (var i in handlers) {
this.$$handleEvent = handlers[i];
if (this.$$handleEvent(event) === false) {
returnValue = false;
}
}
return returnValue;
}
function fixEvent(event) {
event.preventDefault = fixEvent.preventDefault;
event.stopPropagation = fixEvent.stopPropagation;
return event;
}
fixEvent.preventDefault = function() { this.returnValue = false; };
fixEvent.stopPropagation = function() { this.cancelBubble = true; };
它改用傳統的事件屬性綁定,因此能在所有瀏覽器運作,也不會造成記憶體洩漏,並用 guid 表去重,把 b 也補上了。遺憾的是 d 仍無法保證:for/in 的遍歷順序在 JavaScript 中並未規定,多數實作雖會照賦值順序,但不同版本或引擎之間仍可能不一致。
把保存結構從物件換成陣列,就能用索引明確控制順序,五點要求全部滿足:
Array.prototype.indexOf = function(obj){
var result = -1, length = this.length, i = length - 1;
for (; i >= 0; i--) {
if (this[i] == obj) { result = i; break; }
}
return result;
}
Array.prototype.contains = function(obj){
return (this.indexOf(obj) >= 0);
}
Array.prototype.append = function(obj, nodup){
if (!(nodup && this.contains(obj))) { this[this.length] = obj; }
}
Array.prototype.remove = function(obj){
var index = this.indexOf(obj);
if (!index) return;
return this.splice(index, 1);
};
function addEvent(element, type, fun){
if (!element.events) element.events = {};
var handlers = element.events[type];
if (!handlers) {
handlers = element.events[type] = [];
if (element['on' + type]) {
handlers[0] = element['on' + type];
}
}
handlers.append(fun, true); // true 表示去重
element['on' + type] = handleEvent;
}
function removeEvent(element, type, fun) {
if (element.events && element.events[type]) {
element.events[type].remove(fun);
}
}
function handleEvent(event) {
var returnValue = true, i = 0;
event = event || fixEvent(window.event);
var handlers = this.events[event.type], length = handlers.length;
for (; i < length; i++) {
if (handlers[i].call(this, event) === false) {
returnValue = false;
}
}
return returnValue;
}
function fixEvent(event) {
event.preventDefault = fixEvent.preventDefault;
event.stopPropagation = fixEvent.stopPropagation;
return event;
}
fixEvent.preventDefault = function() { this.returnValue = false; };
fixEvent.stopPropagation = function() { this.cancelBubble = true; };
關鍵差異有三處:append(fun, true) 負責去重、陣列的 for 迴圈保證順序、call(this, event) 確保 this 指向當前元素。這也提醒我們一件事——凡是依賴遍歷順序的邏輯,都不該建立在 for/in 之上。
當然,今天的專案大概都會直接用 addEventListener 或框架封裝,這三個版本的價值在於理解事件模型本身:為什麼需要 guid、為什麼 this 會指向不對、為什麼顺序無法保證。這些觀念在任何框架底下都通用。