快速掌握jQuery插件开发


Posted in Javascript onJanuary 19, 2017

在实际开发工作中,总会碰到像滚动,分页,日历等展示效果的业务需求,对于接触过jQuery以及熟悉jQuery使用的人来说,首先想到的肯定是寻找现有的jQuery插件来满足相应的展示需求。目前页面中常用的一些组件,都有多种jQuery插件可供选择,网络上也有很多专门收集jQuery插件的网站。利用jQuery插件确实可以给我们的开发工作带来便捷,但是如果只是会简单使用,而对其中的原理不甚了解,那么在使用过程中碰到问题或者对插件进行定制开发时就会有诸多疑惑。本文的目的就是可以快速了解jQuery插件的开发原理以及掌握jQuery开发的基本技能。

进行jQuery插件开发前,首先要知道两个问题:什么是jQuery插件?jQuery插件如何使用?

第一个问题,jQuery插件就是用来扩展jQuery原型对象的一个方法,简单来说就是jQuery插件是jQuery对象的一个方法。其实回答了第一个问题,也就知道第二个问题的答案了,jQuery插件的使用方式就是jQuery对象方法的调用。

我们先看个例子:$("a").css("color","red")。我们知道每个jQuery对象都会包含jQuery中定义的DOM操作方法,这里使用$方法来选择a元素,返回一个a元素的jQuery对象,这个对象就可以使用jQuery中定义的DOM操作方法。那么jQuery对象是如何获取这些方法的呢?其实jQuery内部定义了一个jQuery.fn对象,查看jQuery源码可以发现jQuery.fn=jQuery.prototype,也就是说jQuery.fn对象是jQuery的原型对象,jQuery的DOM操作方法都在jQuery.fn对象上定义的,然后jQuery对象就可以通过原型继承这些方法。

基础版jQuery插件

知道了上面这些知识,我们就可以来写一个简单的jQuery插件。假如我现在需要一个jQuery插件用来改变标签内容颜色,就可以按下面的方式来实现这个插件:

$.fn.changeStyle = function(colorStr){
 this.css("color",colorStr);
 }

然后按下面的方式来使用插件:

$("p").changeStyle("red");

插件调用的时候,插件内部的this就是当前调用插件的jQuery对象,这样的话每个使用$()方法选择的标签,在调用changeStyle()插件时都会使用css()方法重设color样式。

满足链式调用的jQuery插件

链式调用时jQuery的一大特色,一个通用的插件应该遵循jQuery风格,满足链式调用要求。实现链式调用的方式也很简单:

$.fn.changeStyle = function(colorStr){
 this.css("color",colorStr);
 return this;
 }

然后使用的时候就可以链式调用其他方法了:

$("p").changeStyle("red").addClass("red-color");

实现链式调用的关键点就一行代码return this,插件中加了这行代码,那么在插件执行完之后,就会把当前的jQuery对象返回,然后就可以在插件方法后面继续调用其它jQuery方法。

防止$符号污染的jQuery插件

有很多js库都会使用$符号,虽然jQuery可以使用jQuery.noConflict()方法交出$符号的使用权,但是如果定义插件的时候,使用$.fn对象来定义的,那么这些插件使用的时候就会受到其它使用$变量的js库的影响。对于这种情况,我们可以使用立即执行函数通过传参的方式封装插件。形式如下:

(function($){
 $.fn.changeStyle = function(colorStr){
 this.css("color",colorStr); 
 return this;
 }
 }(jQuery));

因为使用了立即执行函数,所以此时的$只属于这个立即执行函数的函数作用域,这样就可以避免$符号的污染。

可以接受参数的jQuery插件

继续上面的例子,假如我还想为这个插件添加一个设置标签元素内容文字大小的功能,那么我可以这么来实现:

(function($){
 $.fn.changeStyle = function(colorStr,fontSize){
 this.css("color",colorStr).css("fontSize",fontSize+"px"); 
 return this;
 }
}(jQuery));

上面这种插件传参方式适用于参数比较少的情况,如果需要传给插件内部的参数比较多,我们可以定义一个参数对象,然后把需要传给插件的参数放在参数对象中。插件定义时如下:

(function($){
 $.fn.changeStyle = function(option){
 this.css("color",option.colorStr).css("fontSize",option.fontSize+"px"); 
 return this;
 }
}(jQuery));

使用方式:$("p").changeStyle({colorStr:"red",fontSize:14});

把参数放到一个对象中传给插件还有一个好处就是我们可以在插件内部为一些参数定义一些缺省值,例如:

(function($){
 $.fn.changeStyle = function(option){
 var defaultSetting = { colorStr:"green",fontSize:12};
 var setting = $.extend(defaultSetting,option);
 this.css("color",setting.colorStr).css("fontSize",setting.fontSize+"px"); 
 return this;
 }
}(jQuery));

上面的代码用到了$.extend方法,这个方法在这里的用法就是合并两个对象,即把后面一个对象的存在的属性值赋值给第一个对象,具体用法可以参考这里。$.extend方法还有一种作用是用来扩展jQuery对象本身。

这样定义的插件,我们在使用时如果不传fontSize,那么使用这个插件的jQuery对象标签的内容会被设置成默认的12px。

使用方式:$("p").changeStyle({colorStr:"red"});

