Bootstrap整体框架之JavaScript插件架构

本文实例为大家介绍了JavaScript插件架构的知识点，供大家参考，具体内容如下

1. JavaScript插件架构

如下是插件alert的全部代码，每个插件都定义在如下类似的作用域中：

+function ($) {
 'use strict';

 // ALERT CLASS DEFINITION
 // ======================

 var dismiss = '[data-dismiss="alert"]'
 var Alert = function (el) {
 $(el).on('click', dismiss, this.close)
 }

 Alert.VERSION = '3.3.7'

 Alert.TRANSITION_DURATION = 150

 Alert.prototype.close = function (e) {
 var $this = $(this)
 var selector = $this.attr('data-target')

 if (!selector) {
 selector = $this.attr('href')
 selector = selector && selector.replace(/.*(?=#[^\s]*$)/, '') // strip for ie7
 }

 var $parent = $(selector === '#' ? [] : selector)

 if (e) e.preventDefault()

 if (!$parent.length) {
 $parent = $this.closest('.alert')
 }

 $parent.trigger(e = $.Event('close.bs.alert'))

 if (e.isDefaultPrevented()) return

 $parent.removeClass('in')

 function removeElement() {
 // detach from parent, fire event then clean up data
 $parent.detach().trigger('closed.bs.alert').remove()
 }

 $.support.transition && $parent.hasClass('fade') ?
 $parent
 .one('bsTransitionEnd', removeElement)
 .emulateTransitionEnd(Alert.TRANSITION_DURATION) :
 removeElement()
 }


 // ALERT PLUGIN DEFINITION
 // =======================

 function Plugin(option) {
 return this.each(function () {
 var $this = $(this)
 var data = $this.data('bs.alert')

 if (!data) $this.data('bs.alert', (data = new Alert(this)))
 if (typeof option == 'string') data[option].call($this)
 })
 }

 var old = $.fn.alert

 $.fn.alert  = Plugin
 $.fn.alert.Constructor = Alert


 // ALERT NO CONFLICT
 // =================

 $.fn.alert.noConflict = function () {
 $.fn.alert = old
 return this
 }


 // ALERT DATA-API
 // ==============

 $(document).on('click.bs.alert.data-api', dismiss, Alert.prototype.close)

}(jQuery);

//通过将作用域内的Alert类赋值给jQuery的alert对象的Constructor属性，在IIFE作用域外也可以使用Alert类,比如这行代码
var Alert = $.fn.alert.Constructor 

BootStrap所有的插件在开发中都遵循了同样的规则，也为自定义插件提供了规范和依据(如下三个规则)：
1.HTML布局规则：基于元素自定义属性的布局规则，比如使用类似于data-target的自定义属性
2.JavaScript实现步骤(所有插件都遵循jQuery插件开发的标准步骤，所有事件保持统一的标准)
3.插件调用方法(插件使用方式可以是HTML声明式或者调用式)

1.1 HTML布局规则

基于元素自定义属性的布局规则，类似于data-* 的自定义属性

默认情况下，所有插件都可以通过设置特定的HTML代码和相应的自定义属性来实现。
在页面加载的时候，js代码会自动检测到这些标记，并自动绑定相应的事件，不需要添加额外的代码。

点击按钮之后就会关闭警告框：

<div class="alert">
 <button type="button" class="close" data-dismiss="alert"></button>
 <strong>警告!</strong>你输入的项目不合法！
</div>

下拉菜单：在button按钮上添加data-toggle=”dropdown”属性，单机按钮时，默认隐藏的dropdown-menu会显示

//例子：下拉菜单.html
<div class="btn-group">
 <button type="button" class="btn btn-default" data-toggle="dropdown">
 我的书籍<span class="caret"></span>
 </button>
 <ul class="dropdown-menu">
 <li><a href="#">编程</a></li>
 <li><a href="#">设计</a></li>
 <li><a href="#">深入</a></li>
 </ul>
</div>

1.2 JavaScript实现步骤(所有插件都遵循jQuery插件开发的标准步骤，所有事件保持统一的标准)

BootStrap中所有JavaScript插件走遵循统一的实现步骤，维护方便，自定义插件也方便，步骤如下：

1.声明立即调用函数，比如+function($){“use strict”;…}(jQuery);

参数中传入jQuery的对象，通过参数引入变量，好处是：1.函数内部的符变量代表了局部变量，而不是全局变量中代表jQuery的符变量，以达到防止变量污染的目的。2.内部的代码都是私有代码，外部代码无法访问。只能通过第三步，在.fn上设置了插件(比如.fn.alert=)的形式，通过符变量才能将整个插件通过唯一的借口$.fn.alert暴露出去，从而保护了内部代码。

//function前边的+，主要目的是防止前面有未正常结束的代码(比如遗漏了分号)，导致前后代码被编译器认为是一体的，从而导致代码运行出错。

+function($){
 "use strict";

}(window.jQuery);

2.定义插件类(或者选择器)以及相关原型方法。比如Alert,prototype.close

定义插件类Alert，然后在定义一些原型函数，比如close函数方法。
先定义选择器，所有符合该自定义属性的元素可以触发下面的事件。

var dismiss = '[data-dismiss="alert"]';
var Alert = function(el) {
 //传入元素，如果元素内部有dismiss上设置的自定义属性，则click事件会触发原型上的close方法
 $(el).on('click',dismiss,this.close);
};
Alert.prototype.close = function(e) {

}

3.在jQuery上定义插件并重设插件构造函数，例如$.fn.alert.Constructor=Alert

在jQuery上定义插件，以便通过jQuery.插件名称的方式，也能够使用该插件。

function Plugin(option) {
 return this.each(function () {
 var $this = $(this)
 //获取存储的Alert对象，如果是第一次执行变量data的值为undefined 
 var data = $this.data('bs.alert')
 //缓存没有，就new一个alert对象，存储在元素的jQuery对象上的‘bs.alert'数据字段
 if (!data) $this.data('bs.alert', (data = new Alert(this)))
 //支持传入方法名参数，执行该方法,这里就是data.close()
 if (typeof option == 'string') data[option].call($this)
 })
}
//jQuery插件的定义使用了标准的方式，在fn上进行扩展,在jQuery上定义alert插件
//保留其他插件的$.fn.alert代码(如果定义)以便在noConflict之后，可以继续使用改旧代码
//先备份之前插件的旧代码，以便在后面防冲突的时候使用
var old = $.fn.alert

$.fn.alert  = Plugin
//在附加扩展之后，重新设置插件的构造器(即Constructor属性)，这样就可以通过Constructor属性查询到插件的真实类函数，使用new操作符实例化的时候也不会出错
//js区分大小写，所以这里的Constructor只是一个普通属性，跟constructor不同，通过将作用域内的Alert类赋值给jQuery的alert对象的Constructor属性，在IIFE作用域外也可以使用Alert类
$.fn.alert.Constructor = Alert

不声明第三步的话，HTML声明式的方式也是可以用的。所以第三步是专门为某些喜欢用js代码触发事件的人所准备的。需要注意的是，如果第三步不需要，第四步的方冲突的功能也就没办法用了~

4.防冲突处理(noConflict)，例如$.fn.alert.noConflict

目的是让BootStrap插件和其他UI库的同名插件并存。

$.fn.alert.noConflict = function() {
 //恢复以前的代码
 $.fn.alert = old
 //将$.fn.alert.noConflict()设置为BootStrap的alert插件
 return this
}

比如A库中有个同名.fn.alert插件，则BootStrap在执行之前就通过old先备份了，然后执行.fn.alert.noConflict后就会还原该old对象插件
而使用BootStrap的alert插件的话，则通过var alert = $.fn.alert.noConflict()的形式，将BootStrap的alert插件转移到另外一个变量上，从而继续使用。

5.绑定各种触发事件(data-api)

由于已经为jQuery提供了默认的$.fn.alert扩展插件功能，就可以手工编写js代码来触发事件了。
这里主要是为声明式的HTML触发事件。即：在HTML文档里已经按照布局规则声明了相关的自定义属性(比如data-dismiss=”alert”)，然后通过这里的代码初始化默认的单击事件行为。

/*
ALERT DATA-API
这段JavaScript代码将click委托事件监听器绑定在document元素上，并给click事件赋予命名空间
jQuery将事件绑定在document文档对象上的好处，就是js事件代理的优点
 */
$(document).on('click.bs.alert.data-api',dismiss,Alert.prototype.close)

命名空间的话好处：http://suqing.iteye.com/blog/1533123，具体如下

jQuery1.7开始，jQuery引入了全新的事件绑定机制，jQuery .on() 和 off() 两个函数统一处理事件绑定，也是jQuery触发DOM元素事件的最佳方法。有时候既要trigger手动触发事件，也要从DOM元素上解绑事件，比如:

$('.item').on('click', doThisCoolThing); 
$('.item').on('click', doThisOtherCoolThing); 
$('.item').trigger('click'); // 两个click事件都触发 
$('.item').off('click'); // 两个click事件都解绑  

使用事件命名空间我们可以在创建事件的时候指派名称到事件处理器，并在使用trigger()和off()时通过这个名称指定到特定的函数。调用的时候就可以通过使用不同的命名空间灵活的指派事件. 比如：

$('.item').on('click.navigate', doThisCoolThing); 
$('.item').on('click.notify', doThisOtherCoolThing); 
$('.item').trigger('click.navigate'); // 只有带有navigate这个命名空间的方法才会触发 
$('.item').off('click.notify'); // 只有带有notify这个命名空间的方法才会解绑  

也可以使用多个命名空间，无论使用哪个名字都会生效，通过命名空间代码规范（产品.模块.事件）让事件的层次更清晰：

$('.item').on('click.navigate.notify', doThisCoolThing); 
$('.item').trigger('click.navigate'); // 将触发click事件 
$('.item').off('click.notify'); // 将解绑click事件 

参考资料：
http://www.andismith.com/blog/2011/11/on-and-off/
http://www.andismith.com/blog/2013/02/jquery-on-and-off-namespacing/

1.3 插件调用方法(插件使用方式可以是HTML声明式或者调用式)

1.插件可以js代码调用，都提供多种调用方式(无参数传递，传递对象字面量，直接传入一个需要执行的方法名称字符串)

$("#myModal").modal();
$("#myModal").modal({keyboard:false});
$("#myModal").modal('show');

每个插件都有一个Constructor属性，表示原始的构造函数，比如fn.alert.Constructor也可以通过(‘选择器').data(‘bs.插件名称')获取特定插件的实例

2.html声明式就是直接在html中进行声明data-* 自定义属性即可

若想禁用方法

//命名空间为data-api的全部事件禁用
$(document).off('.data-api');
//禁用特定插件的默认行为，禁用该插件所在命名空间下事件即可
$(document).off('.alert.data-api');
//禁用该alert插件的click事件
$(document).off('click.alert.data-api');

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。

# Bootstrap  # js插件架构  # 移动端脚本框架Hammer.js  # 第一次接触神奇的前端框架vue.js  # 前端框架Vue.js构建大型应用浅析  # AngularJs Javascript MVC 框架  # JavaScript的Backbone.js框架入门学习指引  # JavaScript的Backbone.js框架的一些使用建议整理  # 2014年最火的Node.JS后端框架推荐  # 详细介绍8款超实用JavaScript框架  # 分享别人写的一个小型js框架  # 十大热门的JavaScript框架和库  # 自定义  # 绑定  # 第三步  # 可以使用  # 就会  # 就可以  # 不需要  # 才会  # 域外  # 可以通过  # 选择器  # 类似于  # 的是  # 都是  # 文档  # 都有  # 有个  # 也就  # 多个  # 也要 

相关文章： 简易网站制作视频教程,使用记事本编写一个简单的网页html文件？  公司网站制作价格怎么算,公司办个官网需要多少钱？  如何使用Golang table-driven基准测试_多组数据测量函数效率  清单制作人网站有哪些,近日“兴风作浪的姑奶奶”引起很多人的关注这是什么事情？  如何处理“XML格式不正确”错误 常见XML well-formed问题解决方法  北京网页设计制作网站有哪些,继续教育自动播放怎么设置？  小建面朝正北，A点实际方位是否存在偏差？  上海网站制作网站建设公司,建筑电工证网上查询系统入口？  如何在阿里云完成域名注册与建站？  如何访问已购建站主机并解决登录问题？  宝塔建站助手安装配置与建站模板使用全流程解析  建站之星后台密码遗忘或太弱？如何重置与强化？  如何在Windows环境下新建FTP站点并设置权限？  怀化网站制作公司,怀化新生儿上户网上办理流程？  网站制作中优化长尾关键字挖掘的技巧,建一个视频网站需要多少钱？  如何破解联通资金短缺导致的基站建设难题？  如何零基础在云服务器搭建WordPress站点？  XML的“混合内容”是什么 怎么用DTD或XSD定义  阿里云网站搭建费用解析：服务器价格与建站成本优化指南  如何打造高效商业网站？建站目的决定转化率  图册素材网站设计制作软件,图册的导出方式有几种？  武汉网站设计制作公司,武汉有哪些比较大的同城网站或论坛，就是里面都是武汉人的？  建站上传速度慢？如何优化加速网站加载效率？  IOS倒计时设置UIButton标题title的抖动问题  建站之星导航菜单设置与功能模块配置全攻略  电商平台网站制作流程,电商网站如何制作？  建站之星2.7模板：企业网站建设与h5定制设计专题  建站上市公司网站建设方案与SEO优化服务定制指南  建站之星多图banner生成与模板自定义指南  如何实现建站之星域名转发设置？  Python lxml的etree和ElementTree有什么区别  阿里云高弹*务器配置方案｜支持分布式架构与多节点部署  建站之星代理如何优化在线客服效率？  如何零成本快速生成个人自助网站？  Thinkphp 中 distinct 的用法解析  代刷网站制作软件,别人代刷火车票靠谱吗？  重庆网站制作公司哪家好,重庆中考招生办官方网站？  如何用搬瓦工VPS快速搭建个人网站？  网站制作大概要多少钱一个,做一个平台网站大概多少钱？  Python多线程使用规范_线程安全解析【教程】  股票网站制作软件,网上股票怎么开户？  大连 网站制作,大连天途有线官网？  建站之星价格显示格式升级，你的预算足够吗？  如何选择高性价比服务器搭建个人网站？  建站之星Pro快速搭建教程：模板选择与功能配置指南  简单实现Android验证码  如何快速搭建虚拟主机网站？新手必看指南  如何在建站之星网店版论坛获取技术支持？  桂林网站制作公司有哪些,桂林马拉松怎么报名？  沈阳制作网站公司排名,沈阳装饰协会官方网站？