過去零零散散寫過一些關於 addEventListener 的東西,總覺得不成體系,有些地方也講得不够清楚,乾脆從頭到尾重新整理成一篇連載。
addEventListener 用於註冊事件處理器,IE 對應的是 attachEvent。之所以談前者而不談後者,一是 attachEvent 相對單純,二是 addEventListener 才是 DOM 標準裡的正統做法。
addEventListener 可以為文件節點、document、window 或 XMLHttpRequest 註冊事件處理器。以前我們習慣寫 <input type="button" onclick="...">,或者 document.getElementById("testButton").onclick = FuncName;在 DOM 的規範裡,則改用 addEventListener(IE 用 attachEvent)。
語法:
target.addEventListener(type, listener, useCapture);
target:文件節點、document、window 或 XMLHttpRequest。type:字串,事件名稱,不含「on」,例如 "click"、"mouseover"、"keydown"。listener:實作了 EventListener 介面的物件,或是一個 JavaScript 函式。useCapture:是否使用捕獲階段,讀完下面事件流那一節就明白了,一般用 false。示例:
function Go() {
// ...
}
document.getElementById("testButton").addEventListener("click", Go, false);
listener 也可以直接寫成匿名函式:
document.getElementById("testButton").addEventListener("click", function () { ... }, false);
談 addEventListener 就繞不開事件流。當一個事件發生時,會經歷三個階段:
捕獲階段:從根節點順向而下,逐層檢查是否有註冊了事件處理器。若有,且 useCapture 為 true,就呼叫它。(IE 沒有這個階段。)
目標階段:觸發目標物件本身註冊的事件處理器,也稱正常事件派發階段。
冒泡階段:從目標節點逆向回到根節點,逐層檢查是否有註冊了事件處理器。若有,且 useCapture 為 false,就呼叫它。
舉例,考慮這樣一組巢狀結構:
<div id="div1">
<div id="div2">
<div id="div3">
<div id="div4"></div>
</div>
</div>
</div>
在 div3 上點擊滑鼠時,事件流是這樣走的:
· 捕獲階段:先在 div1 檢查是否有 useCapture 為 true 的處理器,有的話執行;接著同樣處理 div2。
· 目標階段:來到 div3,發現它就是被點擊的節點,此時不論 useCapture 是 true 還是 false,都會執行。
· 冒泡階段:在 div2 檢查是否有 useCapture 為 false 的處理器,有的話執行;接著同樣處理 div1。
(嚴格說來 div1 之上還有 body 等節點,這裡暫不討論。)
用一組三層巢狀的元素來測試:
<div id="outDiv">
<div id="middleDiv">
<div id="inDiv">請在此點擊滑鼠。</div>
</div>
</div>
<div id="info"></div>
var outDiv = document.getElementById("outDiv");
var middleDiv = document.getElementById("middleDiv");
var inDiv = document.getElementById("inDiv");
var info = document.getElementById("info");
outDiv.addEventListener("click", function () { info.innerHTML += "outDiv" + "<br>"; }, false);
middleDiv.addEventListener("click", function () { info.innerHTML += "middleDiv" + "<br>"; }, false);
inDiv.addEventListener("click", function () { info.innerHTML += "inDiv" + "<br>"; }, false);
三個監聽器、每個的 useCapture 有 true/false 兩種取值,組合起來共 2×2×2 = 8 種情況。列舉幾種:
歸納出三條結論:
完整的測試頁面如下,可以自行改動 true/false 來驗證(不適用於 IE):
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312" />
<title>useCapture</title>
<style type="text/css">
#outDiv { padding:10px; border:1px solid red; }
#middleDiv { padding:10px; border:1px solid green; }
#inDiv { padding:10px; border:1px solid blue; }
</style>
</head>
<body>
<div id="outDiv">
<div id="middleDiv">
<div id="inDiv">請在此點擊滑鼠。</div>
</div>
</div>
<div id="info"></div>
<script type="text/javascript">
var outDiv = document.getElementById("outDiv");
var middleDiv = document.getElementById("middleDiv");
var inDiv = document.getElementById("inDiv");
var info = document.getElementById("info");
outDiv.addEventListener("click", function () { info.innerHTML += "outDiv" + "<br>"; }, false);
middleDiv.addEventListener("click", function () { info.innerHTML += "middleDiv" + "<br>"; }, false);
inDiv.addEventListener("click", function () { info.innerHTML += "inDiv" + "<br>"; }, false);
</script>
</body>
</html>
事件觸發時,會傳入一個 Event 物件給處理器:
document.getElementById("testText").addEventListener("keydown", function (event) {
alert(event.keyCode);
}, false);
DOM 的事件型別分為 UIEvent、UIEvent:KeyEvent、UIEvent:MouseEvent 等,不同型別各有專屬屬性與方法。不過實務上不太容易用錯——我們不會在滑鼠事件裡去取按鍵值(Ctrl、Alt、Shift 這類修飾鍵除外),所以不必深究。
常用屬性:
view(唯讀)發生事件的 Window 物件。
type(唯讀)事件型別字串,例如 click。
eventPhase(唯讀)事件流目前所處階段:1 捕獲、2 目標、3 冒泡。
target(唯讀)派發事件的目標物件,也就是滑鼠實際點在哪個元素上。
currentTarget(唯讀)目前正在執行監聽器的物件,即這個 addEventListener 綁在哪裡。
timeStamp(唯讀)事件發生的時間戳。
cancelable(唯讀)是否可取消預設行為;為 true 時 preventDefault() 才有效。
preventDefault() 阻止瀏覽器的預設行為。例如在輸入框中打字觸發 keydown,若在處理器裡呼叫它,字就不會被輸入。要注意的是此時不要彈出 alert,否則可能失效。IE 中對應的寫法是在處理器裡 return false。
bubbles(唯讀)事件是否開啟冒泡。
stopPropagation() 停止事件在事件流中繼續傳遞,但不影響目前這個節點上剩餘的處理器。IE 用 event.cancelBubble = true 達到類似效果。
cancelBubble、preventBubble()、preventCapture() 皆為舊式寫法,不建議使用,統一改用 stopPropagation()。
detail(唯讀)提供額外資訊;對 click、mousedown、mouseup 而言,它代表連續點擊的次數。
isChar(唯讀)按下的鍵是否為字元。Firefox 曾長期回傳 false,官方已承認是 bug。
altKey、ctrlKey、shiftKey、metaKey(皆唯讀)分別表示對應的修飾鍵是否被按下。
下面幾個屬性容易搞混,特別留意:
charCode(唯讀)字元(英數與符號)的 Unicode 值,只用於 keypress。
keyCode(唯讀)鍵盤按鍵值。用於 keypress 時回傳非字元鍵的值(Ctrl、Shift、Alt、Caps Lock 等除外);用於 keydown、keyup 時回傳任意鍵值。
button(唯讀)滑鼠按鍵值。用於 click 時,0 為左鍵;用於 mousedown、mouseup 時,0 左鍵、1 中鍵(滾輪)、2 右鍵。
which(唯讀)鍵盤或滑鼠按鍵值。keypress 時等同 charCode 加回退鍵、Enter;keydown/keyup 時回傳任意鍵值;click 時 1 為左鍵;mousedown/mouseup 時 1 左鍵、2 中鍵、3 右鍵——與 button 的編號略有差異。
整體來看,which 唯一不及 keyCode 的地方是 keypress 的非字元鍵較不完整;但實務上 keypress 很少用來判斷非字元鍵,所以通常用 which 就能通吃。
為什麼用 addEventListener?
事件派發過程中新增的監聽器
不會立刻觸發,可能要等下一輪事件流(例如冒泡階段)才有機會執行。
重複註冊相同的監聽器
三個參數完全相同、且第二個參數是具名函式時,多餘的會被自動丟棄,只保留一份;對應的 removeEventListener 也只需呼叫一次(其用法與 addEventListener 完全一致)。
document.getElementById("myBox").addEventListener("click", Go, false);
document.getElementById("myBox").addEventListener("click", Go, false);
document.getElementById("myBox").addEventListener("click", Go, false);
但若第二個參數是匿名函式:
document.getElementById("outDiv").addEventListener("click", function () {
document.getElementById("info").innerHTML += "1";
}, false);
document.getElementById("outDiv").addEventListener("click", function () {
document.getElementById("info").innerHTML += "1";
}, false);
則兩者都會生效,而且無法用 removeEventListener 移除——這正是匿名函式作為監聽器的最大陷阱。
關於 this
在事件處理器中,this 會變成觸發事件的那個元素。不過仍然建議用 event.target 或 event.currentTarget 來取得元素,語意更清楚。
早期的事件綁定
DOM0 時代我們寫 obj.onclick = FuncName,相容性極好、應用廣泛,只是能力不如 addEventListener。
記憶體問題
前面提到,使用匿名函式有時是不得已,但代價是記憶體。一旦事件綁定完成,該綁定位址所處作用域內的變數都會被保留,不會被垃圾回收機制清掉,量多時可能吃掉可觀的記憶體。由於 removeEventListener 無法移除匿名函式的處理器,往往只有等元件本身被移除後,這塊記憶體才有機會釋放。