前面寫的都是片段。要對外發布,外掛還需要封裝與規範——唯有如此,它才可能被別人信任、被用在正式專案裡。這一節把之前零散的概念組裝成一個完整外掛。
(function($){
// 自定義外掛程式碼
})(jQuery) // 封裝外掛
這一行是整個封裝的核心。它把外掛包在一個匿名函式中並立即執行,同時把 jQuery 當成參數 $ 傳進去。效果是:函式內部的變數與函式都不會外洩到全域,而我們依然能在裡面自由地用 $,不必擔心 noConflict 的衝突。
接著要判斷這個外掛屬於哪一類。以「設定元素字體顏色」為例,它顯然需要作用於選中的元素,所以應該建立 jQuery 物件方法;再考慮到 jQuery 提供了 extend() 這個規範的擴充入口,用它來掛載會比直接賦值更一致:
(function($){
$.extend($.fn, {
// 物件方法在這裡宣告
});
})(jQuery)
幾乎每個外掛都會接受參數。顏色外掛應該讓使用者自訂色彩,同時在沒有傳值時保有合理預設:
(function($){
$.extend($.fn, {
color : function(options){
var options = $.extend({ bcolor: "white", fcolor: "black" }, options);
// 主體
}
});
})(jQuery)
順帶一提,這段範例的參數命名其實容易誤導:bcolor 拿來設 color、fcolor 拿來設 background,字面上恰好相反。實戰時建議命名與用途一致(例如 textColor/bgColor),省下後來維護者的困惑。
;(function($){
$.extend($.fn, {
color : function(options){
var options = $.extend({ bcolor: "white", fcolor: "black" }, options);
return this.each(function(){
$(this).css("color", options.bcolor);
$(this).css("background", options.fcolor);
});
} // color end
});
})(jQuery);
注意最前面多了一個分號。這是防禦性寫法:由於其他檔案可能省略結尾分號,若我們的檔案以 ( 開頭,瀏覽器可能把它跟前一段程式碼接成一次函式呼叫,導致莫名的語法錯誤。加上分號,成本一個字元,卻能避免極難追的 bug。
$("h1").color({ bcolor: "#ccc", fcolor: "#eee" });
$('a').color("#fff");
第二行傳入的是字串而非物件,這在目前的實作下不會生效——$.extend 會把它當成來源物件處理,結果什麼也沒覆蓋,顏色仍是預設。若想支援這種簡寫,得在函式開頭加一段型別判斷。這也提醒我們:外掛的「寬容度」需要刻意設計,不會自己出現。