Fork me on GitHub
理解jquery的$.extend()、$.fn和$.fn.extend()

理解jquery的$.extend()、$.fn和$.fn.extend()

jquery插件的开发包括两种:

 一种是类级别的插件开发,即给jquery添加新的全局函数,相当于给jquery类本身添加方法。jquery的全局函数就是属于jquery命名空间的函数。另一种是对象级别的插件开发,即给jquery对象添加方法,下面就两种函数的开发做详细的说明。

1.类级别的插件开发

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

1.1 添加一个新的全局函数

添加一个新的全局函数,我们只需如下定义:

1 jQuery.foo = function() {   
2 alert("This is a test.");  
3 }; 

1.2 增加多个全局函数

添加多个全局函数,可采用如下定义:

1 jQuery.foo = function(){
2   alert("This is a test.");  
3 };
4 jQuery.bar = function(param){
5     alert("This is another test.");
6 }

调用时和一个函数的一样的:jQuery.foo(); jQuery.bar(); 简写形式为:$.foo(); $.bar("bar");

1.3 使用jQuery.extend(object)添加全局函数

复制代码
1 jQuery.extend({
2     foo:function(){
3         alert("This is a test.");    
4     },
5     bar:function(){
6        alert("This is another test");
7     }
8 });        
复制代码

1.4 使用命名空间

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

复制代码
1 jQuery.myPlugin = {
2     foo:function(){
3        alert("This is a test.");
4     }  ,
5    bar:function("bar"){
6       alert("This is another test.");
7    }  
8 }
复制代码

采用命名空间的函数仍然是全局函数,调用时采用的方法:

jQuery.myPlugin.foo();

jQuery.myPlugin.bar("bar");

简写形式为:

$.myPlugin.foo();

$.myPlugin.bar("bar");

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

 

2.对象级别的插件开发

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

形式1:

1 (function($){
2     $.fn.pluginName = function(){
3          // 插件代码写在这里 
4      }
5 })(jQuery);    

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

2.1 在jQuery命名空间下生声明一个名字

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

1 $.fn.hilight = function(){
2      // 我们的插件写在这里
3 };    

我们的插件通过这样被调用:

1 $("myDiv").hilight();

但是我们需要分解我们的代码为多个函数的时候,需要把功能实现分解成多个函数而不增加多余的命名空间。 出于认识到和利用函数是js中最基本的类对象,我们可以这样做,就像其他对象一样,函数可以被制定为属性,因此我们已经声明“hilight”为jQuery的属性对象,任何其他的属性或函数我们需要暴露出来的,都可以在“hilight”函数中被声明属性。

2.2 接受options参数移控制插件的行为

让我们为我们的插件添加功能:指定前景色和背景色的功能,我们也许会让选项像一个options对象传递给插件函数,例:

复制代码
 1 // plugin definition
 2 $.fn.hilight = function(options){
 3    var defaults = {
 4       foreground : "red",
 5       background: "yellow"
 6    };  
 7 // 根据所提供的扩展我们能的options
 8 var opts = $.extend(defaults, options);
 9 // 插件内容写在这里
10 }    
复制代码

我们的插件可以这样被调用:

$("myDiv").hilight({
   foreground:"blue" 
})

2.3 暴露插件的默认设置

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

复制代码
 1 // plugin definition
 2 $.fn.hilight = function(options){
 3   // extend our default options with those provided.
 4   // note that the first arg to extend is an empty object , this is to keep form overriding our "defaults" object.
 5   var opts = $.extend({},$options);
 6 // our plugin inplementation code goes here.  
 7 };
 8 // plugin defaults -added as a property on our plugin function
 9 $.fn.hilight.default = {
10     foreground : "red",
11     background:"yellow"    
12 };
复制代码

现在使用者可以包含这样一行代码在他们的脚本里:

// 这个只需要调用一次,且不一定要在ready块中调用
$.fn.hilight.defaults.foreground = "blue";

接下来我们像这样使用插件的方法,结果它设置蓝色的前景色:

$("myDiv").hilight();

2.4 整合

下面使我们的例子完成后的代码:

复制代码
 1 // 创建一个闭包
 2 $(function($){
 3    // 插件的定义
 4    $.fn.hilight = function(options){
 5    // build main options before element iteration
 6    var opts = $.extend({},$.fn.hilight.defaults.options);
 7    // iteration and reformar each matched element
 8    return this.each(function(){
 9       $this = $(this);
10    // build element specific options
11       var o = $.meta ? $.extend({}, opts, $this.data()) : opts;   
12        $this.css({     
13         backgroundColor: o.background,     
14         color: o.foreground     
15       });     
16       var markup = $this.html();     
17       // call our format function     
18       markup = $.fn.hilight.format(markup);     
19       $this.html(markup);     
20     });     
21   };     
22   // 私有函数:debugging     
23   function debug($obj) {     
24     if (window.console && window.console.log)     
25       window.console.log('hilight selection count: ' + $obj.size());     
26   };     
27   // 定义暴露format函数     
28   $.fn.hilight.format = function(txt) {     
29     return '<strong>' + txt + '</strong>';     
30   };     
31   // 插件的defaults     
32   $.fn.hilight.defaults = {     
33     foreground: 'red',     
34     background: 'yellow'     
35   };
36    })
37    }
38 // 闭包结束
39 })(jQuery);            
复制代码

3、总结

jQuery为开发插件提拱了两个方法,分别是:

jQuery.fn.extend(object);  给jQuery对象添加方法。
jQuery.extend(object);  为扩展jQuery类本身.为类添加新的方法。

3.1 jQuery.fn.extend(object);

fn 是什么东西呢。查看jQuery代码,就不难发现。

jQuery.fn = jQuery.prototype = {  

init: function( selector, context ) {//....   

//......  

};   

原来 jQuery.fn = jQuery.prototype.对prototype肯定不会陌生啦。虽然 javascript 没有明确的类的概念,但是用类来理解它,会更方便。jQuery便是一个封装得非常好的类,比如我们用 语句 $("#btn1") 会生成一个 jQuery类的实例。

jQuery.fn.extend(object); 对jQuery.prototype进得扩展,就是为jQuery类添加“成员函数”。jQuery类的实例可以使用这个“成员函数”。

$.fn是指jQuery的命名空间,加上fn上的方法及属性,会对jquery实例每一个有效,如扩展$.fn.abc()是对jquery扩展了一个abc方法,那么后面的每个jQuery实例都可以引用这个方法了。

你可以这样:$("myDiv").abc();

比如我们要开发一个插件,做一个特殊的编辑框,当它被点击时,便alert 当前编辑框里的内容。可以这么做:

复制代码
$.fn.extend({        

     alertWhileClick:function(){       

         $(this).click(function(){      

              alert($(this).val());       

          });       

      }       

});   

$("#input1").alertWhileClick();
 //页面上为:
<input id="input1" type="text"/>
复制代码

 

$("#input1") 为一个jQuery实例,当它调用成员方法 alertWhileClick后,便实现了扩展,每次被点击时它会先弹出目前编辑里的内容。

3.2 jQuery.extend(object); 

为jQuery类添加添加类方法,可以理解为添加静态方法。如:

$.extend({  

    add:function(a,b){return a+b;}  

});  

便为 jQuery 添加一个为 add 的 “静态方法”,之后便可以在引入 jQuery 的地方,使用这个方法了

$.add(3,4);

//return 7

 

 
 
标签: web前端js
posted on 2015-07-13 22:29  HackerVirus  阅读(1798)  评论(0编辑  收藏  举报