如何开发jQuery插件

Posted 随手小记

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了如何开发jQuery插件相关的知识,希望对你有一定的参考价值。

一:普及JQuery知识

知识1:用JQuery写插件时,最核心的方法有如下两个:

  $.extend(object) 可以理解为,为JQuery 类添加一个静态方法。

  $.fn.extend(object) 可以理解为,为JQuery实例添加一个成员函数。

基本的定义与调用:

//$.extend的定义
$.extend({
    pluginName:function(){
        //...
    }
});
//$.extend的调用
$.pluginName();

//$.fn.extend的定义
$.fn.extend({
    pluginName:function(){
        //...
    }
});
//$.fn.extend的调用
$(this).pluginName();

 

知识2:jQuery(function () {}); 与  (function ($) {})(jQuery);的区别:

jQuery(function(){})    //这是$(document).ready(function(){})的简写
(function($){})(jQuery)    //定义了一个自运行的匿名函数,其中jQuery是这个匿名函数的实参,相当于创建了插件的局部作用域

 

二:开发JQuery插件标准结构

1,定义作用域:定义一个JQuery插件,首先要把这个插件的代码放在一个不受外界干扰的地方。如果用专业些的话来说就是要为这个插件定义私有作用域。外部的代码不能直接访问插件内部的代码。插件内部的代码不污染全局变量。在一定的作用上解耦了插件与运行环境的依赖。说了这么多,那要怎样定义一个插件的私有作用域?

//step01 定义JQuery插件的作用域
(function ($) {
    //...
})(jQuery);

 

  别小看了这个作用域,就像c#定义一个类的class关键字一样重要。

 

2,为JQuery扩展一个插件:当定义好了JQuery的作用域后,最核心也是最迫切的一步就是为这个JQuery的实例添加一个扩展方法。首先我们为这个JQuery插件命名一个方法,叫easySlider,当在调用这个插件的时候,我们可以通过options来给这个插件传递一些参数。具体的定义方法看如下代码:

//step01 定义JQuery插件的作用域
(function ($) {
    //step02 插件的扩展方法名称
    $.fn.easySlider = function (options) {
        //...
    }
})(jQuery);

 

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 (opt) {
        //step03-b 合并默认属性和用户自定义属性,opt里面没有的属性就用defaults里的代替,有的则覆盖
        var options = $.extend(defaults, opt);
    }
})(jQuery);

 

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插件的主要内容,如果未能解决你的问题,请参考以下文章

VSCode插件开发全攻略代码片段设置自定义欢迎页

高效Web开发的10个jQuery代码片段

几个非常实用的JQuery代码片段

高效Web开发的10个jQuery代码片段

几条jQuery代码片段助力Web开发效率提升

web前端开发JQuery常用实例代码片段(50个)