DIV CSS 佈局教程網

深入 jQuery 3.0 的 Data 模組:dataPriv 與 dataUser 的分工
編輯:JQuery特效代碼     

jQuery 3.0 於 2016 年 6 月 9 日正式發布,被視為下一代 jQuery 的起點。這個版本自 2014 年 10 月起開發,期間經歷 beta(2016/1/14)與候選版(2016/05/20)。本文聚焦其內部資料快取模組 Data 的實作。

一、Data 是什麼

Data 是 jQuery 3.0 內部使用的一個「類」,共被建立成兩個物件:dataPriv 與 dataUser。它擁有一個物件屬性 expando、一個類屬性 uid,以及 cache、set、get、access、remove、hasData 等方法。

1. uid

從 1 開始遞增的整數,用作每個快取實例的流水號。

2. expando

由 jQuery.expando 與 uid 組成的唯一字串,作為元素上掛載快取的 key:

jQuery.expando = "jQuery" + ( version + Math.random() ).replace( /\D/g, "" )

也就是把版本號與隨機數拼接後移除所有非數字字元,例如:

"jQuery" + "3.0.0" + 0.129896303388626
→ "jQuery30009423638425146147"

3.0 內部兩個實例產生的 expando 形如:

jQuery 300 024727210109188635 1
jQuery 300 024727210109188635 2

中間那段是隨機數,每次重新載入都會變,其餘固定。

3. cache

為 owner 掛上一個物件作為儲存空間,並以 this.expando 為 key。owner 必須通過 acceptData 檢查:

var acceptData = function (owner) {
  return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
};

也就是只接受元素節點(nodeType 1)、文件節點(nodeType 9)與普通 JS 物件。文字節點(3)、註解節點(8)一律不掛。

acceptData 在 3.0 中共用於三處:

  1. Data 類的 cache 方法(私有)。
  2. $.cleanData,清空元素關聯的所有快取,被 empty、html、replaceWith、remove 呼叫。
  3. $().trigger,主動派發事件。

掛載方式也做了區分:DOM 元素直接用點運算子賦值,普通 JS 物件則改用 ES5 的 Object.defineProperty,這體現了 3.0 擁抱新 API 的方向。

if (owner.nodeType) {
  owner[this.expando] = value;
} else {
  Object.defineProperty(owner, this.expando, {
    value: value,
    configurable: true
  });
}

等價於:

elem['jQuery3000247272101091886351'] = dataObj;

var person = { name: 'John', age: 30 };
Object.defineProperty(person, 'jQuery3000247272101091886351', {
  value: dataObj, configurable: true
});

cache 的邏輯是:第一次呼叫時建立空物件並掛上,之後直接回傳既有物件。

cache: function (owner) {
  var value = owner[this.expando];
  if (!value) {
    value = {};
    if (acceptData(owner)) {
      if (owner.nodeType) {
        owner[this.expando] = value;
      } else {
        Object.defineProperty(owner, this.expando, {
          value: value, configurable: true
        });
      }
    }
  }
  return value;
}

4. set

先取回 cache 那個空物件,再往上補屬性。data 是字串則以它為 key,是物件則逐一複製。所有 key 都會被轉成駝峰格式,這是為了相容 HTML5 的 data-xxx 寫法。

set: function (owner, data, value) {
  var prop, cache = this.cache(owner);
  if (typeof data === "string") {
    cache[jQuery.camelCase(data)] = value;
  } else {
    for (prop in data) {
      cache[jQuery.camelCase(prop)] = data[prop];
    }
  }
  return cache;
}

5. get

get: function (owner, key) {
  return key === undefined
    ? this.cache(owner)
    : owner[this.expando] && owner[this.expando][jQuery.camelCase(key)];
}

傳 key 取該值,不傳則取整個 cache。

6. access

同時是 getter 與 setter,依參數組合決定行為:

  • getter:key 為 undefined(取整個 cache),或 key 為字串而 value 為 undefined(取指定鍵)。
  • setter:owner、key、value 三者齊備。
