我當初選 jQuery,最看重的就是「write less, do more」這句口號。寫程式久了會有個習慣:回頭翻自己幾個月前的程式碼,看看哪裡還能再精簡一點。這個動作一是逼自己持續學,二是把新想法回灌進舊專案。
關於 jQuery 插件的寫法網上已經有很多討論,這裡只把兩種最常見的骨架整理成可複用的模板:一種是掛在 jQuery 物件上的「插件」(需要操作對象),另一種是掛在 jQuery 命名空間上的「擴充函式」(也就是所謂的 API 函式)。兩者都用匿名函式包起來,順便把 $ 傳進去,避免與其他庫的 $ 衝突。
<script type="text/javascript" src="jquery-1.4.2.js"></script>
掛在 $.fn 上的方法,呼叫時會有一個 jQuery 物件作為 this,因此可以直接鏈式呼叫。
<script type="text/javascript">
;(function($) {
// PI_ 前綴用來避免與其他插件命名衝突
$.fn.PI_TestPlugIn = {
// 插件本身的資訊,方便日後維護與除錯
Info: {
Name: "TestPlugIn",
Ver: "1.0.0.0",
Corp: "Lzhdim",
Author: "lzhdim",
Date: "2010-01-01 08:00:00",
Copyright: "Copyright @ 2000-2010 Lzhdim Technology Software All Rights Reserved",
License: "GPL"
},
// 參數為物件的函式
FunctionWithParams: function(paramObj) {
var params = paramObj ? paramObj : {
param1: "1",
param2: "2"
};
return this.Info.Name + ".FunctionWithParamObject";
},
// 參數為單一變數的函式
FunctionWithParam: function(varparam) {
var param = varparam ? varparam : null;
return this.Info.Name + ".FunctionWithParam";
},
// 無參數的函式
FunctionWithOutParam: function() {
return this.Info.Name + ".FunctionWithOutParam";
}
};
})(jQuery);
</script>
用 $.extend 掛上去的,是全域可用的工具函式,呼叫形式為 $.yourNamespace.method()。
<script type="text/javascript">
;(function($) {
$.extend({
PIF_TestExtendFunction: {
Info: {
Name: "TestExtendFunction",
Ver: "1.0.0.0",
Corp: "Lzhdim",
Author: "lzhdim",
Date: "2010-01-01 08:00:00",
Copyright: "Copyright @ 2000-2010 Lzhdim Technology Software All Rights Reserved",
License: "GPL"
},
FunctionWithParams: function(paramObj) {
var params = paramObj ? paramObj : {
param1: "1",
param2: "2"
};
return this.Info.Name + ".FunctionWithParamObject";
},
FunctionWithParam: function(varparam) {
var param = varparam ? varparam : null;
return this.Info.Name + ".FunctionWithParam";
},
FunctionWithOutParam: function() {
return this.Info.Name + ".FunctionWithOutParam";
}
}
});
})(jQuery);
</script>
$(function() {
var params = { param1: "3", param2: "4" };
alert($(this).PI_TestPlugIn.FunctionWithParams(params));
alert($.PIF_TestExtendFunction.FunctionWithOutParam());
});
匿名函式包一層的目的不只是「看起來專業」,而是讓内部的暫存變數不污染全域;把 jQuery 當參數傳進去,則是為了在 this 被別人改掉時仍然安全。
另外,上面範例把 Info 放在物件裡,是一個很實用的習慣:版本資訊跟程式碼放在一起,後接手的人不必翻文件也能知道這支插件從哪來、授權是什麼。
最後,若要開放到 this.limit() 這類「插件自己再長出方法」的用法,直接在 this 上掛函式即可,並記得回傳 this 以維持鏈式呼叫:
this.myfn = function(){ /* ... */ return this; };