jQuery插件开发全解析 - 高级

jQuery插件的开发包括两种：

一种是类级别的插件开发，即给jQuery添加新的全局函数，相当于给jQuery类本身添加方法，jQuery的全局函数就是属于jQuery命名空间的函数，这个方法不会返回jQuery对象，这个函数不能跟在jQuery对象后面，例如$('div').foo()。另一种是对象级别的插件开发，即给jQuery对象添加方法，返回相应的jQuery对象，这个函数是可以跟在jQuery对象后面，该jQuery对象会自动传入该方法，就和click事件一样。这两种插件的函数定义可以在$(function(){});里面，也可以直接定义。下面就两种函数的开发做详细的说明。

在介绍插件开发之前，我们先来简单了解jQuery类是如何控制本身的属性和方法

jQuery是Javascript的一个扩展类，那么这个类里面就会有属性和方法，jQuery提供了一个jQuery.extend(object); 或 $.extend(object);的方法来给jQuery类本身或插件类本身添加属性和方法或修改属性值的方法，然后返回传入所有参数的合并后的对象。

$.extend(object1, object2, ...)的其中每个参数形式为:
{
a: val,
b: val,
...
}

或

{
a: function(){},
c: function(){},
...
}

当参数中，有相同的键值（例如a, b, ...），排在后面的参数的值会覆盖前面参数的值，例如
$.extend({a:val,b:val}, {a:function(){}, b:function(){}}); a  的值最终为function(){}，该$.extend(object);会返回参数合并后的对象为：

{a:function(){}, b:val, c:function(){}}

合并后的对象有两个返回，一个返回给第一个参数，另外一个返回是这个$.extend(object)的返回。

开发插件的一个重要方式：闭包

即使用这种方式来开发：

(function($){插件代码...})(jQuery);

这样做的好处是，避免与第三方的代码冲突，很好的兼容了jQuery操作符$和jQuery，还能保护插件内的私有变量和函数。jQuery官方推荐每个插件都使用闭包。

注意：上面的闭包和我们通常使用的
$(function(){

code ...

});

是不同的，这里的是告诉document对象，这段代码是在document加载完成后立即执行，等同于：
$(document).ready(function(){

code ...

});

也即是：
jQuery(function(){

code ...

});

也即是：
jQuery(document).ready(function(){

code ...

});

另外在插件中的属性和方法都是定义在一个变量中，通过这个变量（对象）来调用该插件的属性和方法，例如：

var object = {a = val,b = val,c = function(){}, ...};

所以，object不是插件的属性，同时该变量一定要在插件中创建，而不能在插件外面创建。

1、类级别的插件开发

类级别的插件开发最直接的理解就是给jQuery类添加类方法，可以理解为添加静态方法。典型的例子就是$.AJAX()这个函数，将函数定义于jQuery的命名空间中。关于类级别的插件开发可以采用如下四种形式进行扩展：

1.1 添加一个新的全局函数

添加一个全局函数，我们只需如下定义：（下面的jQuery可以使用$来简化）

jQuery.foo = function() { alert('This is a test. This is only a test.');};  调用：jQuery.foo(); 或 $.foo();

1.2 增加多个全局函数

添加多个全局函数，可采用如下定义：

jQuery.foo = function() { alert('This is a test. This is only a test.');};jQuery.bar = function(param) { alert('This function takes a parameter, which is "' + param + '".');}; 调用时和一个函数的一样的:jQuery.foo(); jQuery.bar(); 或者 $.foo(); $.bar('bar');param可以是jQuery对象，例如：var obj = $('div'); jQuery.foo = function(obj){alert(obj.attr('name'));};调用：$.foo(obj);也可以是一个变量，例如:var p = {p1:'val', p2:'val'};jQuery.foo = function(param){alert(param.p1);}; 调用：$.foo(p);

1.3 使用jQuery.extend(object);　

一个全局函数：jQuery.extend({foo: function(){alert('aaa');}});多个全局函数：jQuery.extend({    foo: function() {    alert('This is a test. This is only a test.');    },    bar: function(param) {    alert('This function takes a parameter, which is "' + param +'".');    }   });调用：$.foo(); 

1.4 使用命名空间（即是把自定义的全局函数定义在一个自定义的命名空间中，使得在调用这些函数的时候是使用自定义的命名来调用，避免这些函数或函数里面的变量和其他函数和变量冲突）

虽然在jQuery命名空间中，我们禁止使用了大量的javaScript函数名和变量名。但是仍然不可避免某些函数或变量名将于其他jQuery插件冲突，因此我们习惯将一些方法封装到另一个自定义的命名空间。

