jQuery 的 .data() 幾乎無所不在——事件系統、動畫佇列、外掛狀態,背後都靠這套快取機制支撐。它解決的是一個很實際的難題:如何在不汙染 DOM 元素的前提下,把資料和元素綁在一起。
最直覺的做法是直接擴充 DOM 元素的屬性:el.myData = {...}。這能work,但有兩個麻煩。一是 DOM 元素同時是 JavaScript 物件,若你在上面掛了指向其他 DOM 或物件的參照,在舊版 IE 上會形成循環參照,垃圾回收無法正確處理,造成記憶體洩漏。二是元素一多,這些自訂屬性會讓元素的「形狀」變得複雜,影響引擎的優化。
所以更好的策略是低耦合:讓 DOM 元素只持有一個小小的指標,真正的資料放在別處的容器裡。
第一步,建立全域快取物件。在 jQuery 內部維護一個 cache = {},所有元素的資料都存在這裡。
第二步,給元素一個 expando 屬性。expando 的值是 "jQuery" + (new Date).getTime() 這類幾乎不可能撞車的字串,用來標記「這個元素已經被快取系統接管了」。
第三步,用自增 id 當關聯鍵。把每個元素的 dom[expando] 設為一個全域唯一的自增整數。這個 id 就是打開該元素資料的鑰匙,cache[id] 即為該元素的所有快取。
而每個元素的快取本身又是一個 name/value 的 map,所以同一個元素可以存多筆不同名稱的資料:
var cache = {
"1": { // 等同於 dom1[expando]
"name1": value1,
"name2": value2
},
"2": { // 等同於 dom2[expando]
"name1": value1,
"name2": value2
}
// ......
};
(function(window, undefined) {
var cacheData = {}, // 存放所有快取
win = window,
uuid = 0,
// 隨機數(取時間尾 8 位當 expando 名稱)
// 注意:+new Date() 是 Number,與空字串串接後才會有 slice 方法
expando = "cacheData" + (+new Date() + "").slice(-8);
// 寫入/讀取快取
var data = function(elem, name, value) {
// 情況一:傳入的是字串 key,直接操作 cacheData
if (typeof elem === "string") {
if (name !== undefined) {
cacheData[elem] = name; // 寫入
}
return cacheData[elem]; // 讀取
// 情況二:傳入的是 DOM 元素
} else if (typeof elem === "object") {
var id, thisCache;
if (!elem[expando]) {
// 第一次為該元素設定快取
id = elem[expando] = ++uuid;
thisCache = cacheData[id] = {};
} else {
// 已有快取,取出 id
id = elem[expando];
thisCache = cacheData[id];
}
// 在元素的快取物件上再放一個 expando 層,模擬 jQuery 的結構
if (!thisCache[expando]) {
thisCache[expando] = {};
}
if (value !== undefined) {
thisCache[expando][name] = value; // 寫入
}
return thisCache[expando][name]; // 讀取
}
};
// 刪除快取
var removeData = function(elem, name) {
if (typeof elem === "string") {
delete cacheData[elem];
} else if (typeof elem === "object") {
if (!elem[expando]) { return; } // 沒有快取,不必刪
// 判斷物件是否為空
var isEmptyObject = function(obj) {
var name;
for (name in obj) { return false; }
return true;
};
var removeAttr = function() {
try {
delete elem[expando]; // 標準瀏覽器
} catch (e) {
elem.removeAttribute(expando); // IE6/7 的退路
}
};
var id = elem[expando];
if (name) {
delete cacheData[id][expando][name]; // 只刪指定資料
if (isEmptyObject(cacheData[id][expando])) {
delete cacheData[id]; // 空了就把整個 id 清掉
removeAttr();
}
} else {
delete cacheData[id]; // 刪除該元素全部資料
removeAttr();
}
}
};
// 掛到 window,讓外部可以呼叫
win.data = data;
win.removeData = removeData;
})(window, undefined);
<div id="demo" style="height:100px; width:100px; background:#ccc;
color:#fff; margin:20px; text-align:center; line-height:100px;">
demo
</div>
<script>
window.onload = function() {
var demo = document.getElementById("demo");
data(demo, "myName", "hcy");
console.log(data(demo, "myName")); // hcy
data(demo, "myBlog", "https://www.cnblogs.com/cyStyle");
console.log(data(demo, "myBlog"));
removeData(demo, "myBlog"); // 只刪 myBlog
console.log(data(demo, "myBlog")); // undefined
console.log(data(demo, "myName")); // hcy 仍在
removeData(demo); // 刪除全部
console.log(demo[expando]); // undefined
};
</script>
在 Firefox 下的執行結果:
想像每個 DOM 元素都有一把「開啟快取保險箱的鑰匙」。元素本身只保存一個簡單的屬性(那把鑰匙的編號),真正的資料全放在保險箱(cache 物件)裡。這樣一來:
資料與元素的關聯被保留(透過 id 對應),但元素本身不再持有大量參照,由 DOM 引起的記憶體洩漏風險被降到最低;刪除元素時只要呼叫 removeData 清掉對應的 cache 條目,就能避免資料變成孤兒;同一元素可以存多筆不同名稱的資料,互不干擾。
undefined 參數的用意。IIFE 的第二個參數 undefined 是舊技巧:在舊版 JS 中 undefined 可以被重新赋值,透過不傳值讓它在閉包內保證是真正的 undefined,用來做 typeof x === "undefined" 的判斷才可靠。現代環境已無此問題。
直接用 jQuery 就好。這個模擬的價值在於理解原理。實務上請直接用 $.data() 與 $.removeData(),它們處理了更多邊界狀況。要注意的是,jQuery 3.x 之後內部實作已改用 WeakMap,不再依賴 expando 屬性,記憶體管理更乾淨。
適用範圍。理論上 data 可用於任何物件的快取,但用在 window 或純本地物件上容易產生循環參照與洩漏,所以實務上仍以 DOM 節點為主要用途。搭配事件與動畫時特別有用——例如在 hover 事件中讀取該元素綁定的設定,不必每次重新查詢。
因為分享,所以簡單;因為分享,所以快樂。