說起 jQuery 的數據緩存系統,源頭大概要追溯到 1.2 版本。那個時候 jQuery 的事件系統幾乎是照搬 Dean Edwards 的 addEvent.js,而 addEvent 本身帶著一個先天缺陷:它把事件回調直接掛在 EventTarget 上,這必然造成循環引用;一旦 EventTarget 恰好是 window,麻煩就更大了——直接演變成全域污染。
數據緩存系統的出現,一口氣解決了這兩個隱患。除此之外,它還提供了一個額外好處:不同模組產生的中間變量可以妥善寄放,讓另一個模組隨時取用,等於把模組之間的耦合鬆開了。對 jQuery 來說,事件克隆、後來的佇列(queue)機制,全都建立在這套緩存設施之上。
jQuery 1.2 在 core 模組裡新增了兩個靜態方法:data 與 removeData。前者延續 jQuery 一貫的讀寫合一風格。
這套緩存的做法是:所有數據統一放在 $.cache 上,再為每個需要緩存的元素節點、文檔物件或 window 物件分配一個 UUID。UUID 的屬性名是一串自訂義的隨機鍵——"jQuery" + (new Date()).getTime(),值則是從 0 開始遞增的整數。
問題在於,UUID 總得掛在某個物件上。如果那個物件是 window,全域污染又回來了。所以 jQuery 內部做了一層轉譯:判定對象為 window 時,改用一個名為 windowData 的空物件承接 UUID。拿到 UUID 之後,首次存取緩存系統時會在 $.cache 裡開一個空物件作為「緩存體」,用來存放與目標物件相關的一切。這個過程很像銀行開戶,UUID 的值就是存摺。而 removeData 負責銷戶:當緩存體被清空、連一組鍵值都不剩時,jQuery 會把它從 $.cache 中刪除,並把目標物件上的 UUID 一併移除。
程式碼如下:
//jQuery1.2.3
var expando = "jQuery" + (new Date()).getTime(), uuid = 0, windowData = {};
jQuery.extend({
cache: {},
data: function( elem, name, data ) {
elem = elem == window ? windowData : elem;//對window物件做特別處理
var id = elem[ expando ];
if ( !id ) //如果沒有UUID則新設一個
id = elem[ expando ] = ++uuid;
//如果沒有在$.cache中開戶,則先開戶
if ( name && !jQuery.cache[ id ] )
jQuery.cache[ id ] = {};
// 第三個參數不為undefined時,為寫操作
if ( data != undefined )
jQuery.cache[ id ][ name ] = data;
//如果只有一個參數,則返回緩存物件,兩個參數則返回目標數據
return name ? jQuery.cache[ id ][ name ] : id;
},
removeData: function( elem, name ) {
elem = elem == window ? windowData : elem;
var id = elem[ expando ];
if ( name ) {//移除目標數據
if ( jQuery.cache[ id ] ) {
delete jQuery.cache[ id ][ name ];
name = "";
for ( name in jQuery.cache[ id ] )
break;
//遍歷緩存體,如果不為空,那name會被改寫,如果沒有被改寫,則!name 為true,
//從而引發再次調用此方法,但這次是只傳一個參數,移除緩存體
if ( !name )
jQuery.removeData( elem );
}
} else {
//移除UUID,但IE下對元素使用delete會拋錯
try {
delete elem[ expando ];
} catch(e){
if ( elem.removeAttribute )
elem.removeAttribute( expando );
}//註銷帳戶
delete jQuery.cache[ id ];
}
}
})
到了 1.2.3,jQuery 又補上兩個同名的原型方法 data 與 removeData,主要是為了讓鏈式呼叫與集合操作更順手,同時在 data 裡加入了 getData、setData 自訂事件的觸發邏輯。
1.3 版本,數據緩存終於從 core 裡剝離出來,成為獨立的 data.js(這是內部開發時的切分方式)。同時新增兩組方法:命名空間上的 queue 與 dequeue,以及原型上對應的同名版本。queue 的用途很直白——把一批數據排隊存起來,主要服務於動畫模組;dequeue 則是從隊列中取掉一個。
程式碼如下:
//jQuery1.3
jQuery.extend({
queue: function( elem, type, data ) {
if ( elem ){
type = (type || "fx") + "queue";
var q = jQuery.data( elem, type );
if ( !q || jQuery.isArray(data) )//確保儲存的是一個陣列
q = jQuery.data( elem, type, jQuery.makeArray(data) );
else if( data )//然後往這個數據加東西
q.push( data );
}
return q;
},
dequeue: function( elem, type ){
var queue = jQuery.queue( elem, type ),
fn = queue.shift();//然後刪掉一個,早期它是放置動畫的回調,刪掉它就call一下,
// 但沒有做是否為函數的判定,估計也沒有寫到文檔中,為內部使用
if( !type || type === "fx" )
fn = queue[0];
if( fn !== undefined )
fn.call(elem);
}
})
fx 模組 animate 方法的呼叫方式如下,其中 each 是並行處理多組動畫,queue 則是一組接一組依序處理:
//each是並行處理多個動畫,queue是一個接一個處理多個動畫
this[ optall.queue === false ? "each" : "queue" ](function(){ /*略*/})
把自訂屬性掛在元素上,還衍生出另一個問題:複製元素時,這個屬性會一起被搬過去,導致兩個元素共用同一個 UUID,數據被錯誤操作。jQuery 早期的節點複製實作相當樸素——如果 cloneNode 不會複製事件就直接用它,否則改用 outerHTML 或父節點的 innerHTML,再交給 clean 解析出新元素。但 outerHTML 與 innerHTML 會把顯式屬性寫進字串裡,因此必須用正則摯掉。
//jQuery1.3.2 core.js clone方法
var ret = this.map(function(){
if ( !jQuery.support.noCloneEvent && !jQuery.isXMLDoc(this) ) {
var html = this.outerHTML;
if ( !html ) {
var div = this.ownerDocument.createElement("div");
div.appendChild( this.cloneNode(true) );
html = div.innerHTML;
}
return jQuery.clean([html.replace(/ jQuery\d+="(?:\d+|null)"/g, "").replace(/^\s*/, "")])[0];
} else
return this.cloneNode(true);
});
1.4 版本踩到一個 IE 的坑:object、embed、applet 這三個用來接入外部資源的老標籤可能拋錯。舊式 IE 的元素節點本質上是 COM 包裝,一旦載入外部資源,它就變成該資源的實例,而這類物件有嚴格的存取控制,不能像普通 JS 物件那樣任意加成員。jQuery 的反應很乾脆:這三種標籤一律不緩存數據,並用一個名為 noData 的 hash 來檢查標籤名。
noData: { "embed": true,
"object": true,
"applet": true },
//代碼防御
if ( elem.nodeName && jQuery.noData[elem.nodeName.toLowerCase()] ) {
return;
}
同一版本還優化了 $.data,允許第二個參數傳入物件,方便一次寫入多筆數據;UUID 對應的自訂屬性 expando 也被收進命名空間之下;queue 與 dequeue 則被剝成獨立模組。
第一,新增 changeData 自訂方法。不過這組 API 幾乎沒人用,比較像產品經理的自我滿足。
第二,把「元素節點是否支援掛自訂屬性」的判斷邏輯抽成 acceptData。原因是團隊發現,object 標籤載入 Flash 資源後其實還是可以加自訂屬性,於是決定網開一面。IE 載入 Flash 時需要為 object 指定 classId(值為 clsid:D27CDB6E-AE6D-11cf-96B8-444553540000),判斷條件因此變得相當繁瑣;由於 data 與 removeData 都要用,抽成獨立方法確實省下不少位元組。
第三,回應 HTML5 帶來的變化。HTML5 新增了 data-* 這套機制:只要自訂屬性以 data- 開頭,瀏覽器就會把它收進元素的 dataset 物件。這下尷尬了——開發者可能用 HTML5 存數據,也可能用 jQuery 存,data 方法的定位頓時模糊。於是 jQuery 強化了原型上的 data:用戶首次存取該元素時,會遍歷所有 data- 開頭的屬性(為了兼容舊式 IE,不能直接遍歷 dataset),把它們搬進 jQuery 的緩存體。取值時先查緩存,查不到才回頭用 getAttribute 讀 data- 屬性。
但 HTML5 的緩存能力很弱,只能存字串(這顯然是為了迴避循環引用)。因此 jQuery 還得把字串還原成各種型別:"null"、"false"、"true" 分別轉為 null、false、true;符合數字格式的轉數字;以 { 開頭、} 結尾的則嘗試解析成物件。
//jQuery1.43 $.fn.data
rbrace = /^(?:\{.*\}|\[.*\])$/;
if ( data === undefined && this.length ) {
data = jQuery.data( this[0], key );
if ( data === undefined && this[0].nodeType === 1 ) {
data = this[0].getAttribute( "data-" + key );
if ( typeof data === "string" ) {
try {
data = data === "true" ? true :
data === "false" ? false :
data === "null" ? null :
!jQuery.isNaN( data ) ? parseFloat( data ) :
rbrace.test( data ) ? jQuery.parseJSON( data ) :
data;
} catch( e ) {}
} else {
data = undefined;
}
}
}
1.5 同樣有三項改動。此時 jQuery 已經擊敗 Prototype.js,用戶量暴漲,馬太效應明顯,工作重心於是轉向效能與修 bug——用戶越多,免費測試員越多,覆蓋面自然越廣。
首先是 expando 的調整:原本基於時間戳,改為版本號加隨機數,因為同一頁面可能同時引入多個版本的 jQuery。其次,「是否存在此數據」的判斷被抽成 hasData,處理 HTML5 data-* 的邏輯則抽成私有方法 dataAttr,都是為了讓結構更清楚。dataAttr 使用 JSON.parse,但這個 JSON 對象有可能來自 JSON2.js,而 JSON2.js 有個很惱人的副作用:它為一系列原生型別掛上 toJSON 方法,導致 for-in 判斷空物件時出錯。jQuery 只好再做一個 isEmptyDataObject 來兜底。
第三項改動最有意思。數據緩存本來是為事件系統分化出來的基礎設施,後來成了內部眾多模組的地基。也就是說,緩存體裡存著大量框架自己的變量(系統數據);而一旦 API 公開進文檔,用戶也會拿 data 來存業務數據(用戶數據)。早期用戶少,命名碰撞概率低,加上 jQuery 為系統數據精心挑了些冷門名字——__class__、__change__ 或加點後綴——一直沒出什麼亂子。可當 jQuery 成為世界級框架後,「用戶數據名幹掉系統數據名,導致事件系統或其他模組癱瘫」就成了時常上演的事故。
jQuery 於是改造緩存體:原本是一個物件,什麼都往裡扔;現在在緩存體內部再開一個子物件,鍵名為隨機的 jQuery.expando 值,系統數據一律放進去。基於向前兼容的考量,events 的系統數據仍然直接放在緩存體上。至於如何區分系統數據?很簡單——在 data 方法加第四個參數,傳真值即為系統數據;removeData 相應加了第三個參數用於刪除系統數據;另外新設 _data 專門操作系統數據。改造後的緩存體結構如下:
var cache = {
jQuery14312343254:{/*放置系統數據*/
events: {/"放置事件名與它對應的回調列表"/}
/*這裡放置用戶數據*/
}
1.7 又翻了一次:系統變量改放到 data 物件中,因此「緩存體是否為空」的判定也得跟著調整,現在要跳過 toJSON 與 data。新結構如下:
var cache = {
data:{/*放置用戶數據*/
/*這裡放置系統數據*/
}
1.8 曾短暫出現過一個 deleteIds 陣列,用來重用 UUID,曇花一現。UUID 的值從 1.8 起不再用 jQuery.uuid,改由 jQuery.guid 遞增產生。
更關鍵的變化發生在 1.8.3 之後:實際操作數據的實作被抽成私有方法,命名空間與原型上的方法退化成單純的代理,並分成兩組——操作用戶數據的 data / removeData,以及操作系統數據的 _data / _removeData。至此,光是緩存系統就是個龐大家族了。

歸根結底,數據緩存做的事就是:在目標物件與緩存體之間建立一對一關係,之後所有操作都在緩存體上進行,複雜度全集中在建立關係這一步。而對一個普通 JS 物件做增刪改查,本來就毫無難度,用戶也玩不出花樣。從軟體設計的角度看,這正是最好的結果——同時滿足 KISS 原則與單一職責原則。