extend() 是寫外掛時幾乎一定會用到的方法,主要負責把多個物件的屬性合併成一份設定。
extend(dest, src1, src2, src3...);
它會把 src1、src2、src3… 合併進 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" }
<!DOCTYPE html>
<html>
<head>
<script src="https://code.jquery.com/jquery-latest.js"></script>
</head>
<body>
<div id="log"></div>
<script>
var defaults = { validate: false, limit: 5, name: "foo" };
var options = { validate: true, name: "bar" };
/* 合併 defaults 與 options,且不修改 defaults */
var settings = $.extend({}, defaults, options); // 外掛開發最常用的一行
var printObj = typeof JSON != "undefined" ? JSON.stringify : function (obj) {
var arr = [];
$.each(obj, function (key, val) {
var next = key + ": ";
next += $.isPlainObject(val) ? printObj(val) : val;
arr.push(next);
});
return "{ " + arr.join(", ") + " }";
};
$("#log").append("<div><b>defaults -- </b>" + printObj(defaults) + "</div>");
$("#log").append("<div><b>options -- </b>" + printObj(options) + "</div>");
$("#log").append("<div><b>settings -- </b>" + printObj(settings) + "</div>");
</script>
</body>
</html>
輸出結果:
defaults -- {"validate":false,"limit":5,"name":"foo"} // 原樣保留
options -- {"validate":true,"name":"bar"} // 原樣保留
settings -- {"validate":true,"limit":5,"name":"bar"} // 合併後,name 被 options 覆蓋
預設行為是「淺合併」:同名屬性若為物件,會被整個替換掉。需要遞迴合併時加上第一個參數 true:
var defaults = { style: { color: "red", size: 12 } };
var options = { style: { color: "blue" } };
$.extend({}, defaults, options);
// { style: { color: "blue" } } —— size 消失了
$.extend(true, {}, defaults, options);
// { style: { color: "blue", size: 12 } } —— 遞迴合併
$.extend({
myPlugin: function () { /* ... */ }
});
// 或擴充 jQuery 的原型,等於新增 $(...).xxx() 形式的方法
$.fn.extend({
highlight: function () {
return this.css("background", "yellow");
}
});
這正是絕大多數 jQuery 外掛的起手式:$.fn.extend() 對外掛而言幾乎是標準入口。
實務上的小提醒:$.extend({}, defaults, options) 這個寫法之所以要多寫一個空物件,就是為了避免外掛被呼叫兩次以上時,第一次傳入的 options 汙染了 defaults,導致預設值被永久改寫。