寫 jQuery 外掛(plugin)其實只有兩條路:掛在 jQuery 命名空間下的全域函式(也就是靜態方法),或是掛在 jQuery 原型上的方法——後者才是我們平常寫的 $("selector").xxx(),因為每個透過選取器取得的 jQuery 實例都能共用它。
一、兩種擴充方式
1、$.extend(object)——擴充 jQuery 本身
概念上有點像 .NET 的擴充方法,掛上去之後用 $. 呼叫:
$(function(){
$.extend({
fun1: function () { alert("為 jQuery 擴充一個 fun1 函式!"); }
});
$.fun1();
})
2、$.fn.extend(object)——擴充 jQuery 實例
$.fn.extend({
fun2: function () { alert("執行方法 2"); }
});
$("#id1").fun2();
底下這種逐個指派寫法效果完全相同:
$.fn.fun2 = function () { alert("執行方法 2"); }
$(this).fun2();
二、私有作用域
寫外掛時強烈建議用 IIFE 把整段程式碼包起來,避免污染全域:
(function ($) { })(jQuery); // 等同 var fn = function (xxoo) { }; fn(jQuery);
傳入的 jQuery 之後在內部以 $ 使用,就算別的函式庫也佔用了 $ 也不會衝突。
三、開發外掛的六個步驟
步驟 1|定義私有作用域
(function ($) { })(jQuery);
外部程式碼無法直接存取外掛內部,內部也不會干擾外部。
步驟 2|掛到 jQuery 上
(function ($) {
$.fn.MyFrame = function (options) { }
})(jQuery);
步驟 3|加上預設值並合併使用者設定
(function ($) {
var defaults = { Id: '#id1' };
$.fn.MyFrame = function (options) {
var options = $.extend(defaults, options); // options 為空時沿用 defaults
}
})(jQuery);
步驟 4|支援 jQuery 選取器
用 this.each() 遍歷選到的每一個元素,外掛才能用在多元素上:
(function ($) {
var defaults = { Id: '#id1' };
$.fn.MyFrame = function (options) {
var options = $.extend(defaults, options);
return this.each(function () { });
}
})(jQuery);
步驟 5|支援鏈式調用
關鍵字是 return this。上面那段的 return this.each(...) 已經同時滿足步驟 4 與步驟 5,所以 $("#a").MyFrame().css(...) 這種寫法才不會中斷。
步驟 6|在內部定義私有函式
(function ($) {
var defaults = { Id: '#id1' };
var MyFun = function (obj) { alert(obj); } // 僅外掛內部可用
$.fn.MyFrame = function (options) {
var options = $.extend(defaults, options);
return this.each(function () {
MyFun(this);
});
}
})(jQuery);
因為作用域的關係,MyFun 只有外掛內部呼叫得到,外部完全看不到,這正是私有作用域想達到的效果。
兩個實務提醒
其一,$.extend(defaults, options) 會直接改動 defaults 物件。若外掛會被同一頁面多次初始化,改用 $.extend({}, defaults, options) 更安全,能避免上一次的設定被帶進下一次。
其二,步驟 3 到 5 的順序其實可以合併,但觀念上要分清楚:defaults 是設定、each 是遍歷、return this 是鏈式。釐清這三件事,之後要擴充功能就不容易亂。
以上就是 jQuery 外掛開發的完整流程整理,掌握私有作用域加上鏈式返回這兩個核心,寫出來的外掛就會既安全又好用了。