extend() 是 jQuery 的基礎函式之一,作用是把屬性合併進既有物件。寫插件時幾乎都會用到它,而它本身有幾種重載形式,分清楚之後會少踩很多坑。
jQuery.extend = jQuery.fn.extend = function () {
var options, name, src, copy, copyIsArray, clone,
target = arguments[0] || {}, // 參數目標對象
i = 1,
length = arguments.length, // 參數長度
deep = false; // 是否為深度復制
// 處理深度復制的情況
if (typeof target === "boolean") {
deep = target;
target = arguments[1] || {};
i = 2; // 跳過 boolean 與 target
}
// 目標對象型別錯誤時重置為 {}
if (typeof target !== "object" && !jQuery.isFunction(target)) {
target = {};
}
// 只傳一個參數時,目標對象就是 jQuery 自身
if (length === i) {
target = this;
--i;
}
for (; i < length; i++) {
// 只處理非 null/undefined 的值
if ((options = arguments[i]) != null) {
for (name in options) {
src = target[name];
copy = options[name];
// 避免無限迴圈
if (target === copy) {
continue;
}
// 深度合併純物件或陣列
if (deep && copy && (jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)))) {
if (copyIsArray) {
copyIsArray = false;
clone = src && jQuery.isArray(src) ? src : [];
} else {
clone = src && jQuery.isPlainObject(src) ? src : {};
}
target[name] = jQuery.extend(deep, clone, copy);
} else if (copy !== undefined) {
target[name] = copy; // 非深度複製直接覆蓋
}
}
}
}
return target;
};
1. extend(dest, src1, src2, src3...)
把 src1、src2……合併進 dest,回傳合併後的 dest。注意這會直接改動 dest 的結構。若不想動到 dest,就把空物件當第一個參數:
var newSrc = $.extend({}, src1, src2, src3...)
例如:
var result = $.extend({}, { name: "Tom", age: 21 }, { name: "Jerry", sex: "Boy" });
結果是:
result = { name: "Jerry", age: 21, sex: "Boy" }
也就是說,後面參數若有同名屬性,會覆蓋前面的值。
2. extend(boolean, dest, src1, src2...)
第一個參數決定是否深度複製,其餘同上。看差別:
var result = $.extend(true, {},
{ name: "John", location: { city: "Boston", county: "USA" } },
{ last: "Resig", location: { state: "MA", county: "China" } });
deep 為 true 時,嵌套的子物件也會合併:
result = { name: "John", last: "Resig", location: { city: "Boston", state: "MA", county: "China" } }
把 true 換成 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" } }
這個差異在設定物件有巢狀結構時特別關鍵,忘記帶 true 往往就是設定合併失效的原因。
dest 可以省略,此時只能有一個 src 參數,並且會被合併到呼叫 extend 的物件上。
1. $.extend(src)——合併到 jQuery 全域物件:
$.extend({
hello: function () { alert('hello'); }
});
2. $.fn.extend(src)——合併到 jQuery 實例物件,也就是為 jQuery 物件新增方法:
$.fn.extend({
hello: function () { alert('hello'); }
});
在 jQuery 全域物件上開一個命名空間:
$.extend({ net: {} });
把方法掛進這個命名空間:
$.extend($.net, {
hello: function () { alert('hello'); }
});
這正是大多數 jQuery 插件的組織方式:先用 extend 建立命名空間,再用 $.fn.extend 註冊可呼叫的方法,最後透過 defaults 物件讓使用者覆寫設定。
希望這篇對大家的 jQuery 開發有幫助。