注意:在为插件定义默认参数时,一定要把默认参数写在插件方法内部,这样默认参数的作用域就在插件内部。

总结

定义插件的方式除了上面说的用$.fn来定义,还有另外一种方式来定义插件,那就是使用$.fn.extend方法。类似下面的写法:

(function($){
 $.fn.extend({ 
 changeStyle:function(option){ 
 var defaultSetting = { colorStr:"green",fontSize:12};
 var setting = $.extend(defaultSetting,option);
 this.css("color",setting.colorStr).css("fontSize",setting.fontSize+"px"); 
 return this; 
 }
 });
}(jQuery));

PS:$.extend方法和$.fn.extend方法都可以用来扩展jQuery功能,通过阅读jQuery源码我们可以发现这两个方法的本质区别,那就是$.extend方法是在jQuery全局对象上扩展方法,$.fn.extend方法是在$选择符选择的jQuery对象上扩展方法。所以扩展jQuery的公共方法一般用$.extend方法,定义插件一般用$.fn.extend方法。

参考资料

How to Create a Basic Plugin

http://www.jianshu.com/p/518d424d4994

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持三水点靠木!

Javascript 相关文章推荐
javascript 多种搜索引擎集成的页面实现代码
Jan 02 Javascript
setTimeout的延时为0时多个浏览器的区别
May 23 Javascript
一样的table?不一样的table(可编辑状态table)
Sep 19 Javascript
js弹出框轻量级插件jquery.boxy使用介绍
Jan 15 Javascript
用函数模板,写一个简单高效的 JSON 查询器的方法介绍
Apr 17 Javascript
js控制容器隐藏出现防止样式变化的两种方法
Apr 25 Javascript
javascript中call和apply的用法示例分析
Apr 02 Javascript
JavaScript中有关一个数组中最大值和最小值及它们的下表的输出的解决办法
Jul 01 Javascript
Vue 动态组件与 v-once 指令的实现
Feb 12 Javascript
Vue 理解之白话 getter/setter详解
Apr 16 Javascript
浅析Vue中拆分视图层代码的5点建议
Aug 15 Javascript
基于vue+echarts 数据可视化大屏展示的方法示例
Mar 09 Javascript
Web 开发中Ajax的Session 超时处理方法
Jan 19 #Javascript
JavaScript DOM节点操作实例小结(新建,删除HTML元素)
Jan 19 #Javascript
使用JavaScript触发过渡效果的方法
Jan 19 #Javascript
详解支持Angular 2的表格控件
Jan 19 #Javascript
原生JS实现几个常用DOM操作API实例
Jan 19 #Javascript
JS生成一维码(条形码)功能示例
Jan 19 #Javascript
EasyUi 打开对话框后控件赋值及赋值后不显示的问题解决办法
Jan 19 #Javascript
You might like
使用PHP强制下载PDF文件示例
2014/01/17 PHP
php中数字0和空值的区别分析
2014/06/05 PHP
php设计模式之简单工厂模式详解
2014/09/04 PHP
Yii2第三方类库插件Imagine的安装和使用
2017/07/06 PHP
JSON JQUERY模板实现说明
2010/07/03 Javascript
javascript 闭包
2011/09/15 Javascript
JavaScript 函数惰性载入的实现及其优点介绍
2013/08/12 Javascript
form.submit()不能提交表单的原因分析
2014/10/23 Javascript
深入解读JavaScript中的Hoisting机制
2015/08/12 Javascript
解析jQueryEasyUI的使用
2016/11/22 Javascript
vue.js从安装到搭建过程详解
2017/03/17 Javascript
微信小程序 参数传递实例代码
2017/03/20 Javascript
解决bootstrap中使用modal加载kindeditor时弹出层文本框不能输入的问题
2017/06/05 Javascript
JS实现动态生成html table表格的方法分析
2018/07/11 Javascript
详解Vue依赖收集引发的问题
2019/04/22 Javascript
ES6基础之字符串和函数的拓展详解
2019/08/22 Javascript
js键盘事件实现人物的行走
2020/01/17 Javascript
[50:29]2014 DOTA2华西杯精英邀请赛 5 24 DK VS iG
2014/05/26 DOTA
python中self原理实例分析
2015/04/30 Python
Python实现返回数组中第i小元素的方法示例
2017/12/04 Python
Python实现matplotlib显示中文的方法详解
2018/02/06 Python
python后端接收前端回传的文件方法
2019/01/02 Python
Python 中的pygame安装与配置教程详解
2020/02/10 Python
快速解决Django关闭Debug模式无法加载media图片与static静态文件
2020/04/07 Python
mysql有关权限的表都有哪几个
2015/04/22 面试题
水产养殖学应届生求职信
2013/09/29 职场文书
开办化妆品公司创业计划书
2013/12/26 职场文书
试用期员工考核制度
2014/01/22 职场文书
汽车队司机先进事迹材料
2014/02/01 职场文书
2015年药房工作总结
2015/04/25 职场文书
2015年美容师个人工作总结
2015/10/14 职场文书
2016中秋节月饼促销广告语
2016/01/28 职场文书
SQL Server基本使用和简单的CRUD操作
2021/04/05 SQL Server
Python Socket编程详解
2021/04/25 Python
Elasticsearch 批量操作
2022/04/19 Python