jQuery.data() 的作用是為普通物件或 DOM 元素附加、讀取資料。它看起來只是個簡便的 getter/setter,但底層為了避開舊版 IE 的記憶體回收問題,其實分了好幾條路徑。以下逐層拆解。
整體可分為三種用法:
其一,傳入三個參數,以 name / value 為目標物件附加單筆資料(只傳兩個參數時即為取值)。
其二,傳入兩個物件,把第二個物件的內容整批複製到第一個物件的資料快取中。
其三,為 DOM 元素附加資料。
為普通物件附加資料時,本質是幫它掛上一個名為 cache 的物件,並使用一個特殊命名的屬性來存放。jQuery 1.6 中,這個屬性名是 jQuery16 加上一串隨機數字。
<script>
obj = {};
$.data(obj, 'name', 'value');
document.write("$.data(obj, 'name') = " + $.data(obj, 'name') + '<br />');
for (var key in obj) {
document.write("obj." + key + ".name = " + obj[key].name);
}
</script>
輸出結果:
$.data(obj, 'name') = value obj.jQuery16018518865841457738.name = value
可以看到,$.data(obj, 'name') 實際上把資料寫進了名為 jQuery16018518865841457738 的這個 cache 物件的屬性上。
用精簡的程式碼重現這個機制:
$ = function() {
var expando = "jQuery" + ("6" + Math.random()).replace(/\D/g, '');
function getData(cache, name) {
return cache[name];
}
function setData(cache, name, value) {
cache[name] = value;
}
function getCache(obj) {
obj[expando] = obj[expando] || {};
return obj[expando];
}
return {
data: function(obj, name, value) {
var cache = getCache(obj);
if (value === undefined) {
return getData(cache, name);
} else {
setData(cache, name, value);
}
}
};
}();
幾個重點:expando 是由版本號加隨機數、再去掉非數字字元組成的特殊名稱,它能區分不同頁面(例如不同 iframe 中的 expando 各自不同)。getCache() 負責取得或初始化 cache。data() 則依參數個數決定走取值還是設值——這也是為什麼「傳 undefined 當值」會被視為取值。
第二種用法是把一個物件當成參數傳入,它的每組鍵值會被複製進 cache。
<script>
obj = {};
$.data(obj, {name1: 'value1', name2: 'value2'});
document.write("$.data(obj, 'name1') = " + $.data(obj, 'name1') + '<br />');
document.write("$.data(obj, 'name2') = " + $.data(obj, 'name2') + '<br />');
for (var key in obj) {
document.write("obj." + key + ".name1 = " + obj[key].name1 + '<br />');
document.write("obj." + key + ".name2 = " + obj[key].name2);
}
</script>
輸出:
$.data(obj, 'name1') = value1 $.data(obj, 'name2') = value2 obj.jQuery1600233050178663064.name1 = value1 obj.jQuery1600233050178663064.name2 = value2
對應的實作只需加一個內部函式,並在 data 中做一次型別判斷:
function setDataWithObject(cache, another) {
for (var name in another) {
cache[name] = another[name];
}
}
data: function(obj, name, value) {
var cache = getCache(obj);
if (name instanceof Object) {
setDataWithObject(cache, name);
} else if (value === undefined) {
return getData(cache, name);
} else {
setData(cache, name, value);
}
}
DOM 元素也是物件,理論上前面的做法都能用。但 IE6、IE7 對掛在 DOM 元素上的物件引用有垃圾回收缺陷——元素被移除後,那些引用不會被釋放,於是造成記憶體洩漏。因此 jQuery 對 DOM 元素走了另一條路:把 cache 統一放在全域容器中,只在元素上留一個 uid 當索引。
<script>
window.onload = function() {
div = document.getElementById('div_test');
$.data(div, 'name', 'value');
document.write($.data(div, 'name'));
};
</script>
輸出就是 value,對外行為完全一致。差別藏在 getCache 裡:
$ = function() {
var expando = "jQuery" + ("6" + Math.random()).replace(/\D/g, '');
var globalCache = {};
var uuid = 0;
function getCache(obj) {
if (obj.nodeType) {
var id = obj[expando] = obj[expando] || ++uuid;
globalCache[id] = globalCache[id] || {};
return globalCache[id];
} else {
obj[expando] = obj[expando] || {};
return obj[expando];
}
}
}();
globalCache 是所有 DOM cache 的容器,uuid 則是遞增的唯一識別碼,會被寫進元素的 expando 屬性。判斷依據是元素有沒有 nodeType:有就視為 DOM 元素,先取(或初始化)uid,再到 globalCache 中取出對應的 cache。
統一用 globalCache 顯然更省事,但 jQuery 沒有這麼做。我的理解是這屬於效能上的取捨:少一層屬性查找,存取自然略快。jQuery 原始碼中這類刻意為不同情況分別處理的地方相當多,閱讀時確實增加了難度,但也換來了實際效能上的收益。至於這樣的取捨是否值得,就见仁見智了。