上一節的預設值寫在函式內部,每次呼叫都會重新建立一次物件。這一節把它抽出來掛在外掛上,改寫成本來的外掛標準結構。
;(function($){
$.extend($.fn, {
color : function(options){
var options = $.extend({}, $.fn.color.defaults, options);
return this.each(function(){
$(this).css("color", options.bcolor);
$(this).css("background", options.fcolor);
});
} // color end
});
$.fn.color.defaults = { bcolor: "white", fcolor: "black" };
})(jQuery);
有兩個細節值得說明。第一,$.extend 的第一個參數改成空物件 {},而不是預設物件本身。若直接把 defaults 當第一個參數,extend 會就地修改它,使用者的參數就會永久污染預設值,影響到之後所有呼叫。第二,defaults 掛在 $.fn.color 上,形成外掛自己的命名空間,不會與其他外掛撞名。
抽出 defaults 之後,使用者多了一個選項:可以直接改預設值,而不必每次呼叫都傳參。
// 寫在外面:改全域預設
$.fn.color.defaults = { bcolor: "#c06", fcolor: "red" };
$('h1').color();
// 寫在括號裡:只影響這一次呼叫
$('p').color({ bcolor: "#fff" });
第二行的效果是「只覆蓋文字色為白色,背景沿用預設」,因為 $.extend 只覆寫提供的屬性,其餘保留。這種「全域預設 + 單次覆寫」的兩層設計,幾乎是所有成熟外掛的共通做法,你可以在 jQuery 官方外掛、jQuery UI 的 $.fn.widget.defaults 裡看到同樣的結構。
把 defaults 攤在陽光下有三個好處。一是可探索:使用者不必翻原始碼,在 console 打一行 $.fn.color.defaults 就知道有哪些參數、預設值是什麼。二是可批次調整:一個頁面裡有二十處呼叫同一外掛時,改預設比重跑二十次傳參容易得多。三是可擴充:別的外掛或後續初始化程式可以在中央位置統一調整外掛行為,形成約定。
關於外掛學習就先寫到這裡。網路上這類教學很多,但多半停在「怎麼讓它動」,很少談「怎麼讓它好維護」。希望這六節至少把後者交代清楚一些。