10 条建议让你建立更好的 jQuery 插件

在开发过不少 jQuery 插件之后，我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式。这样我就能够 copy & paste 大部分的代码结构，只要专一最主要的逻辑代码就好了。 

使用相同的设计模式和架构也让修复bug或者二次开发更容易。一套通过验证的架构能够保证个人插件不出大的问题，不论插件简单仍是复杂。 

我在这里分享10条我总结的经验。

1. 把你的代码所有放在闭包里面 
这是我用的最多的一条。可是有时候在闭包外面的方法会不能调用。不过你的插件的代码只为你本身的插件服务，因此不存在这个问题，你能够把全部的代码都放在闭包里面。而方法可能应该放在Prototype方法内部，咱们后面会讲到这一点。 

(function($)
{
    //code here
})(jQuery);

2. 提供插件的默认选项 
你的插件应该会有一些选项是可让开发者设置的，因此提供恢复默认选项是以有必要的。你能够经过jQuery的extend功能来设置这些选项： 

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
    }
}

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
    }
}

你能够注意到，上面代码中的“defaultSettings”是彻底在插件方法外面的，因为这些代码是在闭包里面，咱们不用担忧这些变量被重写。 

5. 为何要设置 Class Prototyping 
做为你代码的血与肉，方法和函数应该放在prototype函数内。有两个缘由： 

• 它能够节省不少内存，由于能够不用重复建立这些方法。
• 引用一个现成的方法比从新建立一个好快不少。

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

6. 如何设置 Class Prototyping 
设置一个 prototype 方法有两个部分。首先咱们须要建立咱们最初的类定义，在多数状况下这就意味着建立一个对象。这个定义包含了每个对象实例都不一样的部分。在个人 Paint jQuery Plugin 插件中，我是这么写的： 

function Canvas(settings)
{
    this.settings = settings;
    this.draw = false;
    this.canvas = null;       
    this.ctx = null;

    return this;
}

下面来添加全局的方法： 

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
    }
}

8. 在每个对象中保存设置 
我一直在每个对象中保存本身的设置，而后操做它本身的设置。这样你就不用在不一样的方法中传递不少参数。把这些变量放在对象中，也方便你在其余地方调用这些变量。 

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

    return this;
}

9. 分离你的Prototype方法逻辑 
这多是一个基本的原则。当你在犹豫是否须要提供一个方法的时候，你能够问你本身 “若是其余人要重写这个方法的话，你的代码是否能知足他的需求？”或者“别人来写这个方法有多困难？”。固然这是一个灵活性拿捏的问题。这里列出了个人 Color Picker jQuery Plugin  的方法，你能够参考一下： 

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

10. 提供 Setter/Getter 选项 
这一条不是必须的，可是我发现我全部的插件都包用到了这一条。由于它只须要一点点代码，就能为别人提供一个他可能须要的功能。 

基本上，咱们只要让开发者可以设置或者获取元素已经存在的值： 

var lineWidth = $("#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
    }
}

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

 

原文：http://www.websanova.com/blog/jquery/10-coding-tips-to-write-superior-jquery-plugins#.Ulo4tsZ9fBs

译文：http://www.oschina.net/question/28_39656