jQuery使用经验建议

在开发过很多 jQuery 插件以后,我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式。这样我就可以复制并粘贴大部分的代码结构,只要专注最主要的逻辑代码就行了。 使用相同的设计模式和架构也让修复bug或者二次开发更容易。一套经过验证的架构可以保证我的插件不出大的问题,不论插件简单还是复杂。我在这里分享10条我总结的经验。

1. 把你的代码全部放在闭包里面

这是我用的最多的一条。但是有时候在闭包外面的方法会不能调用。不过你的插件的代码只为你自己的插件服务,所以不存在这个问题,你可以把所有的代码都放在闭包里面。而方法可能应该放在Prototype方法内部,我们后面会讲到这一点。

/* 何问起 hovertree.com */
(function($)
 {
 //code here
 })(jQuery);   

2. 提供插件的默认选项

你的插件应该会有一些选项是可以让开发者设置的,所以提供恢复默认选项是以有必要的。你可以通过jQuery的extend功能来设置这些选项:

/* 何问起 hovertree.com */
var defaultSettings = {
   mode            : ‘Pencil‘,
   lineWidthMin    : ‘0‘,
   lineWidthMax    : ‘10‘,
   lineWidth       : ‘2‘
};   

settings = $.extend({}, defaultSettings, settings || {});   

3. 使用返回一个元素

JavaScript/jQuery有一个很好的特点就是可以进行方法级联,所以我们不应该破坏这个特性,始终在方法中返回一个元素。我在我的每一个jQuery插件中都遵守这一条。

$.fn.wPaint = function(settings)
  {
    return this.each(function()
    {
        var elem = $(this);   

        //run some code here    何问起 hovertree.com
    }
}   

4. 一次性代码放在主循环以外

这一条很重要,但是常常被忽略。简单的讲,如果你有一段代码是一堆默认值,只需要被实例化一次,而不是每次调用你插件功能的时候都实例化,你应该把这段代码放在插件方法的外面。这样可以让你的插件运行的更高效,节省内存。我们将会在后面讨论prototype的时候,看这个方法在实际中的运用。

var defaultSettings = {
    mode            : ‘Pencil‘,
    lineWidthMin    : ‘0‘,
    lineWidthMax    : ‘10‘,
    lineWidth       : ‘2‘
};   

$.fn.wPaint = function(settings)
{
    settings = $.extend({}, defaultSettings, settings || {});   

    return this.each(function()
    {
        var elem = $(this);   

        //run some code here 何问起 hovertree.com
     }
}   

你可以注意到,上面代码中的“defaultSettings”是完全在插件方法外面的,由于这些代码是在闭包里面,我们不用担心这些变量被重写。

5. 为什么要设置 Class Prototyping

作为你代码的血与肉,方法和函数应该放在prototype函数内。有两个原因:

▲它可以节省很多内存,因为可以不用重复创建这些方法。

▲引用一个现成的方法比重新创建一个好快很多。

简单的说,prototype就是扩展了一个对象,为它提供方法,而不用在每一个对象中实例化这些方法。这也让你的代码更有条理和高效。一旦你习惯这种开发方式,你会发现它在你将来的项目中为你节省了很多时间。

6. 如何设置 Class Prototyping

设置一个 prototype 方法有两个部分。首先我们需要创建我们最初的类定义,在多数情况下这就意味着创建一个对象。这个定义包含了每一个对象实例都不同的部分。在我的 Paint jQuery Plugin 插件中,我是这么写的:

/* 何问起 hovertree.com */
function Canvas(settings)
{
    this.settings = settings;
    this.draw = false;
    this.canvas = null;
    this.ctx = null;   

    return this;
}   

下面来添加全局的方法:

/* 何问起 hovertree.com */
Canvas.prototype =
{
  generate: function()
 {
        //generate code
  }
}   

这里的关键是要让prototype的方法是通用的,但是数据是每个实例自己的,可以用“this”引用。

7. 使用 “this” 对象

通过使用“$this”,我们可以向别的闭包传递正确的引用。我们也可能需要向别的方法传入 $this 引用。需要注意的是, $this 这个名字是可以改的,任意的变量名都可以。

Canvas.prototype =
{
    generate: function()
    {
        //some code   

        var $this = this;   

        var buton = //...some code   

       button.click(function(){
            //using this will not be found since it has it‘s own this   

            //use $this instead.   

           $this.someFunc($this);
        });
    },   

    someFunc: function($this)
    {
        //won‘t know what "this" is.
        //use $this instead passed from the click event
    }
}   /* 何问起 hovertree.com */

8. 在每一个对象中保存设置

我一直在每一个对象中保存自己的设置,然后操作它自己的设置。这样你就不用在不同的方法中传递很多参数。把这些变量放在对象中,也方便你在其他地方调用这些变量。

function Canvas(settings)
{
    this.settings = settings;   

    return this;
}
/* 何问起 hovertree.com */

9. 分离你的Prototype方法逻辑

这可能是一个基本的原则。当你在犹豫是否需要提供一个方法的时候,你可以问你自己 “如果其他人要重写这个方法的话,你的代码是否能满足他的需求?”或者“别人来写这个方法有多困难?”。当然这是一个灵活性拿捏的问题。这里列出了我的 Color Picker jQuery Plugin  的方法,你可以参考一下:

generate()
appendColors()
colorSelect()
colorHoverOn()
colorHoverOff()
appendToElement()
showPalette()
hidePalette()   

10. 提供 Setter/Getter 选项

这一条不是必须的,但是我发现我所有的插件都包用到了这一条。因为它只需要一点点代码,就能为别人提供一个他可能需要的功能。

基本上,我们只要让开发者能够设置或者获取元素已经存在的值:


1

2

 varlineWidth = $("#container").wPaint("lineWidth");

$("#container").wPaint("lineWidth","5");

首先我们要把元素和对象关联起来,然后我们就可以引用它。我们在返回元素之前做如下操作:

return this.each(function()
{
    var elem = $(this);   

   var canvas = new Canvas(settings);   

    //run some code here   

   elem.data("_wPaint_canvas", canvas);
}
//下面的代码明确了我们究竟要做什么:
$.fn.wPaint = function(option, settings)
{
   if(typeof option === ‘object‘)
    {
        settings = option;
    }
    else if(typeof option === ‘string‘)
    {
        if(
            this.data(‘_wPaint_canvas‘) &&
            defaultSettings[option] !== undefined
        ){
            var canvas = this.data(‘_wPaint_canvas‘);   

            if(settings)
            {
                canvas.settings[option] = settings;
              return true;
            }
            else
            {
                return canvas.settings[option];
           }
        }
        else
            return false;
    }   

    return this.each(function()
    {
        //run some code here
    }
}   /* 何问起 hovertree.com */

以上十条基本上覆盖了jQuery插件开发的核心,并且可以作为开发的模板。有一套基本的代码可以极大的缩短你的开发时间,并且能够让你设计插件架构的时候更自信。

推荐:http://www.cnblogs.com/roucheng/p/texiao.html

时间: 2024-11-10 01:35:11

jQuery使用经验建议的相关文章

前端编程提高之旅(十三)----jquery选择器

  Jquery代表javascript和query,即对javascript查询操作的类库,jquery是web前端界的事实标准.最近读<锋利的jquery>,发现这本书最大特点是,更深层的讨论一些jquery使用情境和优化方法,对于有一定jquery使用经验的开发者有独特价值.本篇算是乐帝读此书,对选择器和DOM操作加深理解的总结.    javascript自身包含三大弊端: 复杂的文档对象模型(DOM) 不一致的浏览器实现和便捷的开发 调试工具的缺乏    Jquery存在的意义就在于

Jquery(一) 初识Jquery,简单使用Jquery。

距离上一篇博文好像隔了很久的时间了额.好像是堕落了一阵子,前些时间去杭州找工作,被租房的事情给搞懵逼了,然后就回来了,回来在修炼一个月在出去奋斗把!加油,这两天把jquery,easyui和bootstrap这几个东西给记录一下,之前就学过,但是没记录下来,所以忘的很快,又没地方去复习,所以还是记录记录这些知识点.以便将来查看复习. --WH 一.什么是Jquery? 其实超级简单,不要把它想的太难了,Jquery就是一个js(javascript)类库. 1.1.什么是js类库? [JavaS

jQuery:deferred [转]

jQuery的开发速度很快,几乎每半年一个大版本,每两个月一个小版本. 每个版本都会引入一些新功能.今天我想介绍的,就是从jQuery 1.5.0版本开始引入的一个新功能----deferred对象. 这个功能很重要,未来将成为jQuery的核心方法,它彻底改变了如何在jQuery中使用ajax.为了实现它,jQuery的全部ajax代码都被改写了.但是,它比较抽象,初学者很难掌握,网上的教程也不多.所以,我把自己的学习笔记整理出来了,希望对大家有用. 本文不是初级教程,针对的读者是那些已经具备

jQuery Mobile的默认配置项详解,jQuery Mobile的中文配置api,jQuery Mobile的配置说明,配置大全

学习jQuery Mobile也有一段时间了,越来越上手了,也越来越喜欢他了.我根本就没有理由拒绝他的好.这里我有分享一下我对它的配置项的使用说明一下. 看代码解释: $(document).live("pageinit",function(event){ $.mobile.loadingMessage = "正在加载数据,请稍候......"; $.mobile.pageLoadErrorMessage="很抱歉,系统好像再打小瞌睡......"

jQuery的deferred对象详解

jQuery的开发速度很快,几乎每半年一个大版本,每两个月一个小版本. 每个版本都会引入一些新功能.今天我想介绍的,就是从jQuery 1.5.0版本开始引入的一个新功能----deferred对象. 这个功能很重要,未来将成为jQuery的核心方法,它彻底改变了如何在jQuery中使用ajax.为了实现它,jQuery的全部ajax代码都被改写了.但是,它比较抽象,初学者很难掌握,网上的教程也不多.所以,我把自己的学习笔记整理出来了,希望对大家有用. 本文不是初级教程,针对的读者是那些已经具备

JQuery 自己的理解

jquery本身就是一个函数,在这个函数的内部又封装了很多的函数(也可以叫做函数库),这些函数内部的函数就是各种不同的方法这些方法在我们使用的过程中可以让工作更加方便. 在使用jquery之前必须把这个jquery库引入文档内部. 可以把jquery下载到本地,使的时候直接调用本地的jquer(可以在jquery管网下载). 也可以使用网络地址,直接调用网络上的jquery(建议使用网络地址) <script src="http://apps.bdimg.com/libs/jquery/2

jQuery.queue源码分析

作者:禅楼望月(http://www.cnblogs.com/yaoyinglong ) 队列是一种特殊的线性表,它的特殊之处在于他只允许在头部进行删除,在尾部进行插入.常用来表示先进先出的操作(FIFO)--先进队列的元素先出队.搜索整个jQuery库会发现,queue在jQuery内部仅供给animate动画来使用.它提供了对外的接口,因此程序员也可以使用队列来完成一些特殊需求. queue模块对外开放的API:工具方法:queue,dequeue,_queueHooks(仅内部使用)实例方

jQuery的deferred对象详解(转)

jQuery的开发速度很快,几乎每半年一个大版本,每两个月一个小版本. 每个版本都会引入一些新功能.今天我想介绍的,就是从jQuery 1.5.0版本开始引入的一个新功能----deferred对象. 这个功能很重要,未来将成为jQuery的核心方法,它彻底改变了如何在jQuery中使用ajax.为了实现它,jQuery的全部ajax代码都被改写了.但是,它比较抽象,初学者很难掌握,网上的教程也不多.所以,我把自己的学习笔记整理出来了,希望对大家有用. 本文不是初级教程,针对的读者是那些已经具备

jQuery MiniUI开发系列之:创建组件对象

原文:http://miniui.com/bbs/forum.php?mod=viewthread&tid=20&extra=page%3D1 jQuery MiniUI可以使用Javascript和Html两种方式来创建对象. 1)Javascript创建对象使用JavaScript创建对象,是最基本的方式,有如下几个要点: 1)使用new关键字.如: var grid = new mini.DataGrid(); 2)使用set方法设置属性.如:grid.setUrl("ge