extend 是寫 jQuery 插件最常用的方法,它有幾個重載原型,理解清楚能省掉很多困惑。首先記住:在 jQuery 中 jQuery.extend = jQuery.fn.extend,兩者其實是同一個函式。
dest 是要整合的空間,可以是 {} 或省略;src1、src2... 則是 JavaScript 物件,裡面可以放方法、屬性等等。它的含義是把 src1、src2... 合併進 dest,返回值為合併後的 dest——注意,這代表 dest 的結構會被直接改寫。
如果想取得合併結果卻不想動到 dest,把 {} 當第一個參數即可:
var result = $.extend({}, {name:"Tom", age:21}, {name:"Jerry", sex:"Boy"});
合併結果是:
result = {name:"Jerry", age:21, sex:"Boy"}
也就是說後面的參數若與前面同名,會覆蓋前面的值。
dest 可以省略,此時方法只有一個 src 參數,並把該 src 合併到「呼叫 extend 的那個物件」裡。
1. $.extend(src) —— 合併進 jQuery 全域物件
$.extend({
hello: function(){ alert('hello'); }
});
2. $.fn.extend(src) —— 合併進 jQuery 實例物件
$.fn.extend({
hello: function(){ alert('hello'); }
});
$.extend({ net:{} });
這在 jQuery 全域物件中開了一個 net 命名空間。接著:
$.extend($.net, {
hello: function(){ alert('hello'); }
});
把 hello 方法掛進剛剛建立的 net 命名空間。這正是 jQuery 官方避免污染全域的做法,寫插件時值得照抄。
第一個參數是 boolean,代表是否進行深度拷貝(深合併)。什麼是深合併?看例子就懂。
// 深度拷貝:true
var result = $.extend( true, {},
{ name: "John", location: {city: "Boston", county:"USA"} },
{ last: "Resig", location: {state: "MA", county:"China"} }
);
src1 與 src2 都嵌套了子物件 location。第一個參數為 true 時,合併結果是:
result = {
name: "John", last: "Resig",
location: { city:"Boston", state:"MA", county:"China" }
}
子物件的屬性被逐一合併了。若把第一個參數改成 false:
var result = $.extend( false, {},
{ name: "John", location: {city: "Boston", county:"USA"} },
{ last: "Resig", location: {state: "MA", county:"China"} }
);
結果變成:
result = { name:"John", last:"Resig", location:{state:"MA", county:"China"} }
整個 location 被 src2 直接取代,src1 的 city 與 county 全部消失。
差別就在這裡:淺合併遇到同名鍵就是整個換掉,深合併則會往裡面鑽、逐層合併。所以處理設定物件(options)時,通常要用深合併,否則使用者只傳一個巢狀屬性,就會把其他預設值整個沖掉。這是最常見的 extend 誤用。
但要小心:深合併對陣列的行為是「依索引合併」而非「整個替換」,這常常不是你要的。例如預設 list:[1,2,3],使用者傳 list:[9],深合併後會得到 [9,2,3]。若你的插件有陣列型設定,建議在合併後手動處理,或改用淺合併再自行指定要深的鍵。
另外,深合併只處理普通物件與陣列,Date、RegExp、DOM 節點等類別不會被正確複製。若設定裡有這類值,避開深合併,或在合併後重新賦值。