jQuery插件开发

1. 插件的种类

编写插件的目的是给已经有的一系列方法或函数做一个封装,以便在其他地方重复使用,方便后期维护和提高开发效率。

jQuery的插件主要分为三种类型:1.封装对象方法的插件;2.封装全局函数的插件;3.选择器插件;

1.1 封装对象方法的插件

这种插件是将对象方法封装起来,用于对通过选择器获取的jQuery对象进行操作,是最常用的一种插件。95%以上的jQuery插件都是封装对象方法的插件。此类插件可以发挥出jQuery选择器的强大优势。

1.2 封装全局函数的插件

可以将独立的函数加到jQuery命名空间下之下。例如解决冲突用的jQuery.noConflict()方法,常用的jQuery.ajax()方法以及去除首位空格的jQuery.trim()方法等,都是jQuery内部作为全局函数的插件附加到内核上去的。

1.3 选择器插件

个别情况下,会需要用到选择器插件。虽然jQuery的选择器十分强大,但还是会需要扩充一些自己喜欢的选择器。

2. 插件的基本要点

2.1 jQuery插件的文件名推荐命名为jquery.[插件名].js,以免和其他javascript库插件混淆。例如命名为jquery.color.js。

2.1　所有的对象方法都应当附加到jQuery.fn对象上,而所有的全局函数都应当附加到jQuery对象本身上。

2.2 在插件内部,this指向的是当前通过选择器获取的jQuery对象,而不像一般的方法那样,例如click()方法,内部的this指向的是DOM元素。

2.3 可以通过this.each来遍历所有元素。

2.4 所有的方法或函数插件,都应该以分号结尾,否则压缩的时候可能出现问题,为了更稳妥些，甚至可以在插件头部先加上一个问号。

2.5 插件应该返回一个jQuery对象,以保证插件的可链式操作,除非插件需要返回的是一些需要获取的量,例如字符串或者数组等。

2.6 避免在插件内部使用$作为jQuery对象的别名,而应该使用完整的jQuery来表示,这样可以避免冲突。当然,也可以使用闭包这种技巧来回避这个问题,使插件内部继续使用$作为jQuery的别名。

3. 插件中的闭包

闭包的概念:ECMAsscript对其进行了简单的描述,允许使用内部函数(即函数定义和函数表达式位于另一个函数的函数体内),而且,这些内部函数可以访问它们所在的外部函数中声明的所有局部变量,参数和声明的其他内部函数,当其中一个这样的内部函数在包含它们的外部函数之外被调用时,就会形成闭包。即内部函数会在外部函数返回后被执行。而当这个内部函数执行时,它仍然必须访问其外部函数的局部变量,参数以及其他内部函数。这些局部变量,参数和函数声明(最初时)的值是外部函数返回时的值,但也会受到内部函数的影响。

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

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

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

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

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

对于插件的制作来说,我们只需要知道所有的插件代码都必须放置在下面这两句代码内就可以了:

;(function($){
    /*此处编写jQuery插件代码*/
})(jQuery);

4. jQuery插件机制

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

5. 编写jQuery插件

5.1 封装jQuery对象方法的插件

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

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

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

由于是对jQuery对象的方法拓展,因此采用拓展第一类插件的方法jQuery.fn.extend()来编写,代码如下:

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

这里给这个方法提供了一个参数value,如果调用方法的时候传递了value这个参数,那么就是用这个值来设置字体颜色,否则就是获取匹配元素的字体颜色的值。

现在来测试一下该插件：

构建如下代码，并放入插件以及测试代码。

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>编写设置和获取颜色的插件</title>
<script type="text/javascript" src="jquery-1.8.3.js"></script>
<script type="text/javascript">
//插件编写
;(function(){
   jQuery.fn.extend({
      "color":function(value){
           return this.css("color",value); 
    }             
}); 
})(jQuery);

//插件应用
$(function(){
    //查看第一个div的color样式值
    alert($("div").color()+"
返回字符串,证明此插件可用。");
    //把所有的div的字体颜色都设为红色
    alert($("div").color("red")+"
返回object,证明得到的是jQuery对象。");
});
</script>
</head>
<body>
<div class="a">red</div>
<div style="color:blue">blue</div>
<div style="color:green">green</div>
<div style="color:yellow">yellow</div>
</body>
</html>

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

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

5.2 封装全局函数的插件

这类插件是在jQuery命名空间内部添加一个函数。这类插件很简单,只是普通的函数,没有特别需要注意的地方。

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

去除左侧,右侧的空格的函数分别写成如下jQuery代码:

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

现在把代码放到HTML页面中看看有什么效果。代码如下：

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>封装全局函数的插件</title>
<script type="text/javascript" src="jquery-1.8.3.js"></script>
<script type="text/javascript">
;(function($){
   $.extend({
      ltrim:function( text ){        //去除左侧空格
        return (text || "").replace(/^s+/g,"");
    },
      rtrim:function( text ){        //去除右侧空格
        return (text || "").replace(/^s+/g,"");
}
}); 
})(jQuery);
$("#trimTest").val(
jQuery.trim("        test    ")+"
"+
jQuery.ltrim("        test    ")+"
"+
jQuery.rtrim("        test    ")
);
</script>
</head>
<body>
<textarea id="trimTest" rows="5" cols="20"></textarea>
</body>
</html>

封装全局函数的插件编写完成。

5.3 自定义选择器(省略)