初次进行 jQuery 插件开发时,我们往往无从下手。虽然可以按照官方提供的格式简单开发,但很多时候效果并不理想,一不小心就造出一个很"烂"的插件:难以维护、难以扩展、使用繁琐、性能不佳……在不断实践中,有些问题被有效规避,但也带来了新的困惑:在纷繁复杂的 jQuery 插件开发模式中,究竟哪一种才是最好的呢?
如果能提供一个模板,通过一定的约束与规范帮助开发者走出插件开发的"迷惘",那该多好。这里就介绍一个实际开发中最常用的模板插件——jQuery Boilerplate。
它并不是 jQuery 插件开发的银弹,也没有追求为各种模式提供完美解决方案,它的目标只是提供一个最基础的模板,让初学者只需在此基础上做相应修改即可。下面这个基础模板是不是觉得很熟悉?没错,Bootstrap 采用的就是这个模式:
// 这个分号的作用是防止和其他jquery插件合并时,别人不规范的jquery插件忘记使用分号结束
// 影响到我们当前的插件,导致无法运行的问题。
;(function ( $, window, document, undefined ) {
// undefined作为形参的目的是因为在es3中undefined是可以被修改的
// window和document本身是全局变量,作为形参传入避免了去外层查找,提高了效率
// 声明默认属性对象
var pluginName = "defaultPluginName",
defaults = { propertyName: "value" };
// 构造函数
function Plugin ( element, options ) {
this.element = element;
// 将默认属性对象和传递的参数对象合并到第一个空对象中
this.settings = $.extend( {}, defaults, options );
this._defaults = defaults;
this._name = pluginName;
this.init();
}
// 为了避免和原型对象Plugin.prototype的冲突,采用继承原型对象的方法
$.extend(Plugin.prototype, {
init: function () {
// 初始化,你可以在这里直接使用this.element或者this.settings
console.log("xD");
},
yourOtherFunction: function () {
// some logic
}
});
// 对构造函数的一个轻量级封装,防止产生多个实例
$.fn[ pluginName ] = function ( options ) {
this.each(function() {
if ( !$.data( this, "plugin_" + pluginName ) ) {
$.data( this, "plugin_" + pluginName, new Plugin( this, options ) );
}
});
// 方便链式调用
return this;
};
})( jQuery, window, document );
这是一个轻量级的基础模板,能满足开发中的大部分需求,例如对象只实例化一次、链式调用、默认参数,以及公有和私有方法的调用。
但在实际开发中,尤其是有一定规模的组件开发中,我们还面临命名空间冲突、插件可扩展性以及公有方法如何方便调用等问题。为此,jQuery Boilerplate 提供了几种不同模式的组件开发方式供你选择:
轻量级(基础)模式:为初学者提供的简单通用模板,包括基础的默认对象、简单的构造函数、默认参数与传递参数的合并,以及防止对象多次实例化的构造函数封装。
Widget factory 工厂模式:没错,这就是 jQuery UI 使用的典型模式,以面向对象的方式构建复杂有状态的组件。jQuery UI 中的大部分组件都依赖于 widget factory 基础组件,该模板提供了包括事件触发方法在内的大部分默认方法。
Widget factory + RequireJS:使用 RequireJS 对 Widget factory 进行简单封装,使其支持 AMD 模块化加载规范。
Namespaced 命名空间模式:在与其他插件一起使用时,采用命名空间避免相互冲突。
总之,你可以根据项目规模和个人偏好,选择最适合自己的那一种模式来组织代码。