想把常用的功能重複利用,撰寫成 jQuery 外掛是最理想的做法。本文從最基礎的概念談起,再逐步帶出開發 jQuery 外掛時的標準結構與注意事項。
用 jQuery 寫外掛,最關鍵的就是以下兩個方法:
$.extend(object) —— 可理解為替 jQuery 新增一個靜態方法。
$.fn.extend(object) —— 可理解為替 jQuery 的實例新增一個方法。
基本的定義與呼叫方式如下:
/* $.extend 定義與呼叫 */
$.extend({ fun1: function () { alert("執行方法一"); } });
$.fun1();
/* $.fn.extend 定義與呼叫 */
$.fn.extend({ fun2: function () { alert("執行方法2"); } });
$(this).fun2();
//等同於
$.fn.fun3 = function () { alert("執行方法三"); }
$(this).fun3();
jQuery(function () { }); 與 (function ($) { })(jQuery); 看起來相似,用途卻不同:
jQuery(function () { });
//相當於
$(document).ready(function () { });
//
(function ($) { })(jQuery);
//相當於
var fn = function ($) { };
fn(jQuery);
前者是在某個 DOM 元素載入完畢後執行程式碼;後者則是定義了一個匿名函數,並把 jQuery 當作實參傳入。這種寫法常用於外掛開發,主要目的是建立外掛的私有作用域。
開發外掛時,第一步就是要把程式碼放在一個不受外界干擾的地方,也就是所謂的私有作用域。外部程式碼無法直接存取外掛內部,內部程式碼也不會污染全域變數,某種程度上達到了與執行環境的解耦:
(function ($) {
})(jQuery);
寫到這裡,其實一個最簡單的 jQuery 外掛雛形就完成了,之後就能用 $("#domName").easySlider({}) 等方式來呼叫。
一個好的外掛應該像 .NET 的 TextBox 控制項一樣,擁有靈活的屬性並提供合理的預設值。當使用者未指定屬性時,就採用外掛內建的預設值。在 jQuery 中,這可以分兩步完成:
//step01 定義 jQuery 的作用域
(function ($) {
//step03-a 外掛的預設值屬性
var defaults = {
prevId: 'prevBtn',
prevText: 'Previous',
nextId: 'nextBtn',
nextText: 'Next'
};
//step02 外掛的擴充方法名稱
$.fn.easySlider = function (options) {
//step03-b 合併使用者自訂屬性與預設屬性
var options = $.extend(defaults, options);
}
})(jQuery);
這裡建議統一用 defaults 變數來代表預設屬性,別為了與眾不同而取名 default01、default02,那樣只會讓程式碼越來越難讀。至於 var options = $.extend(defaults, options) 這行的含義,可以透過以下範例實際比對 a、b、c、d 的值來理解——它代表使用者設定的值會覆蓋外掛預設值,若使用者沒有設定某屬性,則保留預設值。
選擇器是 jQuery 的一大特色,如果外掛不支援它,就少了幾分彈性。要讓外掛支援多個選擇器,可以這樣寫:
//step4 支援 jQuery 選擇器
this.each(function () {
});
要達到鏈式呼叫的效果,必須把 each 的結果 return 出去:
//step5 支援鏈式呼叫
return this.each(function () {
});
如此一來,就能寫出這樣優雅的呼叫方式:
$(".div").easySlider({prevId:"",prevText:""}).css({ "border-width": "1", "border-color": "red" });
當外掛功能龐大、程式碼動輒數百上千行時,就需要用 function 把邏輯結構化。在外掛內部定義的方法外界無法直接呼叫,也不會污染全域環境,有點類似 C# 類別中的私有方法:
//step06-a 在外掛裡定義方法
var showLink = function (obj) {
$(obj).append(function () { return "(" + $(obj).attr("href") + ")" });
}
//step06-b 在外掛裡呼叫方法
return this.each(function () {
showLink(this);
});
透過這套結構,一個功能完整、易於維護的 jQuery 外掛就成形了。