為 DOM 元素綁定事件監聽是再常見不過的工作,但這裡潛藏著不少坑。各家瀏覽器提供了多種註冊方式,真正可靠的其實只有幾種。本文逐一說明,供需要的朋友參考。
elem.onclick = function( event ){
alert(event.type + ' this.innerHTML');
};
特性:寫法簡單穩定,函數體內的 this 指向正在處理事件的節點。
限制:同一元素同一事件只能註冊一個函數,重複註冊會直接覆蓋;而且只能在冒泡階段觸發,無法參與捕獲階段。
var elem = document.getElementById('ID');
elem.addEventListener('click', function( event ){
alert(event.type + ' ' + this.innerHTML + ' 1');
}, false); //冒泡階段執行
elem.addEventListener('click', function( event ){
alert(event.type + ' ' + this.innerHTML + ' 2');
}, false);
特性:支援捕獲與冒泡兩個階段;同一元素的同一事件可註冊多個監聽器,且不互相覆蓋;監聽器內 this 指向當前元素。
限制:舊版 IE 不支援(IE9 起才有)。
var elem = document.getElementById('a');
elem.attachEvent('onclick', function(){
alert(window.event.srcElement.innerHTML + ' ' + this.innerHTML + ' 1');
});
elem.attachEvent('onclick', function(){
alert(window.event.srcElement.innerHTML + ' ' + this.innerHTML + ' 2');
});
特性:可為同一事件註冊多次。
限制:IE 的事件模型不支援捕獲階段;更麻煩的是 this 指向 window 而非當前元素,必須改用 window.event.srcElement 取得事件來源——但 srcElement 是「事件最初發生的節點」,在事件委派場景下與 currentTarget 的意義不同,IE 也沒有 currentTarget 的對等屬性。事件名稱還必須加上 on 前綴。
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;
};
這個寫法的巧思在於:它只利用 element["on" + type] 這一個傳統屬性掛上唯一的 handleEvent,再自行用 $$guid 維護一份函數清單,模擬出「可註冊多個監聽器」的能力。fixEvent 則替 IE 的事件物件補上 preventDefault 與 stopPropagation 兩個標準方法。
它的缺點是無障礙與記憶體管理上的隱憂:把 events 物件直接掛在 DOM 元素上,若元素被移除而參照未清,會造成記憶體洩漏。
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 );
}
}
這個版本更短,手法是把函數暫存在元素的自訂屬性上(屬性名由 type 與 fn 的字串拼湊而成),移除時再取回同一個參照。它比前一版簡潔,但屬性名可能碰撞,且一樣有把資料掛在 DOM 上的問題。
上述所有相容性程式碼都是為 IE8 及以下版本準備的。IE 已於 2022 年停止支援,新專案直接用標準 API 即可:
const btn = document.querySelector('#myBtn');
const onClick = (e) => console.log('clicked', e.currentTarget);
btn.addEventListener('click', onClick);
// 需要移除時傳入同一個函數參照
btn.removeEventListener('click', onClick);
三個實務重點:
removeEventListener 必須傳同一個函數參照。傳匿名函數或每次重新建立的函數都移除不掉,這是新手最常踩的坑,也是為什麼建議把 handler 命名後再傳入。
大量元素用事件委派。與其替一百個 li 各綁一次,不如把監聽器掛在父容器上,靠 e.target 判斷來源:
document.querySelector('ul').addEventListener('click', (e) => {
if (e.target.matches('li')) {
console.log('點了:', e.target.textContent);
}
});
這樣動態新增的 li 也自動生效,不必重新綁定。
第三個參數的 options 形式很有用。{ once: true } 讓監聽器觸發一次後自動移除;{ passive: true } 能讓瀏覽器不必等 handler 執行完就能捲動頁面,在 touchstart、wheel 這類事件上對效能有明顯幫助。
希望本文所述對你的 JavaScript 學習有所幫助。