JavaScript插件化开发教程 (一)


Posted in Javascript onJanuary 27, 2015

一,开篇分析

Hi,大家!今天这系列文章主要是说说如何开发基于“JavaScript”的插件式开发,我想很多人对”插件“这个词并不陌生,

有的人可能叫“组件”或“部件”,这不重要,关键是看如何设计,如何做一个全方位的考量,这是本文的重点阐述的概念。我想大家对

“jQuery插件的方式”有一定的了解,我们结合这个话题一起讨论一下,最终给出相关的实现方案,来不断提高自己的谁能力。

JavaScript插件化开发教程 (一)

二,进入插件正题

一般来说,jQuery插件的开发分为两种:一种是挂在jQuery命名空间下的全局函数,也可称为静态方法。

另一种是jQuery对象级别的方法,即挂在jQuery原型下的方法,这样通过选择器获取的jQuery对象实例也能共享该方法。

(1),类级别的插件开发

类级别的插件开发最直接的理解就是给"jQuery"类添加类方法,可以理解为添加静态方法。典型的例子就是"$.ajax()"这个函数,将函数定义于jQuery的命名空间中。关于类级别的插件开发可以采用如下几种形式进行扩展:

1.1添加一个全局函数,我们只需如下定义,看代码: 

$.hello = function(){

    alert("Hello,大熊君!") ;

} ;

1.2添加多个全局函数,可采用如下定义:

$.extend({

    hello : function(name){

        // put your code here

    } ,

    world : function(){

        // put your code here

    }

}) ;

说明:”$.extend(target, [object1], [objectN])“(该方法主要用于合并两个或更多对象的内容(属性)到第一个对象,并返回合并后的第一对象。

如果该方法只有一个参数target,则该参数将扩展jQuery的命名空间,即作为静态方法挂在jQuery全局对象下)。

(2),对象级别的插件开发

 对象级别的插件开发需要如下的两种形式:

 2.1通过“$.fn.extend()”为原型动态挂载相关的属性。

(function($){   

    $.fn.extend({   

        pluginName : function(opts){   

            // put your code here

        }   

    }) ;   

})(jQuery) ;  

 2.2直接添加动态属性到原型链上。

 (function($) {     

     $.fn.pluginName = function(){   

         // put your code here  

     } ;   

 })(jQuery) ; 

说明一下:二者是等价的,对于一个jQuery插件,一个基本的函数就可以很好地工作,但是对于复杂一点的插件就需要提供各种各样的方法和私有函数。

你可能会使用不同的命名空间去为你的插件提供各种方法,但是添加过多的命名空间反而会使代码变得混乱,健壮性下降。所以最好的解决办法是适当地定义私有函数和方法。

所以我们通过自执行函数与闭包的结合实现模拟的私有插件单元,就像我们上面的实例中一样。

(三),下面给一个简单的例子看看实现的过程:

(1),“html”片段代码,如下:

<div id="bb" style="width:220px;border:1px solid #ccc;">

   <span></span>

   <div 

       style="margin-top:10px;

       margin-bottom:30px;"

   >8     </div>

</div>           

(2),“data.json”定义如下:

{


"text" : "你好,大熊君{{bb}} !" ;

}

(3),"bb.js"代码如下:

$(function(){

    $("#bb").bigbear() ;

}) ;

(function($){

    $.fn.bigbear = function(opts){

        opts = $.extend({},$.fn.bigbear.defaults,opts) ;

        return this.each(function(){

            var elem = $(this) ;

            elem.find("span").text(opts["title"]) ;

            $.get(opts["url"],function(data){

                elem.find("div").text(data["text"]) ;

            }) ;

        }) ;

    } ;

    $.fn.bigbear.defaults = {

        title : "这是一个简单的测试" ,

        url : "data.json"

    } ;

})(jQuery) ;

运行效果:

JavaScript插件化开发教程 (一)

小结一下

(1)“$.fn.bigbear.defaults”提供插件的默认参数选项一个扩展性良好的插件应该是可以让使用者根据需求自定义参数选项,并控制插件的行为,所以提供恢复默认选项是很有必要的。你可以通过jQuery的extend方法来设置这些选项。

(2),“return this.each(){...}”遍历多个元素并返回jQuery使用Sizzle选择器引擎,Sizzle可以为你的函数提供多元素操作(例如对所有类名相同的元素)。这是jQuery几个优秀的特性之一,在开发插件过程中即使你不准备为你的插件提供多元素支持,但为这做准备仍然是一个很好的方式。另外,jQuery有一个很好的特点就是可以进行方法级联,也可称为链式调用,所以我们不应该破坏这个特性,始终在方法中返回一个元素。

(四),最后总结

(1),jQuery为开发插件提拱了两个方法,分别是:jQuery.fn.extend(object);  给jQuery对象添加方法。
jQuery.extend(object);  为扩展jQuery类本身.为类添加新的方法。

(2),把全部代码放在闭包(一个即时执行函数)里此时闭包相当于一个私有作用域,外部无法访问到内部的信息,并且不会存在全局变量的污染情况。官方创建开发规范的解释是:a) 避免全局依赖;b) 避免第三方破坏;c) 兼容jQuery操作符'$'和'jQuery '。

(3),提供插件的默认参数选项一个扩展性良好的插件应该是可以让使用者根据需求自定义参数选项,并控制插件的行为,所以提供恢复默认选项是很有必要的。你可以通过jQuery的extend方法来设置这些选项

