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


Posted in Javascript onMay 18, 2015

本文总结了帮助你创建更好jQuery插件的10条建议。分享给大家供大家参考。具体说明如下:

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

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

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

你可以注意到,上面代码中的“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");

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

希望本文所述对大家的jquery程序设计有所帮助。

Javascript 相关文章推荐
js的alert弹出框出现乱码解决方案
Sep 02 Javascript
javascript loadScript异步加载脚本示例讲解
Nov 14 Javascript
将字符串中由空格隔开的每个单词首字母大写
Apr 06 Javascript
Javascript解析URL方法详解
Dec 05 Javascript
jQuery Real Person验证码插件防止表单自动提交
Nov 06 Javascript
JavaScript学习笔记整理之引用类型
Jan 22 Javascript
原生js实现水平方向无缝滚动
Jan 10 Javascript
详解VueJs异步动态加载块
Mar 09 Javascript
BootStrap 表单控件之单选按钮水平排列
May 23 Javascript
ActiveX控件的使用-js实现打印超市小票功能代码详解
Nov 22 Javascript
vue移动端UI框架实现QQ侧边菜单组件
Mar 09 Javascript
vue.js实现简单购物车功能
May 30 Javascript
原生js实现的贪吃蛇网页版游戏完整实例
May 18 #Javascript
JQuery中层次选择器用法实例详解
May 18 #Javascript
Jquery中基本选择器用法实例详解
May 18 #Javascript
Jquery注册事件实现方法
May 18 #Javascript
jquery中map函数遍历数组用法实例
May 18 #Javascript
jquery使用each方法遍历json格式数据实例
May 18 #Javascript
Jquery使用css方法改变样式实例
May 18 #Javascript
You might like
PHPWind 发帖回帖Api PHP版打包下载
2010/02/08 PHP
php下保存远程图片到本地的办法
2010/08/08 PHP
php函数array_merge用法一例(合并同类数组)
2013/02/03 PHP
浅谈php serialize()与unserialize()的用法
2013/06/05 PHP
php堆排序(heapsort)练习
2013/11/13 PHP
php实现在多维数组中查找特定value的方法
2015/07/29 PHP
mysql_escape_string()函数用法分析
2016/04/25 PHP
Zend Framework数据库操作技巧总结
2017/02/18 PHP
利用ajax和PHP实现简单的流程管理
2017/03/23 PHP
greybox——不开新窗口看新的网页
2007/02/20 Javascript
JQuery 常用方法基础教程
2009/02/06 Javascript
通过jquery还原含有rowspan、colspan的table的实现方法
2012/02/10 Javascript
json数据处理技巧(字段带空格、增加字段、排序等等)
2013/06/14 Javascript
js中call与apply的用法小结
2013/12/28 Javascript
浅析jquery ajax异步调用方法中不能给全局变量赋值的原因及解决方法
2014/01/10 Javascript
JQuery限制复选框checkbox可选中个数的方法
2015/04/20 Javascript
JavaScript核心语法总结(推荐)
2016/06/02 Javascript
详解ES6中的let命令
2020/04/05 Javascript
使用grunt合并压缩js和css文件的方法
2017/03/02 Javascript
Angular2开发——组件规划篇
2017/03/28 Javascript
解决layui中table异步数据请求不支持自定义返回数据格式的问题
2018/08/19 Javascript
vue实现购物车小案例
2019/09/27 Javascript
vue 导航锚点_点击平滑滚动,导航栏对应变化详解
2020/08/10 Javascript
深入解析Python设计模式编程中建造者模式的使用
2016/03/02 Python
详解Python 数据库的Connection、Cursor两大对象
2018/06/25 Python
Python中new方法的详解
2019/01/15 Python
Python查找数组中数值和下标相等的元素示例【二分查找】
2019/02/13 Python
深入了解和应用Python 装饰器 @decorator
2019/04/02 Python
Python求解正态分布置信区间教程
2019/11/20 Python
将tensorflow模型打包成PB文件及PB文件读取方式
2020/01/23 Python
用Python生成HTML表格的方法示例
2020/03/06 Python
Pytorch 卷积中的 Input Shape用法
2020/06/29 Python
python 如何设置守护进程
2020/10/29 Python
Python如何实现Paramiko的二次封装
2021/01/30 Python
葛优非诚勿扰搞笑征婚台词
2014/03/17 职场文书
面试必备的求职信
2014/05/25 职场文书