JQuery插件写法的总结

最新推荐文章于 2020-07-09 15:54:25 发布

shenzhenNBA

最新推荐文章于 2020-07-09 15:54:25 发布

阅读量1.2k

点赞数

分类专栏：管理者/开发者 JavaScript 文章标签： jQuery插件插件

管理者/开发者同时被 2 个专栏收录

196 篇文章 1 订阅

订阅专栏

JavaScript

60 篇文章 0 订阅

订阅专栏

JQuery插件写法的总结，看到有用的文章转载一下（小量修改），原文见：http://www.jcodecraeer.com/a/jquery_js_ajaxjishu/2012/0418/110.html

最近Web应用程序中越来越多地用到了JQuery等Web前端技术。这些技术框架有效地改善了用户的操作体验，同时也提高了开发人员构造丰富客户端UI的效率。JQuery本身提供了丰富的操作，但是，有时候我们需要根据我们自己的业务和系统特色（风格）构造一些我们常用的前端UI组件，而JQuery的插件给了我们一个较好的方式来构造这些UI组件，方便我们日后反复重用这些组件。
网上也有很多关于JQuery插件的文章，我也搜了一些，但是，这些文档太过离散，没有有效地组织并充分说明JQuey插件该如何编写，并且有哪几种形式，什么情况下使用哪种形式。下面，我将说明JQuery插件常用的写法，以及这些插件的常用场景。

一、插件的两种写法
首先，在具体说明编写插件之前，我们先假定一个使用场景：有一个HTML页面（或.aspx/.jsp/.php页面），页面上放置了一个5行3列的表格，即：<table></table>标记，具体代码如下：

<table id="newTable">    
<tr>    
<td>1</td><td>1</td><td>1</td>    
</tr>    
<tr>    
<td>1</td><td>1</td><td>1</td>    
</tr>    
<tr>    
<td>1</td><td>1</td><td>1</td>    
</tr>    
<tr>    
<td>1</td><td>1</td><td>1</td>    
</tr>    
<tr>    
<td>1</td><td>1</td><td>1</td>    
</tr>    
</table>

我要实现的功能是：鼠标移到表格的某一行时，当前行高亮显示，其他行正常。
OK，结合这个场景，我们进一步探讨如何利用JQuery插件实现上述功能。常用的JQuery插件有如下几种写法：
1. 对JQuery自身的扩展插件
顾名思义，这种插件是对JQuery自身的方法库进行扩展的。在使用的时候通过 $.MethodName() 的方式直接使用。
插件代码示例：

$.extend({    
    handleTableUI : function(table){    
        varthisTable = $("#"+ table);                  
        $(thisTable).find("tr").bind("mouseover", function() {    
            $(this).css({ color: "#ff0011", background: "blue"});    
        });    
        $(thisTable).find("tr").bind("mouseout", function() {    
        	$(this).css({ color: "#000000", background: "white"});    
        });    
    }    
});

示例说明：当要对JQuery自身进行扩展的时候，需要采用 $.extend(); 的形式进行开发，JQuery的extend()方法为我们提供了扩展JQuery自身的方式，在extend()方法中，我们采用{...} 的形式编写具体的方法体。其中，最重要的是要定义我们自己的扩展方法，如示例中的handleTableUI。 定义的方式是：方法名 : function(参数){ 方法体 }。通过此种方式我们就可以定义JQuery自己的扩展方法，而且这个方法可以在web页面通过智能提示显示出来。页面中调用的代码如下:

<script type="text/javascript">    
$(document).ready(function() {    
	$.handleTableUI("newTable");    
});    
</script>

2. 对HTML标记或页面元素进行扩展
使用这种插件的扩展方式，在使用此插件时，需要首先引用经过JQuery包装的页面元素，如： $("#tableId").Method()。
插件代码示例：

(function($){   
    $.fn.tableUI = function(options){   
        var defaults = {   
            evenRowClass:"evenRow",   
            oddRowClass:"oddRow",   
            activeRowClass:"activeRow"
        }   
        var options = $.extend(defaults, options);   
        this.each(function(){   
        var thisTable=$(this);   
        //添加奇偶行颜色  
        $(thisTable).find("tr:even").addClass(options.evenRowClass);   
        $(thisTable).find("tr:odd").addClass(options.oddRowClass);   
        //添加活动行颜色  
        $(thisTable).find("tr").bind("mouseover",function(){   
        	$(this).addClass(options.activeRowClass);   
        });   
        $(thisTable).find("tr").bind("mouseout",function(){   
       		$(this).removeClass(options.activeRowClass);   
        });   
        });   
    };   
})(jQuery); //可见插件开发本质是使用闭包函数形式：()(param); 这里jQuery作为一个强大的工具以参数的形式传递到函数内部，以便在函数[插件]内使用jQuery