(4),遍历多个元素并返回jQuery使用Sizzle选择器引擎,Sizzle可以为你的函数提供多元素操作(例如对所有类名相同的元素)。这是jQuery几个优秀的特性之一,在开发插件过程中即使你不准备为你的插件提供多元素支持,但为这做准备仍然是一个很好的实践。另外,jQuery有一个很好的特点就是可以进行方法级联,也可称为链式调用,所以我们不应该破坏这个特性,始终在方法中返回一个元素。

(5),一次性代码放在主循环以外这一条很重要,但是常常被忽略。简单的讲,如果你有一段代码是一堆默认值,只需要被实例化一次,而不是每次调用你插件功能的时候都需要实例化,你应该把这段代码放在插件方法的外面。

(6),大家学习完思考一下,如果项目技术选型换了这些插件又是强依赖“jQuery”机制,我们以前写的插件将会不能用(假设不用jQuery的情况),如何做重构那?

明天的文章就会说一下这个问题,并且将会重构插件的关键逻辑,敬请期待。。。

Javascript 相关文章推荐
ie与ff下的event事件使用介绍
Nov 25 Javascript
document.execCommand()的用法小结
Jan 08 Javascript
键盘上一张下一张兼容IE/google/firefox等浏览器
Jan 28 Javascript
jquery中常用的函数和属性详细解析
Mar 07 Javascript
node.js中的forEach()是同步还是异步呢
Jan 29 Javascript
node.js操作mongodb学习小结
Apr 25 Javascript
javascript作用域链(Scope Chain)用法实例解析
Nov 30 Javascript
JS使用eval()动态创建变量的方法
Jun 03 Javascript
laydate.js日期时间选择插件
Jan 04 Javascript
使用contextMenu插件实现Bootstrap table弹出右键菜单
Feb 20 Javascript
JavaScript日期库date-fn.js使用方法解析
Sep 09 Javascript
详解vite+ts快速搭建vue3项目以及介绍相关特性
Feb 25 Vue.js
js的toLowerCase方法用法实例
Jan 27 #Javascript
js的toUpperCase方法用法实例
Jan 27 #Javascript
JS输入用户名自动显示邮箱后缀列表的方法
Jan 27 #Javascript
js判断鼠标左、中、右键哪个被点击的方法
Jan 27 #Javascript
js判断是否按下了Shift键的方法
Jan 27 #Javascript
js获取json元素数量的方法
Jan 27 #Javascript
javascript修改图片src的方法
Jan 27 #Javascript
You might like
对javascript和select部件的结合运用
2006/10/09 PHP
php表单转换textarea换行符的方法
2010/09/10 PHP
PHP利用APC模块实现文件上传进度条的方法
2015/01/26 PHP
javascript textContent与innerText的异同分析
2010/10/22 Javascript
(跨浏览器基础事件/浏览器检测/判断浏览器)经验代码分享
2013/01/24 Javascript
js跑马灯代码(自写)
2013/04/17 Javascript
将input file的选择的文件清空的两种解决方案
2013/10/21 Javascript
jQuery模拟点击A标记示例参考
2014/04/17 Javascript
jquery判断浏览器后退时候弹出消息的方法
2014/08/11 Javascript
jQuery中triggerHandler()方法用法实例
2015/01/19 Javascript
jQuery中each循环的跳出和结束实例
2017/08/16 jQuery
史上最全JavaScript数组去重的十种方法(推荐)
2017/08/17 Javascript
jQuery实现的老虎机跑动效果示例
2018/12/29 jQuery
[01:08:56]DOTA2-DPC中国联赛 正赛 Magma vs LBZS BO3 第一场 2月7日
2021/03/11 DOTA
基于python yield机制的异步操作同步化编程模型
2016/03/18 Python
最大K个数问题的Python版解法总结
2016/06/16 Python
全面了解python字符串和字典
2016/07/07 Python
Python实现在线暴力破解邮箱账号密码功能示例【测试可用】
2017/09/06 Python
Python模拟三级菜单效果
2017/09/11 Python
对Python中gensim库word2vec的使用详解
2018/05/08 Python
Python实现判断一行代码是否为注释的方法
2018/05/23 Python
解决pycharm回车之后不能换行或不能缩进的问题
2019/01/16 Python
python中使用ctypes调用so传参设置遇到的问题及解决方法
2019/06/19 Python
利用pandas合并多个excel的方法示例
2019/10/10 Python
解决安装pyqt5之后无法打开spyder的问题
2019/12/13 Python
使用html2canvas实现浏览器截图的示例代码
2018/01/26 HTML / CSS
网易微博Web App用HTML5开发的过程介绍
2012/06/13 HTML / CSS
德国高端单身人士交友网站:ElitePartner
2018/12/02 全球购物
2013的个人自我评价
2013/12/26 职场文书
寄语十八大感言
2014/02/07 职场文书
央视元宵晚会主持串词
2014/03/25 职场文书
社团活动总结怎么写
2014/06/30 职场文书
任命书标准格式
2015/03/02 职场文书
2015年劳动部工作总结
2015/05/23 职场文书
《夜莺的歌声》教学反思
2016/02/22 职场文书
IDEA2021.2配置docker如何将springboot项目打成镜像一键发布部署
2021/09/25 Java/Android