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
|
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 } } /* 何问起 hovertree.com */
以上十条基本上覆盖了jQuery插件开发的核心,并且可以作为开发的模板。有一套基本的代码可以极大的缩短你的开发时间,并且能够让你设计插件架构的时候更自信。
推荐:http://www.cnblogs.com/roucheng/p/texiao.html
jQuery使用经验建议相关推荐
- AD637原理图PCB电路设计,使用经验和建议——【电路模块经验10】
转自https://blog.csdn.net/xx_yy_zz123/article/details/84100116 <每日模块经验分享> 每次开篇都不会忘记提醒建议大家养成这个好习惯 ...
- jQuery.append()、jQuery.html()存在的XSS漏洞
使用jQuery.append().jQuery.html()方法时,如果其中内容包含<script>脚本而没有经过任何处理的话,会执行它. 简单的示例代码如下: 1 var xssStr ...
- jQuery Mobile 笔记(1)- jQuery Mobile页面结构
jQuery Mobile页面解构 jQuery Mobile 的"页面"结构不同于传统的html页面,这样做是为了优化single page application的用户体验. ...
- 你必须知道的CSS盒模型,面试建议
什么是HTML? HTML: ( Hypertext Markup Language )超文本标记语言,是一种标识性的语言.它包括一系列标签.通过这些标签可以将网络上的文档格式统一,使分散的Inter ...
- 使用 jQuery Mobile 与 HTML5 开发 Web App (十二) —— jQuery Mobile 页面事件与 deferred
在系列的上一篇文章<使用 jQuery Mobile 与 HTML5 开发 Web App -- jQuery Mobile 事件详解>中,Kayo 介绍了除页面事件外的其他 jQuery ...
- 使用 jQuery Mobile 与 HTML5 开发 Web App (十一) —— jQuery Mobile 事件详解
在前文<使用 jQuery Mobile 与 HTML5 开发 Web App -- jQuery Mobile 默认配置与事件基础>中,Kayo 对 jQuery Mobile 事件的基 ...
- 使用 jQuery Mobile 与 HTML5 开发 Web App (十) —— jQuery Mobile 默认配置与事件基础
从本文开始,使用 jQuery Mobile 与 HTML5 开发 Web App 系列将 会进入第三部分--jQuery Mobile 事件与方法,这其中将会利用之前所讲述的 jQuery Mobi ...
- 使用 jQuery Mobile 与 HTML5 开发 Web App (四) —— jQuery Mobile 表单上
一.表单组件基础 1.组件简介 jQuery Mobile 中的表单组件是基于标准 HTML ,然后在此基础上增强样式,因此即使浏览器不支持 jQuery Mobile 表单仍可正常使用.需要注意的是 ...
- 使用 jQuery Mobile 与 HTML5 开发 Web App —— jQuery Mobile 默认配置与事件基础
使用 jQuery Mobile 与 HTML5 开发 Web App -- jQuery Mobile 默认配置与事件基础 时间:2012年9月25日 分类:JavaScript 标签:HTML5‚ ...
最新文章
- win10每次开机都会自检系统盘(非硬件故障)——解决方案2019.07.12
- WIN7 UAC/结构体的Equals方法/C# 开发wince程序,窗口上总留有一块空白区域/静态构造函数...
- c++ 预处理命令 预定义变量用法
- php namespace原理作用,php 命名空间(namespace)原理与用法实例小结
- JavaWeb(part2)--request
- volatile关键字的使用
- 数据类型之数字类型—运算符
- 95-290-240-源码-内存管理-StreamRecord-StreamRecord简介
- python回归结果可视化图表解读_一个基于可视化理论的完美Python图表,快学起来
- 一种追求高度融合,包容软硬方案的云主机集群,云OS和云APP的架构全设计
- mysql每五分钟取一次数据_mysql – 给定时间内每5分钟的平均数据
- 用java设计一个矩形类_6-1 设计一个矩形类Rectangle (10分)
- hadoop集群搭建详述
- 硅谷之行 (21) 加州的天空
- sublime的安装步骤、sublime的中文设置、sublime连接Linux的sftp(详细)
- 斐讯k2刷不死breed K2 22.5.11.14
- 图书云登上《图书馆理论与实践》学术期刊杂志 共享图书不再是神话 图书云力助海南医学院打造大学生图书共享平台 实战与理论完美结合
- Python之禅this
- soul网关-2-divide插件
- [易学易懂系列|golang语言|零基础|快速入门|(二)]