在撰寫 jQuery 外掛時,extend() 幾乎是必備工具。它能把多個物件合成一個,也能把方法掛載到 jQuery 全域或原型上。由於它有多種重載形式,初學者常搞不清楚參數順序,本文把三種常見用法逐一拆解。
基本形式會把 src1、src2、src3 依序合併進 dest,回傳值就是合併後的 dest。也就是說,這個操作是「原地修改」,dest 本身的結構會被改寫。
如果你希望取得合併結果,卻不想動到傳入的物件,只要把空物件 {} 當成第一個參數即可:
var newSrc = $.extend({}, src1, src2, src3);
這樣一來,所有來源物件都合併進全新的空物件,結果回傳給 newSrc,原本的 src 不受影響。例如:
var result = $.extend({}, {name:"Tom", age:21}, {name:"Jerry", sex:"Boy"});
// result = {name:"Jerry", age:21, sex:"Boy"}
可以觀察到一個關鍵規則:後面參數若與前面參數有同名屬性,會直接覆蓋前面的值。這也是為什麼「預設值放前面、使用者設定放後面」是常見寫法。
第一個參數可以省略,此時 extend 只接受一個來源物件,並把它合併到「呼叫者」身上。差別在於呼叫者是誰:
$.extend({
hello: function () { alert('hello'); }
});
之後就能用 $.hello() 呼叫,適合放工具型函式。
$.fn.extend({
hello: function () { alert('hello'); }
});
此寫法會讓所有 jQuery 物件都擁有 hello 方法,例如 $('div').hello(),這正是撰寫外掛最常用的入口。
$.extend({ net: {} }); // 先在 jQuery 全域建立 net 命名空間
$.extend($.net, { // 再把方法掛進這個命名空間
hello: function () { alert('hello'); }
});
透過命名空間分類,可以避免外掛方法互相污染全域物件。
另一個重載原型在開頭多了一個 boolean 參數,用來決定是否進行深層(遞迴)拷貝:
extend(boolean, dest, src1, src2, src3...)
先看開啟深拷貝(true)的情形:
var result = $.extend(true, {},
{ name: "John", location: { city: "Boston", county: "USA" } },
{ last: "Resig", location: { state: "MA", county: "China" } });
// result = {
// name: "John", last: "Resig",
// location: { city: "Boston", state: "MA", county: "China" }
// }
嵌套的子物件 location 也被逐層合併,city、state、county 全部保留,同名的 county 由後者覆蓋。
若把第一個參數改為 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 被後者直接取代,city 與原本的 county 都消失了。這正是設定物件合併時最容易踩到的坑——需要保留子層級設定時,記得補上 true。
以上就是 $.extend() 在專案中最常使用到的幾個細節。