编写jQuery插件

时间 2019-11-08

标签编写 jquery 插件栏目 JQuery 繁體版

原文原文链接

前面的话

　　编写插件的目的是给已经有的一系列方法或函数作一个封装，以便在其余地方重复使用，提升开发效率和方便后期维护。本文将详细介绍如何编写jQuery插件css

类型

　　jQuery的插件主要分为3种类型html

　　一、封装对象方法jquery

　　这种插件是将对象方法封装起来，用于对经过选择器获取的jQuery对象进行操做，是最多见的一种插件。此类插件能够发挥出jQuery选择器的强大优点，有至关一部分的jQuery的方法，都是在jQuery脚本库内部经过这种形式“插”在内核上的，例如：parent()方法、appendTo()方法等。这些方法在如今来看都是jQuery自己自带的方法了。平时，咱们是能够直接拿来就用的，只需引入jQuery库就行ajax

　　二、封装全局函数正则表达式

　　能够将独立的函数加到jQuery命名空间下，如经常使用的jQuery.ajax()、去首尾空格的jQuery.trim()方法等，都是jQuery内部做为全局函数的插件附加到内核上去的数组

　　三、选择器插件闭包

　　虽然jQuery的选择器十分强大，可是在少数状况下，仍是会须要用到选择器插件来扩充一些本身喜欢的选择器app

要点

　　一、jQuery插件的文件名推荐命名为jQuery.[插件名].js，以避免和其余JS库插件混淆函数

　　二、全部的对象方法都应当附加到jQuery.fn对象上，而全部的全局函数都应当附加到jQuery对象自己上测试

　　三、在插件内部的this指向的是当前经过选择器获取的jQuery对象，而不像通常方法那样，如click，内部的this指向的是DOM元素

　　四、能够经过this.each来遍历全部的元素

　　五、全部的方法或函数插件，都应当以分号结尾。不然压缩的时候可能出现问题。为了稳妥些，甚至能够在插件头部先加上一个分号，以避免他人不规范的代码影响自身的插件代码

　　六、插件应该返回一个jQuery对象，以保证插件的可链式操做

　　七、避免在插件内部使用$做为jQuery对象的别名，而应使用完整的jQuery来表示，避免冲突。固然，也能够利用闭包来回避这种问题，使插件内部继续使用$做为jQuery的别名

闭包

　　利用闭包的特性，便可以免内部临时变量影响全局空间，又能够在插件内容继续使用$做为jQuery的别名。常见的jQuery插件都是如下这种形式的:

(function(){
   /*这里放置代码*/ 
})();

　　首先定义一个匿名函数function(){/*这里放置代码*/}，而后用括号括起来，变成(function(){/*这里放置代码*/})这种形式，最后经过()这个运算符来执行。能够传递参数进行，以供内部函数使用

//为了更好的兼容性，开始前有个分号
;(function($){        //此处将$做为匿名函数的形参
    /*这里放置代码，可使用$做为jQuery的缩写别名*/
})(jQuery);            //这里就将jQuery做为实参传递给匿名函数了

　　上面的代码是一种常见的jQuery插件的结构

插件机制

　　jQuery提供了两个用于拓展jQuery功能的方法，即jQuery.fn.extend()方法和jQuery.extend()方法。jQuery.fn.extend()方法用于拓展封装对象方法的插件，jQuery.extend()方法用于拓展封装全局函数的插件和选择器插件。这两个方法都接受一个参数，类型为Object。Object对象的"名/值对"分别表明"函数或方法名/函数主体"

【jQuery.fn.extend()】

　　jQuery.fn.extend()方法用于将一个对象的内容合并到jQuery的原型，以提供新的jQuery实例方法

<label><input type="checkbox" name="foo"> Foo</label>
<label><input type="checkbox" name="bar"> Bar</label>
<button id="btn1">全选</button>
<button id="btn2">全不选</button>
<script>
jQuery.fn.extend({
  check: function() {
    return this.each(function() { this.checked = true; });
  },
  uncheck: function() {
    return this.each(function() { this.checked = false; });
  }
});
$('#btn1').click(function(){
  $( "input[type='checkbox']" ).check();
});
$('#btn2').click(function(){
  $( "input[type='checkbox']" ).uncheck();
});
</script>

【jQuery.extend()】

　　jQuery.extend()方法用一个或多个其余对象来扩展一个对象，而后返回被扩展的对象

jQuery.extend( target [, object1 ] [, objectN ] )

　　例如，合并settings对象和options对象，修改并返回settings对象

var settings = {validate:false,limit:5,name:"foo"};
var options = {validate:true,name:"bar"};
var newOptions = jQuery.extend(settings,options);
console.log(newOptions);//Object {validate: true, limit: 5, name: "bar"}

　　jQuery.extend()方法常常被用于设置插件方法的一系列默认参数

function foo(options){
    options=jQuery.extend({
        name:"bar",
        length:5,
        dataType:"xml"
    },options);
}

　　若是用户调用foo()方法的时候，在传递的参数options对象设置了相应的值，那么就使用设置的值，不然使用默认值

　　经过使用jQuery.extend()方法，能够很方便地用传入的参数来覆盖默认值。此时，对方法的调用依旧保持一致，只不过要传入的是一个映射而不是一个参数列表。这种机制比传统的每一个参数都去检测的方式不只灵活并且更加简洁。此外使用命名参数意味着再添加新选项也不会影响过去编写的代码，从而使开发者使用起来更加直观明了

