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,超强推荐expand.js
Dec 23 Javascript
使用非html5实现js板连连看游戏示例代码
Sep 22 Javascript
js中typeof的用法汇总
Dec 12 Javascript
JavaScript常用脚本汇总(一)
Mar 04 Javascript
Javascript设计模式之观察者模式(推荐)
Mar 29 Javascript
AngularJs定制样式插入到ueditor中的问题小结
Aug 01 Javascript
通过npm引用的vue组件使用详解
Mar 02 Javascript
判断滚动条滑到底部触发事件(实例讲解)
Nov 15 Javascript
vue实现微信分享链接添加动态参数的方法
Apr 29 Javascript
vue移动端城市三级联动组件使用详解
Jul 26 Javascript
vue实现的多页面项目如何优化打包的步骤详解
Jul 19 Javascript
Element Carousel 走马灯的具体实现
Jul 26 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
PHP 下载文件时自动添加bom头的方法实例
2014/01/10 PHP
ThinkPHP中使用Ueditor富文本编辑器
2015/09/02 PHP
JS的replace方法详细介绍
2012/11/09 Javascript
javascript自动改变文字大小和颜色的效果的小例子
2013/08/02 Javascript
javascript递归回溯法解八皇后问题
2015/04/22 Javascript
浅谈javascript中replace()方法
2015/11/10 Javascript
jQuery遍历json的方法分析
2016/04/16 Javascript
jQuery视差滚动效果网页实现方法经验总结
2016/09/29 Javascript
angular动态删除ng-repaeat添加的dom节点的方法
2017/07/20 Javascript
JS实现页面内跳转的简单代码
2017/09/03 Javascript
nodejs实现范围请求的实现代码
2018/10/12 NodeJs
vue进入页面时滚动条始终在底部代码实例
2019/03/26 Javascript
JS实现checkbox互斥(单选)功能示例
2019/05/04 Javascript
微信小程序实现下拉框功能
2019/07/16 Javascript
Vue实现回到顶部和底部动画效果
2019/07/31 Javascript
JS正则表达式验证端口范围(0-65535)
2020/01/06 Javascript
Javascript实现html转pdf高清版(提高分辨率)
2020/02/19 Javascript
js实现详情页放大镜效果
2020/10/28 Javascript
深入了解Vue动态组件和异步组件
2021/01/26 Vue.js
Python读取键盘输入的2种方法
2015/06/16 Python
python中dir()与__dict__属性的区别浅析
2018/12/10 Python
如何更优雅地写python代码
2019/07/02 Python
python监控进程状态,记录重启时间及进程号的实例
2019/07/15 Python
Python爬虫学习之获取指定网页源码
2019/07/30 Python
Python产生一个数值范围内的不重复的随机数的实现方法
2019/08/21 Python
python树的同构学习笔记
2019/09/14 Python
python基于socket模拟实现ssh远程执行命令
2020/12/05 Python
python中判断数字是否为质数的实例讲解
2020/12/06 Python
Python使用Turtle模块绘制国旗的方法示例
2021/02/28 Python
英国美术用品购物网站:Cass Art
2019/10/08 全球购物
值类型与引用类型有什么不同?请举例说明?并分别列举几种相应的数据类型
2015/10/24 面试题
爱岗敬业演讲稿范文
2014/01/14 职场文书
军神教学反思
2014/02/04 职场文书
应届大学生求职信
2014/07/20 职场文书
办公室主任岗位竞聘书
2015/09/15 职场文书
村党总支部公开承诺书2016
2016/03/25 职场文书