不定義JQuery插件,不要說(shuō)會(huì)JQuery,為什么這么說(shuō),請(qǐng)看下文
一、導(dǎo)言
有些WEB開(kāi)發(fā)者,會(huì)引用一個(gè)JQuery類庫(kù),然后在網(wǎng)頁(yè)上寫一寫("#"),("#"),("."),寫了幾年就對(duì)別人說(shuō)非常熟悉JQuery。我曾經(jīng)也是這樣的人,直到有一次公司里的技術(shù)交流,我才改變了自己對(duì)自己的看法。
二、普及JQuery知識(shí)
知識(shí)1:用JQuery寫插件時(shí),最核心的方法有如下兩個(gè):
$.extend(object) 可以理解為JQuery 添加一個(gè)靜態(tài)方法。
$.fn.extend(object) 可以理解為JQuery實(shí)例添加一個(gè)方法。
基本的定義與調(diào)用:
/* $.extend 定義與調(diào)用
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
$.extend({ fun1: function () { alert("執(zhí)行方法一"); } });
$.fun1();
/* $.fn.extend 定義與調(diào)用
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
$.fn.extend({ fun2: function () { alert("執(zhí)行方法2"); } });
$(this).fun2();
//等同于
$.fn.fun3 = function () { alert("執(zhí)行方法三"); }
$(this).fun3();
知識(shí)2:jQuery(function () { }); 與 (function ($) { })(jQuery);的區(qū)別:
jQuery(function () { });
//相當(dāng)于
$(document).ready(function () { });
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
(function ($) { })(jQuery);
//相當(dāng)于
var fn = function ($) { };
fn(jQuery);
jQuery(function () { });是某個(gè)DOM元素加載完畢后執(zhí)行方法里的代碼。
(function ($) { })(jQuery); 定義了一個(gè)匿名函數(shù),其中jQuery代表這個(gè)匿名函數(shù)的實(shí)參。通常用在JQuery插件開(kāi)發(fā)中,起到了定義插件的私有域的作用。
三、開(kāi)發(fā)JQuery插件標(biāo)準(zhǔn)結(jié)構(gòu)
1、定義作用域:定義一個(gè)JQuery插件,首先要把這個(gè)插件的代碼放在一個(gè)不受外界干擾的地方。如果用專業(yè)些的話來(lái)說(shuō)就是要為這個(gè)插件定義私有作用域。外部的代碼不能直接訪問(wèn)插件內(nèi)部的代碼。插件內(nèi)部的代碼不污染全局變量。在一定的作用上解耦了插件與運(yùn)行環(huán)境的依賴。說(shuō)了這么多,那要怎樣定義一個(gè)插件的私有作用域?
//step01 定義JQuery的作用域
(function ($) {
})(jQuery);
別小看了這個(gè)作用域,就像c#定義一個(gè)類的class關(guān)鍵字一樣重要。
2、為JQuery擴(kuò)展一個(gè)插件:當(dāng)定義好了JQuery的作用域后,最核心也是最迫切的一步就是為這個(gè)JQuery的實(shí)例添加一個(gè)擴(kuò)展方法。首先我們?yōu)檫@個(gè)Jqury插件命名一個(gè)方法,叫easySlider,當(dāng)在調(diào)用這個(gè)插件的時(shí)候,我們可以通過(guò)options來(lái)給這個(gè)插件傳遞一些參數(shù)。具體的定義方法看如下代碼:
//step01 定義JQuery的作用域
(function ($) {
//step02 插件的擴(kuò)展方法名稱
$.fn.easySlider = function (options) {
}
})(jQuery);
到現(xiàn)在為止,其實(shí)一個(gè)最簡(jiǎn)單的JQuery插件就已經(jīng)完成了。調(diào)用的時(shí)候可以("#domName").easySlider({}),或者("#domName").easySlider({}),或者(".domName").easySlider({})或者更多的方式來(lái)調(diào)用這個(gè)插件。
3、設(shè)置默認(rèn)值:定義一個(gè)JQuery插件,就像定義一個(gè).net控件。一個(gè)完美的插件,應(yīng)該是有比較靈活的屬性。我們來(lái)看這段代碼:<asp:TextBox ID="TextBox1" Width="20" Height="100" runat="server"></asp:TextBox>。 TextBox控件有Width和Height屬性,用戶在用TextBox時(shí),可以自由的設(shè)置控件的Height和Width,也可以不設(shè)置值,因?yàn)榭丶陨碛心J(rèn)值。那準(zhǔn)備開(kāi)發(fā)一個(gè)JQuery插件時(shí),在用戶未指定屬性時(shí),應(yīng)該有默認(rèn)值,在JQuery可以分兩步實(shí)現(xiàn)這樣的定義,看如下代碼step03-a,step03-b。
//step01 定義JQuery的作用域
(function ($) {
//step03-a 插件的默認(rèn)值屬性
var defaults = {
prevId: 'prevBtn',
prevText: 'Previous',
nextId: 'nextBtn',
nextText: 'Next'
//……
};
//step02 插件的擴(kuò)展方法名稱
$.fn.easySlider = function (options) {
//step03-b 合并用戶自定義屬性,默認(rèn)屬性
var options = $.extend(defaults, options);
}
})(jQuery);
做程序的人都喜歡創(chuàng)新,改改變量名呀,換一個(gè)行呀這些。當(dāng)看到用var defaults = {}來(lái)表示一個(gè)默認(rèn)屬性時(shí),在自己寫JQuery插件時(shí)就想著與眾不同,所以用var default01 ={} ,var default02 ={}來(lái)表示默認(rèn)屬性了。然后默認(rèn)屬性名五花八門,越來(lái)越糟。所以建議在寫JQuery插件時(shí),定義默認(rèn)屬性時(shí),都用defaults變量來(lái)代表默認(rèn)屬性,這樣的代碼更具有可讀性。
有人看到這行代碼:var options = $.extend(defaults, options),皺起眉頭,表示不解。那我們先來(lái)看如下代碼:
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);
把代碼拷貝到開(kāi)發(fā)環(huán)境中,分別看一下a,b,c,d的值,就明白了var options = $.extend(defaults, options)的含義了。表示 options 去覆蓋了defaults的值,并把值賦給了options。
在插件環(huán)境中,就表示用戶設(shè)置的值,覆蓋了插件的默認(rèn)值;如果用戶沒(méi)有設(shè)置默認(rèn)值的屬性,還是保留插件的默認(rèn)值。
4、支持JQuery選擇器:JQuery選擇器,是JQuery的一個(gè)優(yōu)秀特性,如果我們的插件寫來(lái)不支持JQuery選擇器,確實(shí)是一個(gè)不小的遺憾。如了使自己的JQuery插件能支持多個(gè)選擇器,我們的代碼應(yīng)該這樣定義:
//step01 定義JQuery的作用域
(function ($) {
//step03-a 插件的默認(rèn)值屬性
var defaults = {
prevId: 'prevBtn',
prevText: 'Previous',
nextId: 'nextBtn',
nextText: 'Next'
//……
};
//step02 插件的擴(kuò)展方法名稱
$.fn.easySlider = function (options) {
//step03-b 合并用戶自定義屬性,默認(rèn)屬性
var options = $.extend(defaults, options);
//step4 支持JQuery選擇器
this.each(function () {
});
}
})(jQuery);
5、支持JQuery的鏈接調(diào)用:上邊的代碼看似完美了,其實(shí)也不那么完美。到目前為止還不支持鏈接調(diào)用。為了能達(dá)到鏈接調(diào)用的效果必須要把循環(huán)的每個(gè)元素return
//step01 定義JQuery的作用域
(function ($) {
//step03-a 插件的默認(rèn)值屬性
var defaults = {
prevId: 'prevBtn',
prevText: 'Previous',
nextId: 'nextBtn',
nextText: 'Next'
//……
};
//step02 插件的擴(kuò)展方法名稱
$.fn.easySlider = function (options) {
//step03-b 合并用戶自定義屬性,默認(rèn)屬性
var options = $.extend(defaults, options);
//step4 支持JQuery選擇器
//step5 支持鏈?zhǔn)秸{(diào)用
return this.each(function () {
});
}
})(jQuery);
這樣的定義才能支持鏈接調(diào)用。比如支持這樣的調(diào)用:$(".div").easySlider({prevId:"",prevText:""}).css({ "border-width": "1", "border-color": "red", "border-bottom-style": "dotted" });
6、插件里的方法:往往實(shí)現(xiàn)一個(gè)插件的功能需要大量的代碼,有可能上百行,上千行,甚至上萬(wàn)行。我們把這代碼結(jié)構(gòu)化,還得借助function。在第一點(diǎn)已經(jīng)說(shuō)了,在插件里定義的方法,外界不能直接調(diào)用,我在插件里定義的方法也沒(méi)有污染外界環(huán)境?,F(xiàn)在就嘗試著怎么樣在插件里定義一些方法:
//step01 定義JQuery的作用域
(function ($) {
//step03-a 插件的默認(rèn)值屬性
var defaults = {
prevId: 'prevBtn',
prevText: 'Previous',
nextId: 'nextBtn',
nextText: 'Next'
//……
};
//step06-a 在插件里定義方法
var showLink = function (obj) {
$(obj).append(function () { return "(" + $(obj).attr("href") + ")" });
}
//step02 插件的擴(kuò)展方法名稱
$.fn.easySlider = function (options) {
//step03-b 合并用戶自定義屬性,默認(rèn)屬性
var options = $.extend(defaults, options);
//step4 支持JQuery選擇器
//step5 支持鏈?zhǔn)秸{(diào)用
return this.each(function () {
//step06-b 在插件里定義方法
showLink(this);
});
}
})(jQuery);
步驟step06-a:在插件里定義了一個(gè)方法叫showLink(); 這個(gè)方法在插件外是不能直接調(diào)用的,有點(diǎn)像C#類里的一個(gè)私有方法,只能滿足插件內(nèi)部的使用。步驟step06-b演示了怎樣調(diào)用插件內(nèi)部的方法。
四、總結(jié)
開(kāi)發(fā)只要形成了標(biāo)準(zhǔn),然后再去閱讀別人的代碼就沒(méi)有那么吃力了。