學習 jQuery 時我忽略了 unbind() 的存在,也不知道綁定事件會累加,結果在專案上栽了跟頭。記錄下來給自己一個警惕。
專案裡有一個評價頁面,版面是左右兩個表格:左邊用 AJAX 動態載入學生姓名與學號,右邊載入不同科目對該生的評價內容。兩邊表格的每一列都放了 checkbox,並對 table tbody tr 綁定 click 事件來做「點整列即可勾選」的功能。
一開始寫的是靜態 HTML,行選功能完全正常。換成 JSP、資料改由 AJAX 動態載入之後就出問題了:每次刷新頁面,只有後載入的那個表格可以行選,先載入的那個失效。
在 click 處理器裡放 console.log(chkBoxStatus) 測試,發現先載入的表格每次點擊會印出兩次(false 然後 true),後載入的只印一次。
// 行選功能
$("table tbody tr").click(function (event) {
var $check = $(this).find("input[type=checkbox]");
// 排除直接點在 checkbox 上的情況
if ($check.length > 0 && event.target != $check[0]) {
var chkBoxStatus = $check.is("input:checked");
console.log(chkBoxStatus);
$check.prop("checked", !chkBoxStatus);
}
});
我以為是 jQuery 語法寫錯,反覆檢查 HTML 的 id 與 class,都沒問題,於是一直糾結控制台為什麼會印兩次。後來室友提醒:試著在綁定前先清除事件。照做之後:
$("table tbody tr").unbind("click");
$("table tbody tr").click(function (event) { /* ... */ });
竟然成功了!兩邊表格都能正常行選。但當時我並不真正理解為什麼。
事後想通了:click 事件被綁了兩次。
第一次 AJAX 回來載入左表後,程式碼執行到 $("table tbody tr").click(...),當時 DOM 裡只有左表,於是左表的每一列被綁上一次。
第二次 AJAX 回來載入右表,同一行程式碼又執行了一次。此時 DOM 裡有兩個表格,所以 $("table tbody tr") 選到了「左表 + 右表」全部,左表的列因此再被綁一次,右表的列則是第一次被綁。
結果就是:點左表的列,兩個處理器依序執行,第一個把 checked 從 false 改 true,第二個再從 true 改回 false——看起來就像沒反應,控制台則印了兩次。右表只綁一次,所以正常。
解法一:綁定前先解除(最直覺,但較粗魯)
$("table tbody tr").unbind("click");
$("table tbody tr").click(handler);
能解決問題,但 unbind("click") 會把該元素上所有人綁的 click 都清掉,包含其他外掛或同事寫的程式碼。多人協作時這是很危險的操作。
解法二:改用事件委托(推薦)
把監聽器掛在靜態的父層上,只綁一次,之後不論動態加入多少列都自動生效:
// 只執行一次,放在 ready 裡最外層
$("table").on("click", "tbody tr", function (event) {
var $check = $(this).find("input[type=checkbox]");
if ($check.length > 0 && event.target !== $check[0]) {
$check.prop("checked", !$check.prop("checked"));
}
});
這樣就從根本上消滅了「重複綁定」的可能,不必再靠 unbind 補救。
解法三:用命名空間保護(若必須用 unbind)
$("table tbody tr").off("click.rowselect");
$("table tbody tr").on("click.rowselect", handler);
只移除自己掛的那一份,不影響其他人。
問題很小,但收穫不小。這個 bug 的表現(點了沒反應、控制台印兩次)與根本原因(事件被綁兩次)之間隔了好幾層推理,若沒有那個 console.log 大概很難定位。
三點值得記住的結論:動態內容一律用事件委托,不要對可能變動的集合反覆 .click();要解除綁定就用命名空間,別用裸的 unbind("click");控制台重複輸出往往就是重複綁定的訊號,見到就該往這個方向查。自己還需要不斷努力,這篇只是給自己的一個備忘。