编写优秀jQuery插件的10个技巧

本文和大家分享的主要是jQuery 插件的编写技巧,一起来看看吧,希望对大家 学习jquery有所帮助。

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. 一次性代码放在主循环以外

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

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

var defaultSettings = {

mode            : ’Pencil’,

lineWidthMin    : ’0’,

lineWidthMax    : ’10’,

lineWidth       : ’2’ };

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

$.fn.wPaint = function(settings)  {

return this.each(function()  {

var elem = $(this);

//run some code here

}

}

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");

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

来源: 极客头条

时间: 2024-10-08 20:04:36

编写优秀jQuery插件的10个技巧的相关文章

2013年优秀jQuery插件

转载于:http://www.cnblogs.com/feng524822/p/3319534.html 今天为大家推荐的是2013年的第一期,在这期里面十个jQuery插件涵盖了响应式的 网格布局插件.图片放大插件.表单元素中自定义select插件,google 地图插件.文件拖放上传插件.tooltip提示插件.3D旋转菜单等等.这些插件的官网都提供了详细的API和相关代码下载,也提供了一些案例展示,可 以说稍懂一点前端的同学按照他们提供的API就会使用这些插件. 1.Makisu : jQ

10条建议帮助你创建更好的jQuery插件

本文总结了帮助你创建更好jQuery插件的10条建议.分享给大家供大家参考.具体说明如下: 在开发过很多 jQuery 插件以后,我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式.这样我就可以 copy & paste 大部分的代码结构,只要专注最主要的逻辑代码就行了.使用相同的设计模式和架构也让修复bug或者二次开发更容易.一套经过验证的架构可以保证我的插件不出大的问题,不论插件简单还是复杂.我在这里分享10条我总结的经验. 1. 把你的代码全部放在闭包里面 这是我用的最多的一条.

Lazy Load, 延迟加载图片的 jQuery 插件 - NeoEase

body { font-family: "Microsoft YaHei UI","Microsoft YaHei",SimSun,"Segoe UI",Tahoma,Helvetica,Sans-Serif,"Microsoft YaHei", Georgia,Helvetica,Arial,sans-serif,宋体, PMingLiU,serif; font-size: 10.5pt; line-height: 1.5;

Lazy Load, 延迟加载图片的 jQuery 插件

本文翻译自 Lazy Load Plugin for jQuery, 介绍一个 jQuery 插件, 它提供懒汉式加载页面图片的功能. Lazy Load 是一个用 JavaScript 编写的 jQuery 插件. 它可以延迟加载长页面中的图片. 在浏览器可视区域外的图片不会被载入, 直到用户将页面滚动到它们所在的位置. 这与图片预加载的处理方式正好是相反的. 在包含很多大图片长页面中延迟加载图片可以加快页面加载速度. 浏览器将会在加载可见图片之后即进入就绪状态. 在某些情况下还可以帮助降低服

使用jquery插件实现图片延迟加载技术(懒加载)

有时我们看到一些大型网站,页面如果有很多图片的时候,当你滚动到相应的行时,当前行的图片才即时加载的,这样子的话页面在打开只加可视区域的图片,而其它隐藏的图片则不加载,一定程序上加快了页面加载的速度,对于比较长的页面来说,这个方案是比较好的. 这里推荐使用jquery图片延迟加载插件jquery.lazyload实现图片延迟加载提高网站打开速度 下载地址:http://www.appelsiini.net/download/jquery.lazyload.js 修正版:jquery.lazyloa

Lazy Load, 延迟加载图片的 jQuery 插件(转)

Lazy Load 是一个用 JavaScript 编写的 jQuery 插件. 它可以延迟加载长页面中的图片. 在浏览器可视区域外的图片不会被载入, 直到用户将页面滚动到它们所在的位置. 这与图片预加载的处理方式正好是相反的. 在包含很多大图片长页面中延迟加载图片可以加快页面加载速度. 浏览器将会在加载可见图片之后即进入就绪状态. 在某些情况下还可以帮助降低服务器负担. Lazy Load 灵感来自 Matt Mlinac 制作的 YUI ImageLoader 工具箱. 这是演示页面. 这里

[转载]编写优秀代码的10个技巧

作为程序员,写代码是需要一种崇高无上的精神来支撑的,写出优秀的代码,更需要你有深厚的底蕴和良好的编码习惯.在介绍写优秀代码的10个技巧之前,我们先来探讨一下什么样的代码才是优秀的代码. 稳定可靠(Robustness) 可维护且简洁(Maintainable and Simple Code) 高效(Fast) 简短(Small) 共享性(Reusable) 可测试性(Testable) 可移植性(Portable) 面对以上的目标,我们总结了以下10个写代码的技巧,希望对你有所帮助. 1.百家之

编写优秀代码的10个技巧

作为程序员,写代码是需要一种崇高无上的精神来支撑的,写出优秀的代码,更需要你有深厚的底蕴和良好的编码习惯.在介绍写优秀代码的10个技巧之前,我们先来探讨一下什么样的代码才是优秀的代码. 稳定可靠(Robustness) 可维护且简洁(Maintainable and Simple Code) 高效(Fast) 简短(Small) 共享性(Reusable) 可测试性(Testable) 可移植性(Portable) 面对以上的目标,我们总结了以下10个写代码的技巧,希望对你有所帮助. 1.百家之

jquery插件分类与编写详细讲解

1. 插件种类 插件其实就是对现有的方法(或者叫函数)做一个封装,方便重用提高开发效率.   jQeury主要有2种类型   1)实例对象方法插件 开发能让所有的jquery实例对象都可以调用的方法.也就是说,只要通过$()工厂获得的jquery实例对象,都可以调用我们开发的方法.95%的插件都是这种类型   2)全局函数插件 可以将独立的函数添加到jQuery命名空间中了.那么调用的时候就可以使用 $.函数名称() 或者jQuery.函数名称()来调用了.可以理解为静态方法.   2. 添加全