一个全局函数：jQuery.myPlugin = {foo:function(){alert('aaa');}};多个全局函数：jQuery.myPlugin = {        foo:function() {        alert('This is a test. This is only a test.');        },        bar:function(param) {        alert('This function takes a parameter, which is "' + param + '".');  }       };采用命名空间的函数仍然是全局函数，调用时采用的方法：$.myPlugin.foo();       $.myPlugin.bar('baz');

通过这个技巧（使用独立的插件名），我们可以避免命名空间内函数的冲突。

2、对象级别的插件开发（只能使用有命名空间的方式来创建插件）

对象级别的插件开发需要如下的两种形式：

形式1（有命名空间的）：  

 $.fn.extend({   pluginName:function(){             // Our plugin implementation code goes here.            alert('aaa');  }   });调用：$('div').pluginName();

形式2（有命名空间的）：

$.fn.pluginName = function() {        // Our plugin implementation code goes here.            alert('aaa');  };调用：$('div').pluginName();

       上面定义了一个jQuery函数，形参是$，函数定义完成之后，把jQuery这个实参传递进去.立即调用执行。这样的好处是,我们在写jQuery插件时,也可以使用$这个别名,而不会与prototype引起冲突.

2.1 在JQuery名称空间下申明一个名字

这是一个单一插件的脚本。如果你的脚本中包含多个插件，或者互逆的插件（例如： $.fn.doSomething()和 $.fn.undoSomething()），那么你需要声明多个函数名字。但是，通常当我们编写一个插件时，力求仅使用一个名字来包含它的所有内容。我们的示例插件命名为“highlight“    

 

$.fn.hilight = function() {    // Our plugin implementation code goes here.  };  我们的插件通过这样被调用：$('#myDiv').hilight();     

 但是如果我们需要分解我们的实现代码为多个函数该怎么办？有很多原因：设计上的需要；这样做更容易或更易读的实现；而且这样更符合面向对象。这真是一个麻烦事，把功能实现分解成多个函数而不增加多余的命名空间。出于认识到和利用函数是javascript中最基本的类对象，我们可以这样做。就像其他对象一样，函数可以被指定为属性。因此我们已经声明“hilight”为jQuery的属性对象，任何其他的属性或者函数我们需要暴露出来的，都可以在"hilight"函数中被声明属性。稍后继续。

2.2 接收传入的options参数来控制插件的行为（可以包括修改属性或方法（例如：假设'red'为 function(){}））

让我们为插件添加指定前景色和背景色的功能。我们通过options参数传递给插件函数。例如：   

// plugin definition  $.fn.hilight = function(options) {    //设置该插件的默认属性和值  var defaults = {      foreground: 'red',      background: 'yellow'    };    // 通过在调用插件的时候，传入的参数来扩展该插件默认是属性或方法，$.extend()方法可以合并参数defaults, options这两个对象，并返回合并后的对象.  var opts = $.extend(defaults, options);    // Our plugin implementation code goes here.  };  我们的插件可以这样被调用：$('#myDiv').hilight({    foreground: 'blue'  });   

 注意：上面的插件仅仅是把前景色通过options参数传入插件，使得改变插件默认属性foreground的值，但并没有对myDiv对象进行操作，因为代码还没写完整。
上面就是要告诉我们，插件对象中的属性值可以通过传递参数的方式来修改插件的默认属性值。

2.3 暴露插件的默认设置

我们对上面代码的一种改进是暴露插件的默认设置。这对于让插件的使用者更容易用较少的代码覆盖和修改插件。接下来我们开始利用函数对象。     

 

// plugin definition  $.fn.hilight = function(options) {    // 通过传入的参数来扩展该插件默认是属性或方法.   // 注意第一个参数为空对象，  这个是为了当传入的$.fn.hilight.defaults和options参数为空时，opts的值仍能是空的{}对象.   // $.fn.hilight.defaults 这个参数在这里，并不是给该插件创建defaults里面的属性，而是仅仅为传值，因为defaults是变量，不能通过在插件外面创建，只能在插件里面先定义。     var opts = $.extend({}, $.fn.hilight.defaults, options);    // Our plugin implementation code goes here.  };  // 在插件外面添加该插件的属性值，这里并非是给该插件hilight创建变量defaults和属性，而是仅仅是为里在上面中插件里面的调用，因为defaults变量是不能在插件外面创建。  $.fn.hilight.defaults = {    foreground: 'red',    background: 'yellow'  };   现在使用者可以包含像这样的一行在他们的脚本里：//这个只需要调用一次，且不一定要在ready块中调用//这里可以直接给该插件创建新的属性 $.fn.hilight.defaults.foreground = 'blue';  接下来我们可以像这样使用插件的方法，结果它设置蓝色的前景色：$('#myDiv').hilight(); 

 如你所见，我们允许使用者写一行代码在插件的默认前景色。而且使用者仍然在需要的时候可以有选择的覆盖这些新的默认值：

// 覆盖插件缺省的背景颜色 

$.fn.hilight.defaults.foreground = 'blue'; 

// ... 

// 使用一个新的缺省设置调用插件 

$('.hilightDiv').hilight(); 

// ... 

// 通过传递配置参数给插件方法来覆盖缺省设置 

$('#green').hilight({ 

  foreground: 'green' 

});  

在插件外面来修改插件中的属性和方法，可以通过两种方式来处理：

1. 直接在插件外面调用和赋值，例如：$.fn.hilight.defaults.foreground = 'blue';$.fn.hilight.defaults.init = function(){};

2. 在插件外面调用插件的时候，通过参数传递给插件。例如：$('#green').hilight({foreground:'green'});

2.4 适当的暴露一些函数

这段将会一步一步对前面那段代码通过有意思的方法扩展你的插件（同时让其他人扩展你的插件）。例如，我们插件的实现里面可以定义一个名叫"format"的函数来格式化高亮文本。我们的插件现在看起来像这样，默认的format方法的实现部分在hiligth函数下面。

// plugin definition  $.fn.hilight = function(options) {    // iterate and reformat each matched element  任何一个插件都需要返回jQuery对象，否则无法形成jQuery的链式调用.  return this.each(function() {      var $this = $(this);      // ...      var markup = $this.html();      // call our format function  这里仅仅是调用插件外面定义的方法，而不是创建该插件的方法。    markup = $.fn.hilight.format(markup);      $this.html(markup);    });  };  // define our format function  和上面的暴露属性$.fn.hilight.defaults的方式是一样的，这里并不是给该插件创建方法，而仅仅是为了提供给插件的调用。$.fn.hilight.format = function(txt) {  return '<strong>' + txt + '</strong>';  };   

  

      我们很容易的支持options对象中的其他的属性通过允许一个回调函数来覆盖默认的设置。这是另外一个出色的方法来修改你的插件。这里展示的技巧是进一步有效的暴露format函数进而让他能被重新定义。通过这技巧，是其他人能够传递他们自己设置来覆盖你的插件，换句话说，这样其他人也能够为你的插件写插件。
      考虑到这个篇文章中我们建立的无用的插件，你也许想知道究竟什么时候这些会有用。一个真实的例子是Cycle插件.这个Cycle插件是一个滑动显示插件，他能支持许多内部变换作用到滚动，滑动，渐变消失等。但是实际上，没有办法定义也许会应用到滑动变化上每种类型的效果。那是这种扩展性有用的地方。 Cycle插件对使用者暴露"transitions"对象，使他们添加自己变换定义。插件中定义就像这样：

$.fn.cycle.transitions = { 

// ... 

}; 

这个技巧使其他人能定义和传递变换设置到Cycle插件。

2.5 保持私有函数的私有性

这种技巧暴露你插件一部分来被覆盖是非常强大的。但是你需要仔细思考你实现中暴露的部分。一但被暴露，你需要在头脑中保持任何对于参数或者语义的改动也许会破坏向后的兼容性。一个通理是，如果你不能肯定是否暴露特定的函数，那么你也许不需要那样做。

那么我们怎么定义更多的函数而不搅乱命名空间也不暴露实现呢？这就是闭包的功能。为了演示，我们将会添加另外一个“debug”函数到我们的插件中。这个 debug函数将为输出被选中的元素格式到firebug控制台。为了创建一个闭包，我们将包装整个插件定义在一个函数中。 

 (function($) {    // plugin definition    $.fn.hilight = function(options) {      debug(this);  //可以直接在插件里面声明一个方法，然后在插件外面定义这个方法。    // ...    };    // private function for debugging    function debug($obj) {      if (window.console && window.console.log)        window.console.log('hilight selection count: ' + $obj.size());    };  //  ...  })(jQuery);  

我们的“debug”方法不能从外部闭包进入,因此对于我们的实现是私有的。

2.6 支持Metadata插件

在你正在写的插件的基础上，添加对Metadata插件的支持能使他更强大。个人来说，我喜欢这个Metadata插件，因为它让你使用不多的"markup”覆盖插件的选项（这非常有用当创建例子时）。而且支持它非常简单。更新：注释中有一点优化建议。

$.fn.hilight = function(options) {    // ...    // build main options before element iteration    var opts = $.extend({}, $.fn.hilight.defaults, options);    return this.each(function() {      var $this = $(this);      // build element specific options      var o = $.meta ? $.extend({}, opts, $this.data()) : opts;      //...    

 

 这些变动行做了一些事情：它是测试Metadata插件是否被安装如果它被安装了，它能扩展我们的options对象通过抽取元数据这行作为最后一个参数添加到JQuery.extend，那么它将会覆盖任何其它选项设置。现在我们能从"markup”处驱动行为,如果我们选择了“markup”：

 调用的时候可以这样写： jQuery.foo(); 或 $.foo(); 

 

<!--  markup  -->  <div class="hilight { background: 'red', foreground: 'white' }">    Have a nice day!  </div>  <div class="hilight { foreground: 'orange' }">    Have a nice day!  </div>  <div class="hilight { background: 'green' }">    Have a nice day!  </div>  现在我们能高亮哪些div仅使用一行脚本：$('.hilight').hilight();   

 

2.7 整合
下面使我们的例子完成后的代码：

 

// 创建一个闭包  (function($) {    // 插件的定义    $.fn.hilight = function(options) {      debug(this);      // build main options before element iteration      var opts = $.extend({}, $.fn.hilight.defaults, options);      // iterate and reformat each matched element      return this.each(function() {        $this = $(this);        // build element specific options        var o = $.meta ? $.extend({}, opts, $this.data()) : opts;        // update element styles        $this.css({          backgroundColor: o.background,          color: o.foreground        });        var markup = $this.html();        // call our format function        markup = $.fn.hilight.format(markup);        $this.html(markup);      });    };    // 私有函数：debugging    function debug($obj) {      if (window.console && window.console.log)        window.console.log('hilight selection count: ' + $obj.size());    };    // 定义暴露format函数    $.fn.hilight.format = function(txt) {      return '<strong>' + txt + '</strong>';    };    // 插件的defaults    $.fn.hilight.defaults = {      foreground: 'red',      background: 'yellow'    };  // 闭包结束  })(jQuery);   

这段设计已经让我创建了强大符合规范的插件。我希望它能让你也能做到。

2.8 在插件中使用data

通常在插件开发的时候，当所给元素被某个插件初始化后，它的一些状态或验证需要被维护住。用 jQuery 中的 data 来为每一个元素维护自己的特有变量同样是一种很棒的实践。

2.9 在插件中使用bind来绑定事件

事件需和某一元素进行绑定，在满足特定的情况下被触发。可使用 jQuery 中的 bind 进行绑定，它允许使用命名空间对事件进行绑定。在插件中使用命名空间进行事件绑定是一个很好的实践。这样一来，当你需要 unbind 的时候，就不会被同类型的其他事件所干扰，错误的解除绑定。示例如下：

$(".className").bind("resize.tab", method);$(".className").unbind(".tab");

3.0 在插件中调用方法

可把插件所需要使用到的方法收集到一个对象中（例如 var month = {init: function(){}, click: function(){}}, ...），然后通过指定的参数（例如: init,...）进行调用。这样对方法的扩展也就演化为对对象的扩展。例如：

var methods = {       init : function (options) {},       show : function ( ) {},       hide : function ( ) { },       update : function (content) {}}; return methods[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));

3.1 下面是一个完整的例子：

<script type="text/javascript"><!-- (function($){//设置传入插件内部的参数，可以是属性和方法$.fn.plugina = function(options,method){//设置一个变量来存储该插件的属性和方法var defaults = {  oa : 'aaaa',  ob : 'bbbb',  init: function(){    alert('init');  },      show: function(){        alert('show');      }};//使用bind给调用该插件的jQuery对象（即元素）绑定事件$(this).bind('click',function(){alert('click');});//把传入进来的参数合并设置到defaults变量中，使得该插件的属性和方法得到更新$.extend(defaults,$.fn.plugina.defaults,options);//根据参数method来执行该插件中的方法if (defaults[method]) {defaults[ method ].apply( this, Array.prototype.slice.call( arguments, 1 ));    }    //返回使用该插件的jQuery对象，以便后续的链式使用return $(this);};//插件外部定义的属性和方法$.fn.plugina.defaults = {      width: 100,      height: 200,      init: function(){alert('aasasa');}};//插件外部设定插件的属性$.fn.plugina.defaults.oc = 'cccccc';//插件外部设定插件的方法$.fn.plugina.defaults.init = function(){alert('init-out')};})(jQuery);$('div').plugina({},'init');--></script>