DIV CSS 佈局教程網

最佳 addEvent 的誕生:一場關於記憶體洩漏的競賽
編輯:關於JavaScript     

問題從哪裡來

當我們在程式碼中建立交叉參照時,IE 會無法回收記憶體:

window.onload = function () {
var x = document.getElementsByTagName('H3');
for (var i=0;i<x.length;i++)
{
x[i].onclick = openClose;
x[i].relatedElement = x[i].nextSibling; // simplified situation
x[i].relatedElement.relatedElement = x[i];
}
}

而在函式中使用 Closures 時也一樣——偏偏閉包最常見的用途,正是給 DOM 物件註冊事件處理器。Novemberborn 提供了一些範例,可以讓你實際跑一跑、親自感受這個 bug。

一場慈善邀請賽

QuirkMode 在年初意識到這個問題隱患巨大,認為有必要呼籲開發者關注並避免,於是舉辦了一場慈善邀請賽,徵求各自的 addEvent/removeEvent 方案。十月下旬,他宣布了勝者:John Resig。

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 );
}

評審的理由是:這段程式碼最簡潔有效,在避免記憶體問題的同時,還巧妙地保證了 this 在 IE 的 attachEvent 中能正常工作。

缺點當然也有:不支援 Netscape 4 與 Mac 上的 Explorer 5(國外相當重視這種廣泛相容性);removeEvent 裡漏掉了 remove obj["e"+type+fn]。但整體來說,簡單取勝。

不服氣的評審席

結果一出,不少參賽者與評論者立刻挑出了幾處毛病:

addEvent 本身就用了閉包,所以並沒有從根本上解決 IE 的記憶體洩漏。

沒有解決同一類型事件被重複註冊、在 IE 中被重複執行的問題。

幾位高手於是提出改良版:

/*
Original idea by John Resig
Tweaked by Scott Andrew LePera, Dean Edwards and Peter-Paul Koch
Fixed for IE by Tino Zijdel (crisp)
Note that in IE this will cause memory leaks and still doesn't quite function the same
as in browsers that do support the W3C event model:
- event execution order is not the same (LIFO in IE against FIFO)
- functions attached to the same event on the same element multiple times
  will also get executed multiple times in IE
*/
function addEvent( obj, type, fn ) {
if (obj.addEventListener)
obj.addEventListener( type, fn, false );
else if (obj.attachEvent) {
obj["e"+type+fn] = fn;
obj.attachEvent( "on"+type, function() { obj["e"+type+fn](); } );
}
}
function removeEvent( obj, type, fn ) {
if (obj.removeEventListener)
obj.removeEventListener( type, fn, false );
else if (obj.detachEvent) {
obj.detachEvent( "on"+type, obj["e"+type+fn] );
obj["e"+type+fn] = null;
}
}

改良了幾處不足,但記憶體洩漏依然存在,部分瀏覽器仍然不支援,IE 重複註冊的問題也還在。註解裡那兩行尤其值得注意:在同一物件上註冊多個同類型事件時,IE 與其他瀏覽器的執行順序相反(IE 是 LIFO,標準是 FIFO),這是更隱蔽的隱患。

Dean Edwards 的方案

幾天後,一個被認為最嚴謹的方案出現了。它的思路與眾不同:

不做物件偵測;不呼叫 addEventListener/attachEvent;保持 this 執行於正確的上下文;正確傳遞 event 參數;完全跨瀏覽器(含 IE4 與 NS4);不存在記憶體洩漏。

// written by Dean Edwards, 2005
// https://dean.edwards.name/function
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;
};

// 用來產生唯一 ID 的計數器
addEvent.guid = 1;

function removeEvent(element, type, handler) {
// 從雜湊表移除處理函式
if (element.events && element.events[type]) {
delete element.events[type][handler.$$guid];
}
};

function handleEvent(event) {
// 取得 event 物件(IE 使用全域 event)
event = event || window.event;
// 取得該元素對應事件類型的處理函式表
// 這裡的 this 會隨 handleEvent 被觸發的來源元素而變化
var handlers = this.events[event.type];
// 逐一執行事件處理函式
for (var i in handlers) {
// 這樣寫才能保證註冊的處理函式中 this 得到正確的參照,
// 直接 handlers[i]() 是不行的
this.$$handleEvent = handlers[i];
this.$$handleEvent(event);
}
};

這段程式碼比之前長了不少,但確實精妙:用 on<type> 當唯一入口,把處理函式全部收進元素自己的雜湊表,既不必呼叫原生註冊方法,也天然避免了重複註冊。

不過它引入了別的問題,例如無法處理事件處理函式的回傳值,for...in 迴圈也可能因為 Object.prototype 被錯誤擴充而中斷等等。很快 Dean 又推出一個「updated version」。

後記

目前來看,Dean 的最終版本是最全面的解法。個人其實覺得有些吹毛求疵——盡量使用瀏覽器本身的實作、保持簡單,一向是我堅持的主張。但洋人這種嚴謹態度,還是讓我深深敬佩。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved