一、導言
有些WEB開發者,會引用一個JQuery類別庫,然後在網頁上寫一寫("#"),("#"),("."),寫了幾年就對別人說非常熟悉JQuery。我曾經也是這樣的人,直到有一次公司裡的技術交流,我才改變了自己對自己的看法。
二、普及JQuery知識
知識1:用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();
知識2:jQuery(function () { }); 與 (function ($) { })(jQuery);的差別:
jQuery(function () { }); //相当于 $(document).ready(function () { }); /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ (function ($) { })(jQuery); //相当于 var fn = function ($) { }; fn(jQuery);
jQuery(function () { });是某個DOM元素載入完畢後執行方法裡的程式碼。
(function ($) { })(jQuery); 定義了一個匿名函數,其中jQuery代表這個匿名函數的實參。通常用在JQuery插件開發中,就起到了定義插件的私有域的作用。
三、開發JQuery插件標準結構
1、定義作用域:定義一個JQuery插件,首先要把這個插件的程式碼放在一個不受外界幹擾的地方。如果用專業些的話來說就是要為這個外掛定義私有作用域。外部的程式碼不能直接存取插件內部的程式碼。插件內部的程式碼不污染全域變數。在一定的作用上解耦了插件與運行環境的依賴。說了這麼多,那要怎麼定義一個外掛的私有作用域?
//step01 定义JQuery的作用域 (function ($) { })(jQuery);
別小看了這個作用域,就像c#定義一個類別的class關鍵字一樣重要。
2、為JQuery擴充一個外掛:當定義好了JQuery的作用域後,最核心也是最迫切的一步就是為這個JQuery的實例加入一個擴充方法。首先我們為這個Jqury插件命名一個方法,叫easySlider,當在呼叫這個插件的時候,我們可以透過options來給這個插件傳遞一些參數。具體的定義方法看如下程式碼:
//step01 定义JQuery的作用域 (function ($) { //step02 插件的扩展方法名称 $.fn.easySlider = function (options) { } })(jQuery);
到現在為止,其實一個最簡單的JQuery插件就已經完成了。呼叫的時候可以("#domName").easySlider({}),或("#domName").easySlider({}),或(".domName").easySlider({})或更多的方式來呼叫這個插件。
3、設定預設值:定義一個JQuery插件,就像定義一個.net控制項。完美的插件,應該是有比較靈活的屬性。讓我們來看看這段程式碼:
//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);
做程序的人都喜歡創新,改改變量名呀,換一個行呀這些。當看到用var defaults = {}來表示一個預設屬性時,在自己寫JQuery插件時就想著與眾不同,所以用var default01 ={} ,var default02 ={}來表示預設屬性了。然後預設屬性名五花八門,越來越糟。所以建議在寫JQuery插件時,定義預設屬性時,都用defaults變數來代表預設屬性,這樣的程式碼比較具有可讀性。
有人看到這行程式碼:var options = $.extend(defaults, options),皺起眉頭,表示不解。那我們先來看如下程式碼:
var obj01 = { name: "英文名:Sam Xiao", age: 29, girlfriend: { name: "Yang", age: 29} } var obj02 = { name: "中文名:XiaoJian", girlfriend: { name: "YY"} }; var a = $.extend(obj01, obj02); var b = $.extend(true, obj01, obj02); var c = $.extend({}, obj01, obj02);
把程式碼拷貝到開發環境中,分別看一下a,b,c,d的值,就明白了var options = $.extend(defaults, options)的意思了。表示 options 去覆寫了defaults的值,並把值賦給了options。
在插件環境中,就表示使用者設定的值,覆蓋了插件的預設值;如果使用者沒有設定預設值的屬性,還是保留插件的預設值。
4、支援JQuery選擇器:JQuery選擇器,是JQuery的優秀特性,如果我們的插件寫來不支援JQuery選擇器,確實是一個不小的遺憾。如了讓自己的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); //step4 支持JQuery选择器 this.each(function () { }); } })(jQuery);
5.支援JQuery的連結呼叫:上邊的程式碼看似完美了,其實也不那麼完美。到目前為止還不支援連結呼叫。為了能達到連結呼叫的效果必須要把循環的每個元素return
//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); //step4 支持JQuery选择器 //step5 支持链式调用 return this.each(function () { }); } })(jQuery);
这样的定义才能支持链接调用。比如支持这样的调用:$(".div").easySlider({prevId:"",prevText:""}).css({ "border-width": "1", "border-color": "red", "border-bottom-style": "dotted" });
6、插件里的方法:往往实现一个插件的功能需要大量的代码,有可能上百行,上千行,甚至上万行。我们把这代码结构化,还得借助function。在第一点已经说了,在插件里定义的方法,外界不能直接调用,我在插件里定义的方法也没有污染外界环境。现在就尝试着怎么样在插件里定义一些方法:
//step01 定义JQuery的作用域 (function ($) { //step03-a 插件的默认值属性 var defaults = { prevId: 'prevBtn', prevText: 'Previous', nextId: 'nextBtn', nextText: 'Next' //…… }; //step06-a 在插件里定义方法 var showLink = function (obj) { $(obj).append(function () { return "(" + $(obj).attr("href") + ")" }); } //step02 插件的扩展方法名称 $.fn.easySlider = function (options) { //step03-b 合并用户自定义属性,默认属性 var options = $.extend(defaults, options); //step4 支持JQuery选择器 //step5 支持链式调用 return this.each(function () { //step06-b 在插件里定义方法 showLink(this); }); } })(jQuery);
步骤step06-a:在插件里定义了一个方法叫showLink(); 这个方法在插件外是不能直接调用的,有点像C#类里的一个私有方法,只能满足插件内部的使用。步骤step06-b演示了怎样调用插件内部的方法。
四、总结
开发只要形成了标准,然后再去阅读别人的代码就没有那么吃力了。