【笔记】jQuery插件的开发模式

jquery插件分为两类 类级别插件对象级别插件 在JQuery名称空间下申明一个名字接受options参数以控制插件的行为暴露插件的默认设置

jquery插件分为两类

一种是类级别的插件开发，即给jQuery添加新的全局函数，相当于给jQuery类本身添加方法。jQuery的全局函数就是属于jQuery命名空间的函数，另一种是对象级别的插件开发，即给jQuery对象添加方法。下面就两种函数的开发做详细的说明。·

我的理解:

类级别的插件:

$.你插件的命名.方法名()... $.getPicture() .. $.myplugin.getPicture(){} , 显然第二种使用命名空间的方法更为优秀,避免和jquery方法重名.>

对象级别的插件:

$(“#ID”).你插件的命名或方法() {} $(#id).getPicture(){}

---

类级别插件

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

// 1.第一种写法 $.clsLevFun = function() { alert("这是类级别插件!"); } // 2.第二种写法, 优点: 可以写多个函数 $.extend({ clsLevFun: function(){ alert("这是类级别插件!"); }, clsLevFun2: function() { alert("这是类级别插件2!"); } }) $.clsLevFun(); // 调用 $.clsLevFun2(); // 调用 // 另外, 使用命名空间, 更好一些, 比如 $.myplugin = { clsLevFun:function(){ alert("这是类级别插件1!"); }, clsLevFun2: function(param) { alert("这是类级别插件2! param = " + param); } } $.myplugin.clsLevFun(); // 调用 $.myplugin.clsLevFun2("new2"); // 调用

对象级别插件

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

!function($) { $.fn.extend({ objPlugin:function(obj) { $(this).click(function(){ alert("对象级别插件方法1 obj= " + obj ); // 闭包使用一级局部变量obj }) }, domPlugin:function() { alert("对象级别插件方法2"); } }) }(jQuery); $("#box").objPlugin($("#box").text());// 点击box执行 $("#box").domPlugin(); // 自执行 形式2: !function($) { $.fn.pluginName = function(obj) { $(this).click(function(){ alert("对象级别插件方法3 obj= " + obj ); // 闭包使用一级局部变量obj }) } }(jQuery) $("#box").pluginName($("#box").text()); // 点击box执行

注意: 上面定义了一个jQuery函数,形参是$，函数定义完成之后,把jQuery这个实参传递进去.立即调用执行。这样的好处是,我们在写jQuery插件时,也可以使用$这个别名,而不会与prototype引起冲突.

在JQuery名称空间下申明一个名字

这是一个单一插件的脚本。如果你的脚本中包含多个插件，或者互逆的插件（例如： $.fn.doSomething() 和 $.fn.undoSomething()），那么你需要声明多个函数名字。但是，通常当我们编写一个插件时，力求仅使用一个名字来包含它的所有内容。我们的示例插件命名为“highlight“

$.fn.hilight = function() { // Our plugin implementation code goes here. }; // 我们的插件通过这样被调用： $('#myDiv').hilight();

但是如果我们需要分解我们的实现代码为多个函数该怎么办？有很多原因：设计上的需要；这样做更容易或更易读的实现；而且这样更符合面向对象。 这真是一个麻烦事，把功能实现分解成多个函数而不增加多余的命名空间。出于认识到和利用函数是javascript中最基本的类对象，我们可以这样做。就像其他对象一样，函数可以被指定为属性。因此我们已经声明“hilight”为jQuery的属性对象，任何其他的属性或者函数我们需要暴露出来的，都可以在”hilight” 函数中被声明属性。

这段话我的理解就是, 我们不能占用过多的命名空间来实现一个统一的插件, 正确的做法, 应该是把一个插件的多个可用方法作为属性, 声明出来. 我们可以通过传入option对象, option对象中, 可以有多个属性方法

接受options参数以控制插件的行为

让我们为我们的插件添加功能指定前景色和背景色的功能。我们也许会让选项像一个options对象传递给插件函数。例如：

!function($) { $.fn.extend({ myPluginAll: function(options) { var defaults = { foreground: 'red', background: 'yellow' }; var opts = $.extend(defaults, options); console.info(opts); } }) }(jQuery); // 这样调用者就把前景色变成蓝色了 $("#box").myPluginAll({ foreground : 'blue' })

暴露插件的默认设置

我们应该对上面代码的一种改进是暴露插件的默认设置。这对于让插件的使用者更容易用较少的代码覆盖和修改插件。接下来我们开始利用函数对象。 就是告诉使用者, 用defaults的属性, 把defualt暴露给使用者让它直到有这么一个属性.

!function($) { $.fn.myPluginAll = function(options) { var opts = $.extend({}, $.fn.myPluginAll.defaults, options); console.info(opts); } $.fn.myPluginAll.defaults = { foreground: 'red', background: 'yellow', } }(jQuery) // 可以这样设置前景颜色 $("#box").myPluginAll({ foreground:'blue' }) // 同样可以这样改前景颜色 $.fn.myPluginAll.defaults.foreground = 'pink';

---