开发过很多 jQuery 插件以后,我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式。这样我就可以 copy & paste 大部分的代码结构,只要专注最主要的逻辑代码就行了。
使用相同的设计模式和架构也让修复bug或者二次开发更容易。一套经过验证的架构可以保证我的插件不出大的问题,不论插件简单还是复杂。
我在这里分享10条我总结的经验。
1. 把你的代码全部放在闭包里面
这是我用的最多的一条。但是有时候在闭包外面的方法会不能调用。不过你的插件的代码只为你自己的插件服务,所以不存在这个问题,你可以把所有的代码都放在闭包里面。而方法可能应该放在Prototype方法内部,我们后面会讲到这一点。
2. 提供插件的默认选项
你的插件应该会有一些选项是可以让开发者设置的,所以提供恢复默认选项是以有必要的。你可以通过jQuery的extend功能来设置这些选项:
8
|
settings
= $.extend({}, defaultSettings, settings || {});
|
3. 使用返回一个元素
JavaScript/jQuery有一个很好的特点就是可以进行方法级联,所以我们不应该破坏这个特性,始终在方法中返回一个元素。我在我的每一个jQuery插件中都遵守这一条。
1
|
$.fn.wPaint
= function (settings)
|
3
|
return this .each( function ()
|
4. 一次性代码放在主循环以外
这一条很重要,但是常常被忽略。简单的讲,如果你有一段代码是一堆默认值,只需要被实例化一次,而不是每次调用你插件功能的时候都实例化,你应该把这段代码放在插件方法的外面。这样可以让你的插件运行的更高效,节省内存。我们将会在后面讨论prototype的时候,看这个方法在实际中的运用。
01
|
var defaultSettings
= {
|
08
|
$.fn.wPaint
= function (settings)
|
10
|
settings
= $.extend({}, defaultSettings, settings || {});
|
12
|
return this .each( function ()
|
你可以注意到,上面代码中的“defaultSettings”是完全在插件方法外面的,由于这些代码是在闭包里面,我们不用担心这些变量被重写。
5. 为什么要设置 Class Prototyping
作为你代码的血与肉,方法和函数应该放在prototype函数内。有两个原因:
-
它可以节省很多内存,因为可以不用重复创建这些方法。
-
引用一个现成的方法比重新创建一个好快很多。
简单的说,prototype就是扩展了一个对象,为它提供方法,而不用在每一个对象中实例化这些方法。这也让你的代码更有条理和高效。一旦你习惯这种开发方式,你会发现它在你将来的项目中为你节省了很多时间。
6. 如何设置 Class Prototyping
设置一个 prototype 方法有两个部分。首先我们需要创建我们最初的类定义,在多数情况下这就意味着创建一个对象。这个定义包含了每一个对象实例都不同的部分。在我的
Paint
jQuery Plugin插件中,我是这么写的:
1
|
function Canvas(settings)
|
3
|
this .settings
= settings;
|
下面来添加全局的方法:
这里的关键是要让prototype的方法是通用的,但是数据是每个实例自己的,可以用“this”引用。
7. 使用 “this” 对象
通过使用“$this”,我们可以向别的闭包传递正确的引用。我们也可能需要向别的方法传入 $this 引用。需要注意的是, $this 这个名字是可以改的,任意的变量名都可以。
11
|
button.click( function (){
|
16
|
$ this .someFunc($ this );
|
20
|
someFunc: function ($ this )
|
8. 在每一个对象中保存设置
我一直在每一个对象中保存自己的设置,然后操作它自己的设置。这样你就不用在不同的方法中传递很多参数。把这些变量放在对象中,也方便你在其他地方调用这些变量。
1
|
function Canvas(settings)
|
3
|
this .settings
= settings;
|
9. 分离你的Prototype方法逻辑
这可能是一个基本的原则。当你在犹豫是否需要提供一个方法的时候,你可以问你自己 “如果其他人要重写这个方法的话,你的代码是否能满足他的需求?”或者“别人来写这个方法有多困难?”。当然这是一个灵活性拿捏的问题。这里列出了我的
Color
Picker jQuery Plugin 的方法,你可以参考一下:
10. 提供 Setter/Getter 选项
这一条不是必须的,但是我发现我所有的插件都包用到了这一条。因为它只需要一点点代码,就能为别人提供一个他可能需要的功能。
基本上,我们只要让开发者能够设置或者获取元素已经存在的值:
1
|
var lineWidth
= $( "#container" ).wPaint( "lineWidth" );
|
2
|
$( "#container" ).wPaint( "lineWidth" , "5" );
|
首先我们要把元素和对象关联起来,然后我们就可以引用它。我们在返回元素之前做如下操作:
01
|
return this .each( function ()
|
05
|
var canvas
= new Canvas(settings);
|
09
|
elem.data( "_wPaint_canvas" ,
canvas);
|
12
|
$.fn.wPaint
= function (option,
settings)
|
14
|
if ( typeof option
=== 'object' )
|
18
|
else if ( typeof option
=== 'string' )
|
21
|
this .data( '_wPaint_canvas' )
&&
|
22
|
defaultSettings[option]
!== undefined
|
24
|
var canvas
= this .data( '_wPaint_canvas' );
|
28
|
canvas.settings[option]
= settings;
|
33
|
return canvas.settings[option];
|
40
|
return this .each( function ()
|
以上十条基本上覆盖了jQuery插件开发的核心,并且可以作为开发的模板。有一套基本的代码可以极大的缩短你的开发时间,并且能够让你设计插件架构的时候更自信。
分享到:
相关推荐
本文总结了帮助你创建更好jQuery插件的10条建议。分享给大家供大家参考。具体说明如下: 在开发过很多 jQuery 插件以后,我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式。这样我就可以 copy & paste 大...
可以用来添加不向外部公开的方法,或者对jQuery的某些方法进行重新定义以提供新功能,或者提供更好的封装、避免名称空间冲突。当然,也可以用来开发插件,但Resig强烈建议在开发插件之前,先考虑jQuery UI widget...
希望下面的插件列表能给予你一定的帮助,让你的 web开发更快更好。旧版本的日历插件和下拉框已经被淘汰啦,好好欣赏 jQuery 日历插件给你带来的强烈视觉冲击吧! 1. CLNDR.js CLNDR.js 是一个日历插件,用来创建...
这可以让所有人使用您创建的插件,可以让整个 jQuery 开发社区变得更好。今年您也做出自己的贡献吧。 在编写本文中的插件时,我发现插件的创建过程以及用来创建它的框架非常简单明了。困难的地方在于想一些其他人还...
Covering-Bad 是一个基于 jQuery 的插件,它能够创建一个可以拉动大小的元素,覆盖在原有的元素上面,从而进行更好的对比。2013年3月11日,日本东海岸发生9.0级大地震时腾讯的专题页面做了一个类似的效果。用法示例...
此外,选择器引擎Sizzle修复了一些边缘问题和bug,包括对于多个选择符(~ > +)的改进、更好地检测浏览器bug等。 5. XSS防护 $()方法可以创建HTML元素,如果被用来传递一个[removed]标签,则可以运行脚本。...
为了让所有还没有完全掌握jQuery技术的开发者能迅速步入jQuery的殿堂,本书诞生了,相信它不会让你失望。 本书特点 与国内目前已经出版的同类书相比较,本书具有以下几个独有的特点: 基于jQuery的最新版本撰写,...
jQuery EasyUI是一组基于jQuery的UI插件集合体,而jQuery EasyUI的目标就是帮助web开发者更轻松的打造出功能丰富并且美观的UI界面。开发者不需要编写复杂的javascript,也不需要对css样式有深入的了解,开发者需要...
发起这个开源项目的原因是因为现有的Portlet插件都太难用,而且和我们现有的系统样式风格不兼容,因为公司的项目前端都是基于jQuery以及jQuery UI 框架开发的,所以为了更好的保持风格统一才有了jQuery UI Portlet。...
此外,选择器引擎Sizzle修复了一些边缘问题和bug,包括对于多个选择符(~ > +)的改进、更好地检测浏览器bug等。 5. XSS防护 $()方法可以创建HTML元素,如果被用来传递一个[removed]标签,则可以运行脚本。...
在第10章你将深入了解并亲手创建jQuery插件。 1.2 创建测试环境 学会一门新语言最好的方式就是亲自动手。你需要一个测试环境来做一些jQuery的初级练习。还好,创建这样一个测试环境只需简单的两步:先安装 Firefox...
创建更好的许可:Attribution-ShareAlike 4.0#由Pete R更好地订阅。 ,具有jQuery订阅的高度可定制的订阅模式或新闻简报注册窗口,更好地由Travelistly和BucketListly的创始人Pete R.创建许可:Attribution-...
我将演示如何利用jQuery插件leanModal建立一个常规模态窗口。如果你有MIT general license,那么这个插件是完全开源和免费的,我很喜欢这个插件,用起来相当方便,还能自行添加CSS,达到自定义的效果。 在线演示...
好工具提示用于创建简单移动工具提示的 jQuery 插件。 有关更多信息,请参阅文档。
NotiX v.2.0 JQuery插件v1.0 2016年4月27日v2.0 25/1/2018新的更好的版本为jQuery创建一个很酷的通知,易于使用。 使用方法:只需在下面找到示例: 在标题中包含jQuery.js 在您的标头中包含mk-notix.js 可用功能...
前几天晚上,闲来无事,就自己动手写了个简单的jQuery插件,功能很简单,只是让选定的元素高亮,但是其中的一些思想,还是很值得学习的,可以戳这里查看代码。 本文不聊怎么写jQuery插件,我们聊聊怎么去实现jQuery...
jQuery Lightbox 灯箱插件可以让你为您的网站和应用程序展示优雅的图像,视频 和其它内容(使用模式窗口)。如果你是一个开发人员,你必须拥有 jQuery 灯箱插件集合,因为有一部分的客户会要求他们的网站看起来更有...
jQuery可以实现比如渐变弹出, 图层移动等动画效果, 让我们获得更好的用户体验. 单以渐变效果为例, 从前我自己写了一个可以兼容ie和ff的渐变动画, 使用大量javascript代码实现, 费心费力不说, 写完后没有太多帮助过一...
不过,把它们放到一个单独的文件中会更好,就像这样(通过 src 属性来引用文件): 实例 <script type="text/javascript" src="jquery.js"> <script type="text/javascript" src="my_jquery_functions.js"> jQuery...