编写插件

一、封装jQuery对象方法的插件

　　编写设置和获取颜色的插件color()，该插件用于实现如下两个功能:

　　(1)设置匹配元素的颜色

　　(2)获取匹配的元素(元素集合中的第一个)的颜色

　　因为是对jQuery对象的方法拓展，所以采用拓展第一类插件的方法jQuery.fn.extend()来编写，这里给这个方法提供了一个参数value，若是调用方法的时候传递了value这个参数，那么就是用这个值来设置字体颜色，不然就是获取匹配元素的字体颜色的值

;(function(){
    jQuery.fn.extend({
        "color":function(value){
            if(value == undefined){
                return this.css("color");
            }else{
                return this.css("color",value);
            }          
        }             
    }); 
})(jQuery);

　　实际上，CSS()方法内容已经有判断value是否为undefined的机制，因此才能够根据传递参数的不一样而返回不一样的值。所以，代码能够删减以下

;(function(){
    jQuery.fn.extend({
        "color":function(value){
            return this.css("color",value);      
        }             
    }); 
})(jQuery);

<span id="test">测试文字</span>
<input type="color" id="color">
<script>
;(function($){
  $.fn.extend({
    "color":function(value){
      return this.css("color",value);      
    }             
  }); 
})(jQuery);
$('#color').on('change',function(){
  $('#test').color($(this).val());
})
</script>

　　另外，若是要定义一组插件，可使用以下所示写法:

;(function(){
    jQuery.fn.extend({
        "color":function(value){
          //插件代码
        },
        "border":function(value){
          //插件代码
        },
        "background":function(value){
          //插件代码
        }              
    }); 
})(jQuery);

二、封装全局函数的插件

　　这类插件是在jQuery命名空间内部添加一个函数

　　例如新增两个函数，用于去除左侧和右侧空格。虽然jQuery已经提供了jQuery.trim()方法来去除两端空格，但在某些状况下，会只但愿去除某一侧的空格

　　去除左侧、右侧的空格的函数分别写成以下jQuery代码。(text||"")部分是用于防止传递进来的text这个字符串变量处于未定义的特殊状态，若是text是undeined，则返回字符串""，不然返回字符串text。这个处理是为了保证接下来的字符串替换方法replace()方法不会出错

;(function($){
   $.extend({
      ltrim:function( text ){
            return (text || "").replace(/^\s+/g,"");
        },
        rtrim:function(     text ){
               return (text || "").replace(/\s+$/g,"");
        }
    }); 
})(jQuery);

var $str = "    test    ";
console.log($.trim($str));//'test'
console.log($.ltrim($str));//'test    '
console.log($.rtrim($str));//'    test'

三、自定义选择器

　　jQuery以其强大的选择器著称，那么jQuery的选择器的工做原理是什么呢？

　　jQuery的选择解析器首先会使用一组正则表达式来解析选择器，而后针对解析出的每个选择符执行一个函数，称为选择函数。最后根据这个选择函数的返回值为true仍是false来决定是否保留这个元素，这样就能够找到匹配的元素节点

　　如$("div:gl(1)")，该选择器首先会获取全部的<div>元素，而后隐式地遍历这些<div>元素，并逐个将这些<div>元素做为参数，连同括号里的“1”等一些参数一块儿传递给gt对应的选择器函数进行判断。若是返回true则保留，不然不保留，这样获得的结果就是一个符合要求的<div>元素的集合

　　选择器的函数一共接受3个参数，形式以下：

function (a,i,m){
         //...
}

　　第一个参数为a，指的是当前遍历到的DOM元素

　　第二个参数为i，指的是当前遍历到的DOM元素的索引值，从0开始

　　第三个参数是m，它是由jQuery正则解析引擎进一步解析后的产物，是一个数组：其中最重要的一个是m[3]，在$("div:gl(1)")中即为括号里的数字“1”。

　　在jQuery中已经有lt、gt和eq选择器，所以这里写一个介于二者之间(between)的选择器

　　思路：在上面的三个参数中，m[3]为"a,b"的形式，所以把m[3]用","分隔，而后跟索引值i进行对比，若是i在m[3]表示的范围之间就返回true，不然为false

;(function($){
    $.extend($.expr[":"],{
        between:function(a,i,m){
            var temp=m[3].split(",");
            return +temp[0]<i&&i<+temp[1];
        }
    });
})(jQuery);

　　[注意]经测试，函数中第二个参数i的值始终为0，没法获取索引值，这时就须要自造索引，代码以下

;(function($){
    var $index = -1;
    $.extend($.expr[":"],{
        between:function(a,i,m){
            var temp=m[3].split(",");   
            $index++;      
            return +temp[0]<$index&&$index<+temp[1];
            
        }
    });
})(jQuery);

<div>
  <i>0</i>
  <i>1</i>
  <i>2</i>
  <i>3</i>
  <i>4</i>
  <i>5</i>
</div>
<button id="btn">测试</button>
<script>
;(function($){
    var $index = -1;
    $.extend($.expr[":"],{
        between:function(a,i,m){
            var temp=m[3].split(",");   
            $index++;      
            return +temp[0]<$index&&$index<+temp[1];
            
        }
    });
})(jQuery);
$('#btn').click(function(){
  $('i:between(1,5)').css('background','lightblue');
});
</script>