DIV CSS 佈局教程網

jQuery.data() 與記憶體洩漏:原型鏈上的數據汙染問題
編輯:關於JavaScript     

jQuery 官方文件對 $.data() 的說明是:這是個低階方法,一般情況應改用 .data()。它的賣點在於「能安全地為 DOM 元素附加任意型別的數據,避免循環參照,因而避免記憶體洩漏」。原文是這樣寫的:

The jQuery.data() method allows us to attach data of any type to DOM elements in a way that is safe from circular references and therefore from memory leaks. We can set several distinct values for a single element and retrieve them later.

聽起來很美好,但實際上這個方法的問題不只一端。在 jQuery 論壇的討論中,robert.katic 更深入地剖析了它的缺陷。

問題一:非 DOM 元素上的數據無法徹底清除

$.data() 套用在宿主物件(host object,例如 DOM 元素)上時運作良好——元素被 .remove() 移除時,附掛的數據也會一併清掉。但套用在純 JavaScript 物件上時,情況就不太理想:這些數據會一直存活到視窗關閉為止。同樣的問題也存在於 event 物件上,因為事件處理器本身就是用這個機制儲存的。

最簡單的解法是把數據存在該物件自己新增的屬性裡:

// ...
if ( elem.nodeType ) {
  cache[ id ] = dataObject;
  elem[ expando ] = id;
} else {
  elem[ expando ] = dataObject;
}
// ...

問題二:原型鏈造成數據汙染

然而一旦牽涉到繼承,上面的做法就無能為力了。看這段程式碼:

var parent = {};
var childA = Object.create( parent );
var childB = Object.create( parent );

$.data( parent, "foo", "parent value" );

// 這可能是刻意設計的行為
$.data( childA, "foo" );   // => "parent value"
$.data( childB, "foo" );   // => "parent value"

// 但這大概不是任何人期望的
$.data( childA, "foo", "childA value" );
$.data( parent, "foo" );   // => "childA value"
$.data( childB, "foo" );   // => "childA value"

流程是這樣的:起初 parent 上沒有 foo,於是建立一個物件來存這個新值。

接著我們嘗試修改 childA 的 foo:

childA 自身並沒有 foo,於是沿著原型鏈往上找到 parent,而 parent 剛好有這個屬性——值就被直接改寫了。結果是:從 parent 和 childB 去讀 foo,拿到的都是「childA value」。子物件的一次寫入,汙染了整條原型鏈。

解法:用 hasOwnProperty 守住自己的地盤

要避免這種情況,讀寫時都應該用 hasOwnProperty 確認該屬性屬於物件自身。這樣 childA 的值就不會向上廣播,也不會繼承父物件的值。也就是說,只有在物件自身沒有該數據時,才回頭去讀原型鏈。

另一種思路是把數據直接存進物件自身,但缺點是無法回傳整個數據物件(因為它不存在),只能逐個屬性存取:

// ...
if ( elem.nodeType ) {
  dataObject[ name ] = value;
} else {
  elem[ expando + "_" + name ] = value;
}
// ...

robert.katic 偏好第一種方案,並據此重寫了 $.data() 與 $.removeData():

(function($){
  var expando = "jQuery" + (new Date).getTime(),
      hasOwnProperty = Object.prototype.hasOwnProperty,
      _data = $.data,
      _removeData = $.removeData;

  $.data = function( obj, name, data ) {
    if ( obj.nodeType ) {
      return _data( obj, name, data );
    }

    var thisCache, hasCache = hasOwnProperty.call( obj, expando );

    if ( !hasCache && typeof name === "string" && data === undefined ) {
      return undefined;
    }

    if ( typeof name === "object" ) {
      obj[ expando ] = $.extend(true, {}, name);
    } else if ( !hasCache ) {
      obj[ expando ] = {};
    }

    thisCache = obj[ expando ];

    if ( typeof name === "string" ) {
      if ( data !== undefined ) {
        thisCache[ name ] = data;
      }
      return thisCache[ name ];
    }

    return thisCache;
  };

  $.removeData = function( obj, name ) {
    if ( obj.nodeType ) {
      return _removeData( obj, name );
    }

    if ( name ) {
      if ( hasOwnProperty.call( obj, expando ) ) {
        delete obj[ expando ][ name ];
        if ( $.isEmptyObject( obj[expando] ) ) {
          delete obj[ expando ];
        }
      }
    } else {
      delete obj[ expando ];
    }
  };
})(jQuery);

這個版本的關鍵差異有兩處:一是所有屬性存取都經過 hasOwnProperty 把關,二是當數據物件被清空後,連 expando 屬性本身也一併刪除,不留殘骸。

值得記取的教訓

jQuery 是很優秀的函式庫,但仍不免有些小瑕疵,而這些瑕疵往往正好落在我們日常會踩的路徑上。這案例的啟示其實很通用:只要你把使用者的資料掛到一個「可能被繼承的物件」上,就必須先想清楚原型鏈會不會讓寫入穿透出去。原生 JS 物件如此,jQuery.data 也是如此。

特別感謝 robert.katic 對這個方法缺陷的細緻分析。

參考資料:
https://forum.jquery.com/topic/data-object-and-memory-leak

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