UDN-企业互联网技术人气社区

板块导航

浏览  : 761
回复  : 5

[jQuery] JQuery插件定义

[复制链接]
芭芭拉的头像 楼主
发表于 2017-2-8 14:51:42 | 显示全部楼层 |阅读模式
  一:导言

  有些WEB开发者,会引用一个JQuery类库,然后在网页上写一写("#"),("#"),("#"),("."),写了几年就对别人说非常熟悉JQuery。我曾经也是这样的人,直到有一次公司里的技术交流,我才改变了自己对自己的看法。

  二:普及JQuery知识

  知识1:用JQuery写插件时,最核心的方法有如下两个:
  1. $.extend(object) 可以理解为JQuery 添加一个静态方法。

  2. $.fn.extend(object) 可以理解为JQuery实例添加一个方法。
复制代码

  基本的定义与调用:
  1. /* $.extend 定义与调用

  2. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

  3. $.extend({ fun1: function () { alert("执行方法一"); } });

  4. $.fun1();

  5. /* $.fn.extend 定义与调用

  6. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

  7. $.fn.extend({ fun2: function () { alert("执行方法2"); } });

  8. $(this).fun2();

  9. //等同于

  10. $.fn.fun3 = function () { alert("执行方法三"); }

  11. $(this).fun3();

  12. 知识2:jQuery(function () { }); 与 (function ($) { })(jQuery);的区别:

  13. jQuery(function () { });

  14. //相当于

  15. $(document).ready(function () { });

  16. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

  17. (function ($) { })(jQuery);

  18. //相当于

  19. var fn = function ($) { };

  20. fn(jQuery);

  21. jQuery(function () { });是某个DOM元素加载完毕后执行方法里的代码。

  22. (function ($) { })(jQuery); 定义了一个匿名函数,其中jQuery代表这个匿名函数的实参。通常用在JQuery插件开发中,起到了定义插件的私有域的作用<span style="line-height: 1.5; background-color: rgb(255, 255, 255);">。</span>
复制代码
  三:开发JQuery插件标准结构

  1,定义作用域:定义一个JQuery插件,首先要把这个插件的代码放在一个不受外界干扰的地方。如果用专业些的话来说就是要为这个插件定义私有作用域。外部的代码不能直接访问插件内部的代码。插件内部的代码不污染全局变量。在一定的作用上解耦了插件与运行环境的依赖。说了这么多,那要怎样定义一个插件的私有作用域?
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. })(jQuery);
复制代码

  别小看了这个作用域,就像c#定义一个类的class关键字一样重要。

  2,为JQuery扩展一个插件:当定义好了JQuery的作用域后,最核心也是最迫切的一步就是为这个JQuery的实例添加一个扩展方法。首先我们为这个Jqury插件命名一个方法,叫easySlider,当在调用这个插件的时候,我们可以通过options来给这个插件传递一些参数。具体的定义方法看如下代码:
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. //step02 插件的扩展方法名称

  4. $.fn.easySlider = function (options) {

  5. }

  6. })(jQuery);
复制代码

  到现在为止,其实一个最简单的JQuery插件就已经完成了。调用的时候可以("#domName").easySlider({}),或者("#domName").easySlider({}),或者("#domName").easySlider({}),或者(".domName").easySlider({})或者更多的方式来调用这个插件。

  3,设置默认值:定义一个JQuery插件,就像定义一个.net控件。一个完美的插件,应该是有比较灵活的属性。我们来看这段代码:。 TextBox控件有Width和Height属性,用户在用TextBox时,可以自由的设置控件的Height和Width,也可以不设置值,因为控件自身有默认值。那准备开发一个JQuery插件时,在用户未指定属性时,应该有默认值,在JQuery可以分两步实现这样的定义,看如下代码step03-a,step03-b。
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. //step03-a 插件的默认值属性

  4. var defaults = {

  5. prevId: 'prevBtn',

  6. prevText: 'Previous',

  7. nextId: 'nextBtn',

  8. nextText: 'Next'

  9. //……

  10. };

  11. //step02 插件的扩展方法名称

  12. $.fn.easySlider = function (options) {

  13. //step03-b 合并用户自定义属性,默认属性

  14. var options = $.extend(defaults, options);

  15. }

  16. })(jQuery);
复制代码

  做程序的人都喜欢创新,改改变量名呀,换一个行呀这些。当看到用var defaults = {}来表示一个默认属性时,在自己写JQuery插件时就想着与众不同,所以用var default01 ={} ,var default02 ={}来表示默认属性了。然后默认属性名五花八门,越来越糟。所以建议在写JQuery插件时,定义默认属性时,都用defaults变量来代表默认属性,这样的代码更具有可读性。

  有人看到这行代码:var options = $.extend(defaults, options),皱起眉头,表示不解。那我们先来看如下代码:
  1. var obj01 = { name: "英文名:Sam Xiao", age: 29, girlfriend: { name: "Yang", age: 29} }

  2. var obj02 = { name: "中文名:XiaoJian", girlfriend: { name: "YY"} };

  3. var a = $.extend(obj01, obj02);

  4. var b = $.extend(true, obj01, obj02);

  5. var c = $.extend({}, obj01, obj02);

  6. var d = $.extend(true,{}, obj01, obj02);
复制代码

  把代码拷贝到开发环境中,分别看一下a,b,c,d的值,就明白了var options = $.extend(defaults, options)的含义了。表示 options 去覆盖了defaults的值,并把值赋给了options。

  在插件环境中,就表示用户设置的值,覆盖了插件的默认值;如果用户没有设置默认值的属性,还是保留插件的默认值。

  4,支持JQuery选择器:JQuery选择器,是JQuery的一个优秀特性,如果我们的插件写来不支持JQuery选择器,确实是一个不小的遗憾。如了使自己的JQuery插件能支持多个选择器,我们的代码应该这样定义:
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. //step03-a 插件的默认值属性

  4. var defaults = {

  5. prevId: 'prevBtn',

  6. prevText: 'Previous',

  7. nextId: 'nextBtn',

  8. nextText: 'Next'

  9. //……

  10. };

  11. //step02 插件的扩展方法名称

  12. $.fn.easySlider = function (options) {

  13. //step03-b 合并用户自定义属性,默认属性

  14. var options = $.extend(defaults, options);

  15. //step4 支持JQuery选择器

  16. this.each(function () {

  17. });

  18. }

  19. })(jQuery);
复制代码

  5,支持JQuery的链接调用:上边的代码看似完美了,其实也不那么完美。到目前为止还不支持链接调用。为了能达到链接调用的效果必须要把循环的每个元素return
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. //step03-a 插件的默认值属性

  4. var defaults = {

  5. prevId: 'prevBtn',

  6. prevText: 'Previous',

  7. nextId: 'nextBtn',

  8. nextText: 'Next'

  9. //……

  10. };

  11. //step02 插件的扩展方法名称

  12. $.fn.easySlider = function (options) {

  13. //step03-b 合并用户自定义属性,默认属性

  14. var options = $.extend(defaults, options);

  15. //step4 支持JQuery选择器

  16. //step5 支持链式调用

  17. return this.each(function () {

  18. });

  19. }

  20. })(jQuery);
复制代码

  这样的定义才能支持链接调用。比如支持这样的调用:$(".div").easySlider({prevId:"",prevText:""}).css({ "border-width": "1", "border-color": "red", "border-bottom-style": "dotted" });

  6,插件里的方法:往往实现一个插件的功能需要大量的代码,有可能上百行,上千行,甚至上万行。我们把这代码结构化,还得借助function。在第一点已经说了,在插件里定义的方法,外界不能直接调用,我在插件里定义的方法也没有污染外界环境。现在就尝试着怎么样在插件里定义一些方法:
  1. //step01 定义JQuery的作用域

  2. (function ($) {

  3. //step03-a 插件的默认值属性

  4. var defaults = {

  5. prevId: 'prevBtn',

  6. prevText: 'Previous',

  7. nextId: 'nextBtn',

  8. nextText: 'Next'

  9. //……

  10. };

  11. //step06-a 在插件里定义方法

  12. var showLink = function (obj) {

  13. $(obj).append(function () { return "(" + $(obj).attr("href") + ")" });

  14. }

  15. //step02 插件的扩展方法名称

  16. $.fn.easySlider = function (options) {

  17. //step03-b 合并用户自定义属性,默认属性

  18. var options = $.extend(defaults, options);

  19. //step4 支持JQuery选择器

  20. //step5 支持链式调用

  21. return this.each(function () {

  22. //step06-b 在插件里定义方法

  23. showLink(this);

  24. });

  25. }

  26. })(jQuery);
复制代码

  步骤step06-a:在插件里定义了一个方法叫showLink(); 这个方法在插件外是不能直接调用的,有点像C#类里的一个私有方法,只能满足插件内部的使用。步骤step06-b演示了怎样调用插件内部的方法。

  四:总结

  开发只要形成了标准,然后再去阅读别人的代码就没有那么吃力了。感觉 赞 的就帮忙顶上去,让更多了了解开发JQuery插件开发的标准。

相关帖子

发表于 2017-2-8 14:52:12 来自手机 | 显示全部楼层
其实js如果遇到web安全类的项目,那就又要做牺牲了,无法读写文件,访问受限。。。哎。。。
使用道具 举报

回复

发表于 2017-2-11 21:23:22 | 显示全部楼层
经常看到”芭芭拉“发帖,辛苦了
使用道具 举报

回复

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于我们
联系我们
  • 电话:010-86393388
  • 邮件:udn@yonyou.com
  • 地址:北京市海淀区北清路68号
移动客户端下载
关注我们
  • 微信公众号:yonyouudn
  • 扫描右侧二维码关注我们
  • 专注企业互联网的技术社区
版权所有:用友网络科技股份有限公司82041 京ICP备05007539号-11 京公网网备安1101080209224 Powered by Discuz!
快速回复 返回列表 返回顶部