寫JQuery外掛程式的基本知識

標籤：表示   不同   function   previous   代碼   object   標準   英文   option   

普及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外掛程式，首先要把這個外掛程式的代碼放在一個不受外界幹擾的地方。如果用專業些的話來說就是要為這個外掛程式定義私人範圍。外部的代碼不能直接存取外掛程式內部的代碼。外掛程式內部的代碼不汙染全域變數。在一定的作用上解耦了外掛程式與運行環境的依賴。說了這麼多，那要怎樣定義一個外掛程式的私人範圍？

複製代碼代碼如下:
(function ($) {
})(jQuery);

 

到現在為止，其實一個最簡單的JQuery外掛程式就已經完成了。調用的時候可以$("#domName").easySlider({})，或者$(".domName").easySlider({})或者更多的方式來調用這個外掛程式。

3，設定預設值：定義一個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);

 

做程式的人都喜歡創新，改改變數名呀，換一個行呀這些。當看到用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);
var d = $.extend(true,{}, 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示範了怎樣調用外掛程式內部的方法。

寫JQuery外掛程式的基本知識