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();

二、jQuery(function () { }); 與 (function ($) { })(jQuery);的區別：

jQuery(function () { });  
//至關於  
$(document).ready(function () { }); 
 
/* * * * * * * * * * * * * * * * * * * * * * */ 
(function ($) { })(jQuery);  
//至關於  
var fn = function ($) { };  
fn(jQuery);

jQuery(function () { });是某個DOM元素加載完畢後執行方法裏的代碼。

(function ($) { })(jQuery); 定義了一個匿名函數，其中jQuery表明這個匿名函數的實參。一般用在JQuery插件開發中，起到了定義插件的私有域的做用。

2、開發JQuery插件標準結構

一、定義做用域：定義一個JQuery插件，首先要把這個插件的代碼放在一個不受外界干擾的地方。若是用專業些的話來講就是要爲這個插件定義私有做用域。外部的代碼不能直接訪問插件內部的代碼。插件內部的代碼不污染全局變量。在必定的做用上解耦了插件與運行環境的依賴。說了這麼多，那要怎樣定義一個插件的私有做用域？

//step01 定義JQuery的做用域  
(function ($) {  
 
})(jQuery);

別小看了這個做用域，就像java定義一個類的class關鍵字同樣重要。

二、爲JQuery擴展一個插件：當定義好了JQuery的做用域後，最核心也是最迫切的一步就是爲這個JQuery的實例添加一個擴展方法。首先咱們爲這個Jqury插件命名一個方法，叫easySlider，當在調用這個插件的時候，咱們能夠經過options來給這個插件傳遞一些參數。具體的定義方法看以下代碼：

//step01 定義JQuery的做用域  
(function ($) {  
    //step02 插件的擴展方法名稱  
    $.fn.easySlider = function (options) {  
          
    }  
})(jQuery);

到如今爲止，其實一個最簡單的JQuery插件就已經完成了。調用的時候能夠$("#domName").easySlider({})，或者$(".domName").easySlider({})或者更多的方式來調用這個插件。

三、設置默認值：定義一個JQuery插件，就像定義一個.net控件。一個完美的插件，應該是有比較靈活的屬性。咱們來看這段代碼：<asp:TextBox ID="TextBox1" Width="20" Height="100" runat="server"></asp:TextBox>。 TextBox控件有Width和Height屬性，用戶在用TextBox時，能夠自由的設置控件的Height和Width，也能夠不設置值，由於控件自身有默認值。那準備開發一個JQuery插件時，在用戶未指定屬性時，應該有默認值，在JQuery能夠分兩步實現這樣的定義,看以下代碼step03-a，step03-b。

//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);

建議在寫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);  
var d = $.extend(true,{}, obj01, obj02);

把代碼拷貝到開發環境中，分別看一下a,b,c,d的值，就明白了var options = $.extend(defaults, options)的含義了。表示 options 去覆蓋了defaults的值，並把值賦給了options。
在插件環境中，就表示用戶設置的值，覆蓋了插件的默認值；若是用戶沒有設置默認值的屬性，仍是保留插件的默認值。

四、支持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);

五、支持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" });

六、插件裏的方法：每每實現一個插件的功能須要大量的代碼，有可能上百行，上千行，甚至上萬行。咱們把這代碼結構化，還得藉助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演示了怎樣調用插件內部的方法。