在開發過許多 jQuery 外掛之後,我逐漸摸索出一套比較標準的結構與模式。這樣就能複用大部分程式碼骨架,只需專注最主要的邏輯即可。採用相同的設計模式與架構,也讓修復 bug 或二次開發更容易,不論外掛簡單或複雜,一套經過驗證的架構都能保證外掛不犯大錯。
以下是我總結的 10 條經驗。
這是最常用的一條。你的外掛程式碼只為自己的外掛服務,所以可以全部放在閉包裡面:
(function($)
{
//code here
})(jQuery);
外掛應該有一些可讓開發者設定的選項,因此提供預設值是必要的。可透過 jQuery 的 extend 功能來設定:
var defaultSettings = {
mode : 'Pencil',
lineWidthMin : '0',
lineWidthMax : '10',
lineWidth : '2'
};
settings = $.extend({}, defaultSettings, settings || {});
JavaScript/jQuery 有個很好的特性就是可以進行方法級聯,所以不應破壞它,始終在方法中回傳一個元素:
$.fn.wPaint = function(settings)
{
return this.each(function()
{
var elem = $(this);
//run some code here
})
}
如果某段程式碼(例如一堆預設值)只需被實例化一次,而不是每次呼叫外掛功能時都實例化,就應該把它放在外掛方法的外面,這樣可以讓外掛運行更有效率、更省記憶體。
作為程式碼的血肉,方法與函式應該放在 prototype 函式內,原因有兩個:一是節省記憶體,不用重複建立這些方法;二是引用現成的方法比重新建立快得多。
設定 prototype 方法有兩個部分。首先建立最初的類定義(多數情況下就是建立一個物件),這個定義包含每個物件實例都不同的部分:
function Canvas(settings)
{
this.settings = settings;
this.draw = false;
this.canvas = null;
this.ctx = null;
return this;
}
接著加上全域方法:
Canvas.prototype =
{
generate: function()
{
//generate code
}
}
關鍵在於讓 prototype 的方法是通用的,而資料是每個實例自己的,可用 this 引用。
透過 $this,我們可以向其他閉包傳遞正確的引用。需要注意的是,$this 這個名稱是可以任意替換的:
Canvas.prototype =
{
generate: function()
{
var $this = this;
var buton = //…some code
button.click(function(){
$this.someFunc($this);
});
},
someFunc: function($this)
{
//use $this instead passed from the click event
}
}
我會在每個物件中保存自己的設定並操作它,這樣就不用在不同方法間傳遞大量參數,也方便在其他地方調用:
function Canvas(settings)
{
this.settings = settings;
return this;
}
當你在猶豫是否需要提供某個方法時,可以問自己:「如果其他人要重寫這個方法,你的程式碼能否滿足需求?」或「別人來寫這個方法有多困難?」例如 Color Picker 外掛的方法可以拆成 generate()、appendColors()、colorSelect()、showPalette()、hidePalette() 等。
這條並非必須,但只需一點點程式碼,就能為使用者提供一個可能需要的功能,讓開發者能設定或獲取元素已有的值:
var lineWidth = $("#container").wPaint("lineWidth");
$("#container").wPaint("lineWidth", "5");
以上十條基本涵蓋了 jQuery 外掛開發的核心,可以作為開發的模板。有一套基本的程式碼骨架,能大幅縮短開發時間,並讓你在設計外掛架構時更有信心。