用原生 JavaScript 做事件綁定,比 jQuery 那種一行搞定的體驗要瑣碎得多。本文把 addEventListener / removeEventListener 的各種用法整理成可直接參照的範例,順便記下幾個容易踩到的坑。
之前寫播放器時,加上 timeupdate 監聽之後想把它移除,結果怎麼都移除不掉。查了一輪才發現問題出在第三個參數上。
$('.video')[0].addEventListener('timeupdate', currentTimeHandler, true);
也就是說,綁定時傳了三個參數,移除時就得原封不動地傳三個。add 和 remove 的第三個參數在規格上都可以省略,但省略之後各自的預設值並不一樣——這正是「移除失敗」的根源。一般情況下 addEventListener 的 useCapture 預設是 false,而兩邊寫法不一致時,瀏覽器會認為你移除的是另一個監聽器。
var eventHandlesCounter = 1; // 統計已綁定的監聽數量,0 保留
function addEvent(obj, evt, fn) {
if (!fn.__EventID) { fn.__EventID = eventHandlesCounter++; }
if (!obj.__EventHandles) { obj.__EventHandles = []; }
if (!obj.__EventHandles[evt]) {
obj.__EventHandles[evt] = [];
if (obj["on" + evt] instanceof Function) {
obj.__EventHandles[evt][0] = obj["on" + evt];
obj["on" + evt] = handleEvents;
}
}
obj.__EventHandles[evt][fn.__EventID] = fn;
function handleEvents() {
var fns = obj.__EventHandles[evt];
for (var i = 0; i < fns.length; i++) {
fns[i].call(this);
}
}
}
function delEvent(obj, evt, fn) {
if (!obj.__EventHandles || !obj.__EventHandles[evt] || !fn.__EventID) {
return false;
}
if (obj.__EventHandles[evt][fn.__EventID] == fn) {
delete obj.__EventHandles[evt][fn.__EventID];
}
}
實務上一定會遇到舊版 IE,所以要做能力偵測:有 W3C 方法就優先用,沒有才退回自製的實作。
function addEvent(obj, evt, fn, useCapture) {
if (obj.addEventListener) { // 優先使用 W3C 註冊方式
obj.addEventListener(evt, fn, !!useCapture);
} else {
if (!fn.__EventID) { fn.__EventID = addEvent.__EventHandlesCounter++; }
if (!obj.__EventHandles) { obj.__EventHandles = []; }
if (!obj.__EventHandles[evt]) {
obj.__EventHandles[evt] = [];
if (obj["on" + evt]) {
(obj.__EventHandles[evt][0] = obj["on" + evt]).__EventID = 0;
}
obj["on" + evt] = addEvent.execEventHandles;
}
}
}
addEvent.__EventHandlesCounter = 1;
addEvent.execEventHandles = function (evt) {
if (!this.__EventHandles) { return true; }
evt = evt || window.event;
var fns = this.__EventHandles[evt.type];
for (var i = 0; i < fns.length; i++) {
if (fns[i] instanceof Function) {
fns[i].call(this);
}
}
};
function delEvent(obj, evt, fn, useCapture) {
if (obj.removeEventListener) { // 先嘗試 W3C 的移除方法
obj.removeEventListener(evt, fn, !!useCapture);
} else {
if (obj.__EventHandles) {
var fns = obj.__EventHandles[evt];
if (fns) { delete fns[fn.__EventID]; }
}
}
}
IE 與 W3C 的事件物件欄位名稱不同,實作時最好統一包一層。
function fixEvent(evt) {
if (!evt.target) {
evt.target = evt.srcElement;
evt.preventDefault = fixEvent.preventDefault;
evt.stopPropagation = fixEvent.stopPropagation;
if (evt.type == "mouseover") {
evt.relatedTarget = evt.fromElement;
} else if (evt.type == "mouseout") {
evt.relatedTarget = evt.toElement;
}
evt.charCode = (evt.type == "keypress") ? evt.keyCode : 0;
evt.eventPhase = 2;
evt.timeStamp = (new Date()).getTime();
}
return evt;
}
fixEvent.preventDefault = function () { this.returnValue = false; };
fixEvent.stopPropagation = function () { this.cancelBubble = true; };
fixEvent 不能單獨呼叫,它需要一個事件物件作為參數,而且只在事件真正發生時才有意義。實務上的做法是把它整合進 execEventHandles:
addEvent.execEventHandles = function (evt) { // 遍歷並執行所有處理函式
if (!this.__EventHandles) { return true; }
evt = fixEvent(evt || window.event); // 在此統一標準化
var fns = this.__EventHandles[evt.type];
for (var i = 0; i < fns.length; i++) {
if (fns[i] instanceof Function) {
fns[i].call(this, evt); // 作為第一個參數傳入
}
}
};
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>test6.html</title>
<script type="text/javascript">
function test(){
window.alert("您投了一次票");
document.getElementById("1").detachEvent("onclick", test);
}
</script>
</head>
<body>
<input type="button" value="投票" id="1" />
<script type="text/javascript">
document.getElementById("1").attachEvent("onclick", test);
</script>
</body>
</html>
attachEvent 負責動態綁定,detachEvent 負責取消。兩者搭配之後,這個事件只會觸發一次,第二次再按就沒有反應了。
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>test7.html</title>
<script type="text/javascript">
function test(event){
// 每按一個鍵就判斷是否為數字
if(event.keyCode < 48 || event.keyCode > 57){
window.alert("您輸入的不是一個數字");
return false;
}
}
</script>
</head>
<body>
<input type="text" onkeypress="return test(event);" />請輸入數字
</body>
</html>
這裡的 event 就是事件物件,可以從中取得大量鍵盤資訊,細節可查閱相關文件。