access: function (owner, key, value) {
  if (key === undefined ||
      ((key && typeof key === "string") && value === undefined)) {
    return this.get(owner, key);
  }
  this.set(owner, key, value);
  return value !== undefined ? value : key;
}

7. remove

先透過 expando 拿到 cache。若傳了 key 就刪除指定鍵(key 本身也一併移除),且 key 可以是陣列以支援批次刪除;若不傳 key 則整個 cache 移除。這裡再次區分 DOM 與普通物件:DOM 用 undefined 賦值,JS 物件用 delete,因為研究指出在 DOM 節點上大量 delete 屬性會拖慢 Blink 與 WebKit。

remove: function (owner, key) {
  var i, cache = owner[this.expando];
  if (cache === undefined) return;

  if (key !== undefined) {
    if (jQuery.isArray(key)) {
      key = key.map(jQuery.camelCase);
    } else {
      key = jQuery.camelCase(key);
      key = key in cache ? [key] : (key.match(rnotwhite) || []);
    }
    i = key.length;
    while (i--) { delete cache[key[i]]; }
  }

  if (key === undefined || jQuery.isEmptyObject(cache)) {
    if (owner.nodeType) {
      owner[this.expando] = undefined;
    } else {
      delete owner[this.expando];
    }
  }
}

8. hasData

hasData: function (owner) {
  var cache = owner[this.expando];
  return cache !== undefined && !jQuery.isEmptyObject(cache);
}

二、dataPriv 與 dataUser 的分工

3.0 建立了 Data 的兩個實例。顧名思義,dataPriv = data + private,服務 jQuery 內部;dataUser 則服務開放給使用者呼叫的公開 API。

分布情況:

dataPriv
  公共     $.hasData、$.cleanData、cloneCopyEvent
  隊列     $().queue、$()._queueHooks、$().promise
  動畫     $().animate、$().stop、$().finish、showHide
  事件     $.event.add / remove / dispatch / trigger
  其它     setGlobalEval、domManip、defaultPrefilter、$().toggleClass

dataUser
  公共     $.hasData、$.cleanData、cloneCopyEvent
  資料緩存 $.data、$.removeData、$().data、$().removeData
  其它     dataAttr

可見事件、隊列、動畫這些「框架自己要用」的狀態放在 dataPriv;而使用者透過 .data() 存的東西放在 dataUser。

$.hasData(elem)

hasData: function (elem) {
  return dataUser.hasData(elem) || dataPriv.hasData(elem);
}

兩邊都沒有才回傳 false。

$.cleanData(elems)

同時清空兩邊的快取。雖然它暴露在 $ 上,官方 API 卻沒有記載,因為誤用後果嚴重:對已綁定事件的元素呼叫它,所有事件都會失效(dataPriv 內的資料被清空)。

cloneCopyEvent(src, dest)

內部方法,$.clone 會用到。複製節點時連帶複製資料,因此事件也會跟著過來:

var cloneNode = $.clone(elem);   // elem 上的事件,cloneNode 也有

三、1.x 與 2.x/3.x 的關鍵差異

1. 快取的資料結構

1.x(至 1.11.2)把快取存在公開的 jQuery.cache 上;2.x 之後改用內部的 Data 類,透過 dataPriv 與 dataUser 兩個私有實例管理。2.x 的設計明顯更安全——快取完全私有,不存在被外部誤寫的風險,而 1.x 只要有人理所當然地往 $ 上掛一個 cache 物件,就可能造成難以追查的錯誤。

2. jQuery._data 的退場

帶底線前綴是「約定式私有」。1.x 中的 _data 被事件、隊列、動畫、setGlobalEval、cloneCopyEvent、fixCloneNodeIssues、domManip、showHide、defaultPrefilter、toggleClass 等模組使用。3.x 以 dataPriv 與 dataUser 取代,是真正的封裝而非靠命名約定。3.0.0 仍保守保留了 _data 作為相容,但後續版本應會移除。

3. 重構方向

1.x 以 $._data 為中心去輔助實作其他 API;2.x/3.x 則把 Data 抽成獨立類別,再以 dataPriv/dataUser 為中心組織程式碼,職責邊界清晰得多。

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