经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » JS/JS库/框架 » jQuery » 查看文章
插件封装 入门一
来源：cnblogs　　作者：书库术士　　时间：2019/6/28 8:47:35　　对本文有异议

      编写一个jQuery插件开始于给jQuery.fn加入新的功能属性，此处添加的对象属性的名称就是你插件的名称：

  1. 1 jQuery.fn.myPlugin = function(){ 
  2. 2 //你自己的插件代码 
  3. 3 };

     为什么不用$符号呢？为了避免和其他JavaScript库冲突，我们最好将jQuery传递给一个自我执行的封闭程序，jQuery在此程序中映射为符号，这样可以避免$号被其他库覆写。

  1. (function ($) {
  2.     $.fn.myPlugin = function () {
  3.     //你自己的插件代码
  4.     };
  5. })(jQuery);

      在这个封闭程序中，我们可以无限制的使用$符号来表示jQuery函数。

      现在，我们可以开始编写实际的插件代码。 但是，在这之前，我们必须得对插件所处的环境有个概念。 在插件的范围里， this关键字代表了这个插件将要执行的jQuery对象， 这里容易产生一个普遍的误区，因为在其他包含callback的jQuery函数中，this关键字代表了原生的DOM元素。这常常会导致开发者误将this关键字无谓的包在jQuery中，如下所示。

  1. (function ($) {
  2.     $.fn.myPlugin = function () {
  3.         //此处没有必要将this包在$号中如$(this)，因为this已经是一个jQuery对象。
  4.         //$(this)等同于 $($('#element'));
  5.         this.fadeIn('normal', function () {
  6.         //此处callback函数中this关键字代表一个DOM元素
  7.         });
  8.     };
  9. })(jQuery);
  10. $('#element').myPlugin();

　　现在，我们做一个利用.height()返回页面中高度最大的div元素的高度。

  1. (function ($) {
  2.     $.fn.maxHeight = function () {
  3.         var max = 0;
  4.         this.each(function () {
  5.             max = Math.max(max, $(this).height());
  6.         });
  7.         return max;
  8.     };
  9. })(jQuery);
  10. var tallest = $('div').maxHeight(); //返回高度最大的p元素的高度

　　维护Chainability

