背景:
- Javascript 发展初期就是为了实现简单的页面交互逻辑
- 现在cpu,浏览器性能得到极大的提升,很多页面逻辑移动到了客户端(表单验证)
- web2.0 时代的到来,Ajax 技术得到广泛应用,jQuery 等前端库层出不穷,前端代码日益膨胀
导致:
- JavaScript 作为嵌入式的脚本语言的定位动摇
- JavaScript 没有为组织代码提供明显帮助
- 甚至没有类的概念,更没有模块(module)的概念了
- JavaScript 及其简单的代码组织规范不足以驾驭如此庞大规模代码
模块
- 这里我们借鉴一下 Java 语言时怎么处理大规模程序设计的
import java.util.ArrayList;
- 遗憾的是 JavaScript 在设计定位原因,没有提供类似的功能,开发者需要模拟出类似的功能,来隔离、组织复杂的 JavaScript 代码,我们称为模块化
- 一个模块就是实现特定功能的文件,有了模块,我们就可以更方便的使用别人的代码,想要什么功能,就加载什么模块。模块开发需要遵循一定的规范
- 规范形成的过程是痛苦的,前端的先驱在刀耕火种、茹毛饮血的阶段开始,发展到现在初具规模,简单了解一下这段不凡的历程
函数
- 函数一个功能就是实现特定逻辑的一组语句打包
- JavaScript 的作用域就是基于函数的
- 所以把函数作为模块化的第一步是很自然的事情
- 在一个文件里面编写几个相关函数就是最开始的模块了
function fn1(){
statement
}
function fn2(){
statement
}
这样在需要的以后加载函数所在文件,调用函数就可以了
缺点:污染了全局变量,无法保证不与其他模块发生变量名冲突,而且模块成员之间没有什么关系
对象
为了解决上面问题,对象的写法因应而生,可以把所有的模块成员封装在一个对象中
var myModule = {
var a = 1,
var b = 2,
fn1: function(){
},
fn2: function(){
}
}
//调用
myModule.fn2();
这样避免了变量污染,只要保证模块名唯一即可,同时同一模块内的成员也有了一定关系
缺点:外部可以随意修改内部成员,会产生意外的安全问题
myModule.a = 100
立即执行函数
可以通过立即执行函数,来达到隐藏细节的目的
var myModule = (function(){
var a = 1
var b = 2
function fn1(){
}
function fn2(){
}
return {
fn1: fn1,
fn2: fn2
}
})()
这样在模块外部就无法修改我们没有暴露出来的变量名、函数
上述做法就是我们模块化的基础,目前,通行的 JavaScript 模块规范主要有两种:CommonJs
和AMD
CommonJs
- 在网页端没有模块化编程只是页面
JavaScript
逻辑复杂,但也可以工作下去 - 在服务器端却一定要有模块
- 所以虽然
JavaScript
在web
端发展这么多年,第一个流行的模块化规范却由服务器端的JavaScript
应用带来 - CommonJS规范 是由
NodeJS
发扬光大,这标志着JavaScript模块化编程正式登上舞台
简单说明:
- 定义模块:根据
CommonJs
规范,一个单独的文件就是一个模块。每一个模块都是一个单独的作用域,也就是说,在该模块内部定义的变量,无法被其他模块读取,除非定义为global
对象属性 - 模块输出:模块只有要给出口,
module.exports
对象,我们需要把模块希望输出的内容放入该对象 - 加载模块:加载模块使用
require
方法,该方法读取一个文件并执行,返回文件内部的module.exports
对象
//模块定义 myModule.js
var name = 'liu'
function printName(){
console.log(name)
}
function printFullName(firstName){
console.log(firstName + name)
}
module.exports = {
printName: printName,
printFullName: printFullName
}
//加载模块
var nameModule = require('./myModule.js')
nameModule.printName()
不同的实现对require
时的路径有不同要求,一般情况可以省略js
拓展名,可以使用相对路径,也可以使用绝对路径,甚至可以省略路径直接使用模块名(前提是该模块时系统内置模块)
尴尬的浏览器
- 上面的代码
require
是同步的。模块系统需要同步读取模块文件内容,并编译执行以得到模块接口 - 这在服务器端实现和简单,也很自然,然而,想在浏览器端实现问题却很多
问题:浏览器端,加载JavaScript
最佳、最容易的方式是在document
中插入script
标签。但脚本标签天生异步,传统的CommonJS
模块在浏览器环境中无法正常使用加载
解决:
- 思路之一是,开发一个服务器端组件,对模块代码作静态分析,将模块与它的依赖列表一起返回给浏览器端。这很好使,但需要服务器安装额外的组件,并因此要调整一系列底层架构
- 另一种解决思路是,用一套标准模板来分装模块定义,但是对模块应该怎么定义和怎么加载,又产生了分歧
AMD
- AMD (Asynchornous Module Dfinition),中文名是异步模块定义的意思。它是一个在浏览器模块开发的规范
- 由于不是
JavaScript
原生支持,使用 AMD 规范进行页面开发需要用到对应的库函数,也就是大名鼎鼎的ReuireJS
,实际上 AMD 是RequireJS
在推广过程中对模块定义的规范化的产出
requireJS
主要解决两个问题:
- 多个
js
文件可能又依赖关系,被依赖的文件需要早于依赖它的文件加载到浏览器 -
js
加载的时候浏览器会停止页面渲染,加载文件越多,页面失去响应时间越长
看一个使用requireJS
的例子
//定义模块 myModule.js
define(['dependency'], function(){
var name = 'liu'
function printName(){
console.log(name)
}
return {
printName: printName
}
})
//加载模块
require(['module'], function(my){
my.printName()
})
语法
requireJS
定义了一个函数define
,它是全局变量,用来定义模块
define(id?, dependency?, factory)
- id:可选参数,用来定义模块的标识,如果没有提供该参数,脚本文件名(去掉拓展名)
- dependencies:是一个当前模块依赖的模块名称数组
- factory:工厂方法,模块初始化要执行的函数或对象。如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值
在页面上使用require
函数加载模块
require([dependencies], funciton(){
})
require()
函数接收两个参数
- 第一个参数是一个数组,表示所依赖的模块
- 第二个参数是一个回调函数,当前页面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块
require()
函数在加载依赖的函数的时候是异步加载的,这样浏览器不会失去响应,它执行的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题
CMD
CMD (Common Module Definition) 通用模块定义, CMD 规范是国内发展出来的,就像是 AMD 有个requireJS
,CMD 有个浏览器的实现seaJS
,SeaJS
要解决的问题和requireJS
一样,只不过在模块定义方式和模块加载(可以说运行、解析)时机上有所不同
语法
SeaJS
推荐一个模块一个文件,遵循统一的写法
define
define(id?, deps?, factory)
因为 CMD 推荐
- 一个文件一个模块,所以经常就用文件名作为模块
id
- CMD 推荐依赖就近,所以一般不再
define
的参数中写依赖,在factory
中写
factory
有三个参数
function(require, exports, module)
require
require
是factory
函数的第一个参数
requrie(id)
require
是一个方法,接收模块标识作为唯一参数,用来获取其他模块提供的接口
exports
exports
是一个对象,用来向外提供模块接口
module
module
是一个对象,上面存储了与当前模块相关联的一些属性和方法
下面是一个例子
//定义模块 myModule.js
define(function(require, exports, module){
var $ = require('jquery.js')
$('div').addClass('active')
})
//加载模块
seajs.use(['myModule.js'], funciton(my){
})
AMD 与 CMD 的区别
最明显的区别就是:在模块定义时对依赖的处理不同
- AMD 推荐依赖前置,在定义模块的时候就要声明其依赖的模块
- CMD 推荐就近依赖,只有在用到某模块的时候再去
require
这种区别各有优劣,知识语法上的差距,而且requireJS
和SeaJS
都支持对方的写法
AMD 和 CMD 最大的区别是:对依赖模块的执行时机处理不同,注意不是加载的时机,而是方式不同
- 同样都是异步加载模块,AMD 在加载模块完成后就会执行该模块,所有模块都加载执行完后会进入
require
的回调函数,执行主逻辑,这样的效果就是依赖模块的执行顺序和书写顺序不一定一致,看网络速度,哪个先下载下来,哪个先执行,但主逻辑一定在所有依赖加载完成后才执行 - CMD 加载完某个依赖模块后并不执行,知识下载而已,在所有依赖模块加载完成后进入主逻辑,遇到
require
语句的时候才执行对应的模块,这样模块的执行顺序和书写顺序完全一致了
这也是很多人说 AMD 用户体验好,因为没有延迟,依赖模块提前执行了,CMD 性能好,因为只有用户需要的时候才执行的原因
参考
从 CommonJS 到 Sea.js
Javascript模块化编程(一):模块的写法
Javascript模块化编程(二):AMD规范
详解JavaScript模块化开发
require
SeaJS API 快速参考
SeaJS 与 RequireJS 的异同