开发jQuery插件需要掌握什么基本知识点-工具盒子

jQuery插件，在日常的项目中，用的特别多，有时候因为项目紧急，直接套用了官方和某个平台的插件库；对于要求比较高的项目，这样有时候会行不通，因为性能等原因，毕竟是别人的东西。现在的大公司都有自己的一套插件库，比如淘宝、支付宝、腾讯等。

我们知道，开发属于自己的一套插件库需要花更多的时间，一般的小公司可能不想花这样的成本。但是对于Web前端开发这来说，还是需要掌握开发jQuery插件的知识点，毕竟你不可能一直呆在小公司吧，人往高处走嘛。所以今天想分享下开发jQuery插件需要掌握什么基本知识点。

普及JQuery知识 {#content}

知识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({})或者更多的方式来调用这个插件。

2、设置默认值：

定义一个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。
在插件环境中，就表示用户设置的值，覆盖了插件的默认值；如果用户没有设置默认值的属性，还是保留插件的默认值。

3、支持JQuery选择器：

JQuery选择器，是JQuery的一个优秀特性，如果我们的插件写来不支持JQuery选择器，确实是一个不小的遗憾。如了使自己的JQuery插件能支持多个选择器，我们的代码应该这样定义：
{#copybut34557}

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

{#copybut34557}

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

5、插件里的方法：

往往实现一个插件的功能需要大量的代码，有可能上百行，上千行，甚至上万行。我们把这代码结构化，还得借助function。在第一点已经说了，在插件里定义的方法，外界不能直接调用，我在插件里定义的方法也没有污染外界环境。现在就尝试着怎么样在插件里定义一些方法：
{#copybut21335}

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

{#copybut21335}

步骤step06-a：在插件里定义了一个方法叫showLink(); 这个方法在插件外是不能直接调用的，有点像C#类里的一个私有方法，只能满足插件内部的使用。步骤step06-b演示了怎样调用插件内部的方法。