DIV CSS 佈局教程網

從自訂事件看 JavaScript 框架的脆弱回呼機制
編輯:關於JavaScript     

Dean Edwards 前陣子寫了一篇很有意思的文章,這裡做個整理與說明。

多數 JavaScript 框架都提供了自訂事件(custom events),jQuery、YUI、Dojo 都支援類似 “document ready” 的機制,而這類自訂事件背後往往就是一套回呼(callback)系統:把多個事件處理器放進陣列,條件成立時再逐一取出執行。問題是,這種做法其實很脆弱。

先看原生事件的行為。以下兩個處理器先後綁定到 DOMContentLoaded:

document.addEventListener("DOMContentLoaded", function() { console.log("Init: 1"); DOES_NOT_EXIST++; // 這裡會拋出異常 }, false);
document.addEventListener("DOMContentLoaded", function() { console.log("Init: 2"); }, false);

執行結果大致如下:

Init: 1
Error: DOES_NOT_EXIST is not defined
Init: 2

可以注意到,即使第一段函式丟出了異常,第二段仍然照樣執行——因為瀏覽器為每個事件監聽器提供了獨立的執行環境。

問題所在

接著看看常見框架的回呼系統。以最流行的 jQuery 為例:

$(document).ready(function() { console.log("Init: 1"); DOES_NOT_EXIST++; // 這裡會拋出異常 });
$(document).ready(function() { console.log("Init: 2"); });

主控台只會看到:

Init: 1
Error: DOES_NOT_EXIST is not defined

差別就很明顯了。回呼系統相當脆弱——中間只要有一段程式丟出異常,後面全部不會執行。實務上這可能很麻煩,某個品質不佳的外掛就足以拖垮整頁的初始化流程。

Dojo 的情況與 jQuery 類似;YUI 略有不同,它在回呼系統裡包了 try/catch,避免因異常而中斷,但代價是異常訊息被吞掉了:

YAHOO.util.Event.onDOMReady(function() { console.log("Init: 1"); DOES_NOT_EXIST++; // 這裡會拋出異常 });
YAHOO.util.Event.onDOMReady(function() { console.log("Init: 2"); });

輸出:

Init: 1
Init: 2

解法:把回呼包成真事件

我的想法是把回呼與事件結合起來:先建立一個事件,只在回呼被觸發時才派發它。由於每個事件都有獨立的執行環境,其中一個丟出異常也不會影響其他回呼。

var currentHandler;

// 標準事件支援
if (document.addEventListener) {
  document.addEventListener("fakeEvents", function() {
    currentHandler();   // 執行回呼
  }, false);

  var dispatchFakeEvent = function() {
    var fakeEvent = document.createEvent("UIEvents");
    fakeEvent.initEvent("fakeEvents", false, false);
    document.dispatchEvent(fakeEvent);
  };
} else {
  // 針對 IE 的寫法見後面
}

var onLoadHandlers = [];

function addOnLoad(handler) {
  onLoadHandlers.push(handler);
}

function onload() {
  for (var i = 0; i < onLoadHandlers.length; i++) {
    currentHandler = onLoadHandlers[i];
    dispatchFakeEvent();
  }
}

把原本的範例丟進這套新系統:

addOnLoad(function() { console.log("Init: 1"); DOES_NOT_EXIST++; // 這裡會拋出異常 });
addOnLoad(function() { console.log("Init: 2"); });

結果正如預期:

Init: 1
Error: DOES_NOT_EXIST is not defined
Init: 2

兩個回呼都執行了、彼此不互相影響,而且異常訊息還在。

至於 Internet Explorer,它實作的是自己的事件模型。雖然有 fireEvent 可用,但只能觸發使用者互動類事件。繞路的方式是借用 propertychange:

var currentHandler;

if (document.addEventListener) {
  // 略
} else if (document.attachEvent) {
  // MSIE:透過擴充屬性,值變動時即觸發
  document.documentElement.fakeEvents = 0;
  document.documentElement.attachEvent("onpropertychange", function(event) {
    if (event.propertyName == "fakeEvents") {
      currentHandler();
    }
  });

  dispatchFakeEvent = function(handler) {
    document.documentElement.fakeEvents++;   // 觸發 propertychange
  };
}

思路一致,只是換成 propertychange 當觸發器。

關於 setTimeout 的討論

有讀者建議直接用計時器:

try { callback(); } catch(e){ setTimeout(function(){ throw e; }, 0); }

我的看法是:若沒有特別需求,計時器確實也能解決問題,上面只是用來說明這項技術的可行性;真正的意義在於提醒——目前多數框架的回呼系統都過於脆弱,這或許能提供一個優化方向。但計時器並不是真的觸發事件,而真實事件會依序執行、可以互相影響(例如氣泡)、也能被中止,這些都是計時器做不到的。

後續:Prototype 的做法

Prototype 在處理 IE 的自訂事件時,基本上也是同一套路。對應 Prototype 1.6 的程式碼摘要如下:

function createWrapper(element, eventName, handler) {
  var id = getEventID(element);
  var c = getWrappersForEventName(id, eventName);
  if (c.pluck("handler").include(handler)) return false;   // 避免重複綁定

  var wrapper = function(event) {
    if (!Event || !Event.extend || (event.eventName && event.eventName != eventName)) return false;
    Event.extend(event);
    handler.call(element, event);
  };

  wrapper.handler = handler;
  c.push(wrapper);
  return wrapper;
}

function observe(element, eventName, handler) {
  element = $(element);
  var name = getDOMEventName(eventName);
  var wrapper = createWrapper(element, eventName, handler);
  if (!wrapper) return element;

  if (element.addEventListener) {
    element.addEventListener(name, wrapper, false);
  } else {
    element.attachEvent("on" + name, wrapper);
  }
  return element;
}

// 使用方式
document.observe("dom:loaded", function() { console.log("Init: 1"); DOES_NOT_EXIST++; });
document.observe("dom:loaded", function() { console.log("Init: 2"); });

延伸思考

撇開「如何打造健壯的回呼系統」這個主線,原文其實還點出兩個關鍵:一是異常發生後仍要讓後續程式繼續跑;二是如何建立互不干擾的執行環境。

createEvent 與 setTimeout 都是可行方案,但在回呼系統這個語境下,createEvent 更貼近事件語意。而若目標只是「出錯也要繼續」,用 finally 也很直接:

var callbacks = [
  function() { console.log(0); },
  function() { console.log(1); throw new Error; },
  function() { console.log(2); },
  function() { console.log(3); }
];

for (var i = 0, len = callbacks.length; i < len; i++) {
  try {
    callbacks[i]();
  } catch(e) {
    console.info(e);   // 取得異常資訊
  } finally {
    continue;
  }
}

同樣的點子也出現在原文的留言中,寫成遞迴版本如下:

function iterate(callbacks, length, i) {
  if (i >= length) return;
  try {
    callbacks[i]();
  } catch(e) {
    throw e;
  } finally {
    iterate(callbacks, length, i + 1);
  }
}

最後留個小問題給讀者想想:為什麼上面留言中的版本,異常訊息會是最後才印出來的?

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