很多时候，一个插件的意图仅仅是以某种方式修改收集的元素，并把它们传递给链中的下一个方法。 这是jQuery的设计之美，是jQuery如此受欢迎的原因之一。 因此，要保持一个插件的chainability，你必须确保你的插件返回this关键字。

 

  1.  1 (function ($) {
  2.  2     $.fn.lockDimensions = function (type) {
  3.  3         return this.each(function () {
  4.  4             var $this = $(this);
  5.  5             if (!type || type == 'width') {
  6.  6                 $this.width($this.width());
  7.  7             }
  8.  8             if (!type || type == 'height') {
  9.  9                 $this.height($this.height());
  10. 10             }
  11. 11         });
  12. 12     };
  13. 13 })(jQuery);
  14. 14 $('p').lockDimensions('width').CSS('color', 'red');

 

      由于插件返回this关键字，它保持了chainability，这样jQuery收集的元素可以继续被jQuery方法如.css控制。 因此，如果你的插件不返回固有的价值，你应该总是在其作用范围内返回this关键字。 此外，你可能会推断出，传递给插件的参数将会在插件的作用范围内被传递。 因此，在前面的例子，字符串'width'变成了插件的类型参数。

    默认值和选项

     对于比较复杂的和提供了许多选项可定制的的插件，最好有一个当插件被调用的时候可以被拓展的默认设置(通过使用$.extend)。 因此，相对于调用一个有大量参数的插件，你可以调用一个对象参数，包含你了你想覆写的设置。

 

  1. (function ($) {
  2.     $.fn.tooltip = function (options) {
  3.         //创建一些默认值，拓展任何被提供的选项
  4.         var settings = $.extend({
  5.             'location': 'top',
  6.             'background-color': 'blue'
  7.         }, options);
  8.         return this.each(function () {
  9.             // Tooltip插件代码
  10.         });
  11.     };
  12. })(jQuery);
  13. $('p').tooltip({
  14.     'location': 'left'
  15. });

 

    在这个例子中，调用tooltip插件时覆写了默认设置中的location选项，background-color选项保持默认值，所以最终被调用的设定值为：

  1. {
  2.     'location': 'left',
  3.     'background-color': 'blue',
  4. }

 命名空间

      正确命名空间你的插件是插件开发的一个非常重要的一部分。 正确的命名空间，可以保证你的插件将有一个非常低的机会被其他插件或同一页上的其他代码覆盖，也可以可以帮助你更好地跟踪你的方法，事件和数据。

 插件方法

      在任何情况下，一个单独的插件不应该在jQuery.fnjQuery.fn对象里有多个命名空间。

 

  1.  1 (function ($) {
  2.  2     $.fn.tooltip = function (options) {
  3.  3         // this
  4.  4     };
  5.  5     $.fn.tooltipShow = function () {
  6.  6         // is
  7.  7     };
  8.  8     $.fn.tooltipHide = function () {
  9.  9         // bad
  10. 10     };
  11. 11     $.fn.tooltipUpdate = function (content) {
  12. 12         // !!!
  13. 13     };
  14. 14 })(jQuery);

 

   这是不被鼓励的，因为它.fn使.fn命名空间混乱。 为了解决这个问题，你应该收集对象文本中的所有插件的方法，通过传递该方法的字符串名称给插件以调用它们。

 

  1. (function ($) {
  2.     var methods = {
  3.         init: function (options) {
  4.             // this
  5.         },
  6.         show: function () {
  7.             // is
  8.         },
  9.         hide: function () {
  10.             // good
  11.         },
  12.         update: function (content) {
  13.             // !!!
  14.         }
  15.     };
  16.     $.fn.tooltip = function (method) {
  17.         // 方法调用
  18.         if (methods[method]) {
  19.             return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
  20.         } else if (typeof method === 'object' || !method) {
  21.             return methods.init.apply(this, arguments);
  22.         } else {
  23.             $.error('Method' + method + 'does not exist on jQuery.tooltip');
  24.         }
  25.     };
  26. })(jQuery);
  27. //调用init方法
  28. $('p').tooltip();
  29. //调用init方法
  30. $('p').tooltip({
  31.     foo: 'bar'
  32. });
  33. // 调用hide方法 
  34. $('p').tooltip('hide');
  35. //调用Update方法 
  36. $('p').tooltip('update', 'This is the new tooltip content!');

    这种类型的插件架构允许您封装所有的方法在父包中，通过传递该方法的字符串名称和额外的此方法需要的参数来调用它们。 这种方法的封装和架构类型是jQuery插件社区的标准，它被无数的插件在使用，包括jQueryUI中的插件和widgets。

   事件

    一个鲜为人知bind方法的功能即允许绑定事件命名空间。 如果你的插件绑定一个事件，一个很好的做法是赋予此事件命名空间。 通过这种方式，当你在解除绑定的时候不会干扰其他可能已经绑定的同一类型事件。 你可以通过追加命名空间到你需要绑定的的事件通过 ‘.'。

  1. (function ($) {
  2.     var methods = {
  3.         init: function (options) {
  4.             return this.each(function () {
  5.                 $(window).bind('resize.tooltip', methods.reposition);
  6.             });
  7.         },
  8.         destroy: function () {
  9.             return this.each(function () {
  10.                 $(window).unbind('.tooltip');
  11.             })
  12.         },
  13.         reposition: function () {
  14.             //...
  15.         },
  16.         show: function () {
  17.             //...
  18.         },
  19.         hide: function () {
  20.             //...
  21.         },
  22.         update: function (content) {
  23.             //...
  24.         }
  25.     };
  26.     $.fn.tooltip = function (method) {
  27.         if (methods[method]) {
  28.             return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
  29.         } else if (typeof method === 'object' || !method) {
  30.             return methods.init.apply(this, arguments);
  31.         } else {
  32.             $.error('Method ' + method + ' does not exist on jQuery.tooltip');
  33.         }
  34.     };
  35. })(jQuery);
  36. $('#fun').tooltip();
  37. //一段时间之后… … 
  38. $('#fun').tooltip('destroy');

      在这个例子中，当tooltip通过init方法初始化时，它将reposition方法绑定到resize事件并给reposition非那方法赋予命名空间通过追加.tooltip。 稍后， 当开发人员需要销毁tooltip的时候，我们可以同时解除其中reposition方法和resize事件的绑定，通过传递reposition的命名空间给插件。 这使我们能够安全地解除事件的绑定并不会影响到此插件之外的绑定。

  资料来源于http://www.php.cn/js-tutorial-393917.html

 

原文链接：http://www.cnblogs.com/rainwater/p/11098495.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

jQuery热门文章

  • 初涉Ajax
  • jQuery 源码分析(十五) 数据操作模块 val详解
  • select 宽度跟随option内容自适应
  • 日期插件rolldate.js的使用
  • layer.prompt 增加placeholder 提示
  • jQuery实现简单五子棋游戏
  • layui+ztree 树状下拉框
  • 在你身边，为你设计PDF下载高清完整扫描原版
  • jQuery实现扫雷小游戏
  • uni-app通过canvas实现手写签名

    • jQuery推荐文章

  • jQuery实现扫雷小游戏
  • jQuery实现简单五子棋游戏
  • 详解jquery方法属性
  • jquery+h5实现九宫格抽奖特效（前后端代码）
  • jQuery实现弹弹球小游戏
  • jQuery常见事件的监听方式
  • JQuery总结 - 小杨-先生
  • jQuery的链式编程风格
  • 初识Vue2（一）：表单输入绑定（附Demo） - 熊泽-学习中的苦与乐
  • jQuery 笔记

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号