我們日常使用的眾多插件並非憑空出現,而是由開發者編寫、測試並完善後,奉獻給整個 jQuery 社區的成果,且大多免費。本文重點不在於插件本身,而在於教你如何回饋這個社區:編寫自己的插件並上傳到 jQuery 插件頁面,讓所有人都能使用。
實際動手後你會發現,插件的創建過程與框架都相當簡單明瞭,真正的難點在於想出一個別人還沒做過、又能切實解決問題的點子。正因為結構簡單、對新手友好、對高手夠靈活,插件數量才會急劇增長。此外,每位作者的風格各異,jQuery 也允許幾種不同的編寫風格,本文聚焦其中最簡單、也是官方推薦的一種。
第一步當然是找個好點子。以本文的 NumberFormatter 插件為例,它並不新穎,但當時社區裡確實還沒有。做服務器端開發或處理國際化的人應該都熟悉數字格式化——並非所有國家都用相同方式書寫數字。例如同一個數字,美國寫作「1,250,500.75」,德國寫作「1.250.500,75」,法國寫作「1 250 500,75」,瑞士寫作「1'250'500.75」,日本寫作「125,0500.75」。
於是問題歸結為:編寫國際化應用時,如何向不同國家的用戶展示同一批數字?常見解法是在服務端格式化,但很多時候數字並不在服務器上,就需要一種能在客戶端本地完成格式化、無需與服務器來回通信的方案。典型的用例是:用戶在薪水輸入框裡可能輸入「$65000」「65,000」「65000」「65,000.00」等多種格式,我們需要統一控制其顯示方式,並提供即時反饋。NumberFormatter 正是為填補這一空缺而生,同時還支持反向的解析操作,並模仿 Java DecimalFormatter 的功能以保持前後一致。
jQuery 團隊制定了一系列希望插件作者共同遵守的通用規則,以營造統一可信的環境:
這些規則看似瑣碎,卻直接決定插件能否被廣泛採用。遵守它們不僅能保證代碼統一,還能大大提高插件的成功率。
開始編碼前,先要決定插件是「方法」還是「函數」。方法附加到 jQuery.fn,可接收任意選擇器並對選中元素逐一處理,靈活性更高;函數附加到 jQuery 對象,不接收選定元素,適用於操作整個頁面。由於格式化需要用戶指明處理哪些元素,這裡應採用方法形式。
// 方法定義
jQuery.fn.format = function() {};
// 調用:$("#myText").format();
由於涉及國際化,插件需接收兩個選項:數字格式(如 #,### 或 #,###.00)與語言環境(2 字符國家碼)。同時要提供合理默認值,方便用戶在不想傳參時直接調用:
jQuery.fn.format = function(options) {
var options = jQuery.extend(={
format: "#,###.00",
locale: "us"
}, options);
再通過 this.each() 迭代選中元素並返回 jQuery 對象:
return this.each(function(){
// 迭代中可用 jQuery(this) 引用當前元素
// 其餘插件邏輯寫在這裡
});
調優 #1 — 讓內部方法私有化。借助 Closure 結構,可把僅供內部調用的函數私有化,只把需要對外的方法掛到 jQuery 對象上:
(function(jQuery) {
function formatCodes(locale) { /* 私有函數 */ };
jQuery.fn.format = function(options) {
var options = jQuery.extend({}, {
format: "#,###.00",
locale: "us"
}, options);
return this.each(function(){
var formatData = formatCodes(options.locale.toLowerCase());
});
};
})(jQuery);
調優 #2 — 讓默認值可被覆蓋。把默認值定義為對象屬性,用戶便能在一處集中修改,而不必在每次調用時傳參:
var options = jQuery.extend({}, jQuery.fn.format.defaults, options);
// ...
jQuery.fn.format.defaults = {
format: "#,###.00",
locale: "us"
};
如此一來,德國開發者只需寫 $.fn.format.defaults.locale = "de"; 就能讓整站的數字都按德文格式展示。
最後一步是全面測試。用戶一旦发现 bug 往往不會去修,而是直接棄用,幾條差評就足以讓插件石沉大海。作者搭建了一個簡單的測試結構,把「數字 + 正確格式」成對列出,逐個調用格式化並比對結果,失敗標紅,方便覆蓋各種格式用例。
測試通過後,即可上傳到 jQuery 官方插件庫:註冊賬號、驗證、點擊 Add plug-in,寫好標題與描述,並提供插件主頁(可用 Google Code 免費託管開源項目),提交後你的插件就正式成為社區的一員了。
最後補充一個與插件無直接關係、但實戰中常見的問題:如何獲取用戶的語言環境?目前 JavaScript 尚無直接手段,需要通過「JavaScript Bridge」把服務端的值傳入前端。例如在 JSP 中讀取請求頭的 Accept-Language,解析出國家碼後,再動態賦值給 $.fn.format.defaults.locale,即可讓頁面按用戶實際語言環境呈現數字。