可见插件开发本质是使用闭包函数形式：()(param); 这里jQuery作为一个强大的工具以参数的形式传递到函数内部，以便在函数[插件]内使用jQuery，即：(function($){ ... })(JQuery); 具体格式如下：

//需要首先引入jQuery
(function($){
$.fn.自定义方法名 = function(参数){
//attend: 函数里 this = selector
//...具体功能实现代码
};
})(jQuery);

这里重点说一下这一句
var options= $.extend(defaults, options);
这里其实就是合并多个对象为一个。这里就是，如果你在调用的时候写了新的参数，就用你新的参数，如果没有写，就用默认的参数, 即使用options扩展或覆盖defaults。

当要对页面元素进行JQuery扩展时，需要采用 (function($){...})(JQuery);的方式进行开发。在“...”处，定义我们自己的方法， 定义方式是：$.fn.自定义方法名 = function(参数){...};的形式定义扩展方法的具体内容。在页面调用的时候不同于对JQuery自身的扩展。具体调用代码如下：

<script type="text/javascript">    
$(document).ready(function() {    
	$("#newTable").setTableUI();    
});    
</script>

3. 不要用在页面显式调用JQuery的方法，而是通过直接添加JQuery插件脚本引用，即可实现对该插件的调用。
一般，如果需要用到一些全局的JQuery插件，即：插件的方法不需要显式调用，而是引用脚本即可；同时，这种插件一般对整个Web页面起到全局配置或设置的作用，如：对<body></body>内部的内容进行整体布局，此时可以采用脚本引用的方式实现。
插件代码示例：

(function($) {    
    $.tableUI = { 
        set: function() {    
            varthisTable = $("table");    
            $(thisTable).find("tr").bind("mouseover", function() {    
                $(this).css({ color: "#ff0011", background: "blue"});    
            });    
            $(thisTable).find("tr").bind("mouseout", function() {    
                $(this).css({ color: "#000000", background: "white"});    
            });    
        }    
    };    
    //此处需要进行自调用    
    $(function() {    
    	$.tableUI.set();    
    });    
})(jQuery);

示例说明：如果上面这段代码在my.plugin.js文件中，那么，我们只需要在页面上添加对此脚本文件的引用即可，引用方式为：<scriptsrc="Scripts/my.plugin.js"type="text/javascript"></script>，当然，在所有要用到JQuery的地方，需要首先添加对JQuery库脚本的引用。在引用型插件的代码中，最主要的就是在插件中要主动调用自己所写的插件方法，上面代码中有注释的地方。否则，我们写的插件代码将不会起作用。

二、插件的基本要点

在编写插件的时候，我们需要记住这些要点，虽然不照着这么做不会影响使用，但是要是你的插件是不规范的代码，那何必花苦心思去写插件。

jQuery插件的文件名推荐命名为jquery.[插件名].js，以免和其他JavaScript库插件混淆。例如命名为 jQuery.color.js。
所有的对象方法都应当附加到jQuery.fn对象上，而所有的全局函数都应当附加到jQuery对象本身上。
在插件内部，this指向的是当前通过选择器获取的jQuery对象，而不像一般的方法那样，例如click()方法，内部的this指向的是DOM元素。
可以通过this.each来遍历所有元素。
所有的方法或函数插件，都应当以分号结尾，否则压缩的时候可能出现问题。为了更稳妥些，甚至可以在插件头部先加上一个分号，以免他人的不规范代码给插件带来影响。具体方法可以参考后面的代码。
插件应该返回一个jQuery对象，以保证插件的可链式操作。除非插件需要返回的是一些需要获取的量，例如字符串或者数组等。
避免在插件内部使用$作为jQuery对象的别名，而应使用完整的 jQuery 来表示。这样可以避免冲突。当然，也可以利用闭包这种技巧来回避这个问题，使插件内部继续使用$作为jQuery的别名。很多插件都是这么做的，本教程也会利用这种形式。