jQuery使用经验小技巧(推荐)


Posted in Javascript onMay 31, 2016

在开发过很多 jQuery 插件以后,我慢慢的摸索出了一套开发jQuery插件比较标准的结构和模式。这样我就可以复制并粘贴大部分的代码结构,只要专注最主要的逻辑代码就行了。 使用相同的设计模式和架构也让修复bug或者二次开发更容易。一套经过验证的架构可以保证我的插件不出大的问题,不论插件简单还是复杂。我在这里分享10条我总结的经验。

1. 把你的代码全部放在闭包里面

这是我用的最多的一条。但是有时候在闭包外面的方法会不能调用。不过你的插件的代码只为你自己的插件服务,所以不存在这个问题,你可以把所有的代码都放在闭包里面。而方法可能应该放在Prototype方法内部,我们后面会讲到这一点。

/* 三水点靠木 3water.com */
(function($)  
 {  
 //code here  
 })(jQuery);

2. 提供插件的默认选项

你的插件应该会有一些选项是可以让开发者设置的,所以提供恢复默认选项是以有必要的。你可以通过jQuery的extend功能来设置这些选项:

/* 三水点靠木 3water.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  三水点靠木 3water.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 三水点靠木 3water.com 
   }  
}

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

 5. 为什么要设置 Class Prototyping

作为你代码的血与肉,方法和函数应该放在prototype函数内。有两个原因:

▲它可以节省很多内存,因为可以不用重复创建这些方法。

▲引用一个现成的方法比重新创建一个好快很多。

简单的说,prototype就是扩展了一个对象,为它提供方法,而不用在每一个对象中实例化这些方法。这也让你的代码更有条理和高效。一旦你习惯这种开发方式,你会发现它在你将来的项目中为你节省了很多时间。

 6. 如何设置 Class Prototyping

设置一个 prototype 方法有两个部分。首先我们需要创建我们最初的类定义,在多数情况下这就意味着创建一个对象。这个定义包含了每一个对象实例都不同的部分。在我的 Paint jQuery Plugin 插件中,我是这么写的:

/* 三水点靠木 3water.com */
function Canvas(settings)  
{  
  this.settings = settings;  
  this.draw = false;  
  this.canvas = null;     
  this.ctx = null;  
  
  return this;  
}

下面来添加全局的方法:

/* 三水点靠木 3water.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  
  }  
}  /* 三水点靠木 3water.com */

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 选项

这一条不是必须的,但是我发现我所有的插件都包用到了这一条。因为它只需要一点点代码,就能为别人提供一个他可能需要的功能。

基本上,我们只要让开发者能够设置或者获取元素已经存在的值:

varlineWidth = $("#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  
  }  
}  /* 三水点靠木 3water.com */

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

以上这篇jQuery使用经验小技巧(推荐)就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
javascript 写类方式之二
Jul 05 Javascript
Dojo 学习笔记入门篇 First Dojo Example
Nov 15 Javascript
jQuery Flash/MP3/Video多媒体插件
Jan 18 Javascript
IE事件对象(The Internet Explorer Event Object)
Jun 27 Javascript
javascript无刷新评论实现方法
May 13 Javascript
Javascript闭包与函数柯里化浅析
Jun 22 Javascript
jQuery绑定事件的四种方式介绍
Oct 31 Javascript
初学者AngularJS的环境搭建过程
Oct 27 Javascript
jQuery实现上下滚动公告栏详细代码
Nov 21 jQuery
详解JS浏览器事件循环机制
Mar 27 Javascript
详解wepy开发小程序踩过的坑(小结)
May 22 Javascript
vue+element模态框中新增模态框和删除功能
Jun 11 Javascript
JavaScript知识点总结(十)之this关键字
May 31 #Javascript
JavaScript知识点总结(六)之JavaScript判断变量数据类型
May 31 #Javascript
JavaScript知识点总结(五)之Javascript中两个等于号(==)和三个等于号(===)的区别
May 31 #Javascript
JavaScript知识点总结(四)之逻辑OR运算符详解
May 31 #Javascript
JS中使用apply方法通过不同数量的参数调用函数的方法
May 31 #Javascript
jQuery解决IE6、7、8不能使用 JSON.stringify 函数的问题
May 31 #Javascript
利用jQuery实现CheckBox全选/全不选/反选的简单代码
May 31 #Javascript
You might like
php不用正则采集速度探究总结
2008/03/24 PHP
PHP执行linux系统命令的常用函数使用说明
2010/04/27 PHP
PHP中spl_autoload_register()和__autoload()区别分析
2014/05/10 PHP
PHP 数组基本操作小结(推荐)
2016/06/13 PHP
php实现生成带二维码图片并强制下载功能
2018/02/24 PHP
定义select的边框颜色
2008/04/28 Javascript
JS 获取滚动条高度示例代码
2013/10/24 Javascript
js实现html table 行,列锁定的简单实例
2016/10/13 Javascript
canvas 画布在主流浏览器中的尺寸限制详细介绍
2016/12/15 Javascript
Require.JS中的几种define定义方式示例
2017/06/01 Javascript
Vue CL3 配置路径别名详解
2019/05/30 Javascript
vue实现计步器功能
2019/11/01 Javascript
node.js Promise对象的使用方法实例分析
2019/12/26 Javascript
javascript-hashchange事件和历史状态管理实例分析
2020/04/18 Javascript
js仿京东放大镜效果
2020/08/09 Javascript
Python中decorator使用实例
2015/04/14 Python
Python中的模块导入和读取键盘输入的方法
2015/10/16 Python
Python smtplib实现发送邮件功能
2018/05/22 Python
Python RabbitMQ消息队列实现rpc
2018/05/30 Python
Python3批量生成带logo的二维码方法
2019/06/24 Python
解决python运行启动报错问题
2020/06/01 Python
python读取excel数据绘制简单曲线图的完整步骤记录
2020/10/30 Python
CSS3 简单又实用的5个属性
2010/03/04 HTML / CSS
纯HTML5+CSS3制作生日蛋糕代码
2016/11/16 HTML / CSS
HTML5的标签的代码的简单介绍 HTML5标签的简介
2012/05/28 HTML / CSS
HTML5 Canvas像素处理使用接口介绍
2012/12/02 HTML / CSS
到底Java是如何传递参数的?是by value或by reference?
2012/07/13 面试题
通信工程专业毕业生推荐信
2013/12/25 职场文书
机电一体化毕业生自荐信
2014/06/19 职场文书
管理岗位竞聘演讲稿
2014/08/18 职场文书
不遵守课堂纪律的检讨书
2014/09/24 职场文书
南京导游词
2015/02/03 职场文书
2015年机关党建工作总结
2015/05/22 职场文书
工作态度怎么写
2015/06/25 职场文书
施工安全责任协议书
2016/03/23 职场文书
PostgreSQL并行计算算法及参数强制并行度设置方法
2022/04/07 PostgreSQL