前言:
模块化的开发方式可以提高代码复用率,方便进行代码的管理。通常一个文件就是一个模块,有自己的作用域,只向外暴露特定的变量和函数。目前流行的js模块化规范有CommonJS、AMD、CMD以及ES6的模块系统。
一、CommonJS(服务器端)
- 一个文件就是一个模块,每个模块都是单独的作用域,除非定义为global对象的属性
- 输出模块module.exports对象
- 加载模块使用require方法
- 使用同步的方式加载模块,适合node.js。在服务端,模块文件都存在本地磁盘,读取非常快,所以不会有问题。但在浏览器端,限于网络原因,更合理的方案是使用异步加载
- 模块可以多次加载,但是只会在第一次加载时运行一次,然后运行结果就被缓存了,以后再加载,就直接读取缓存结果。要想让模块再次运行,必须清除缓存
- 浏览器不兼容CommonJS的根本原因是因为缺少Node.js的四个环境变量:Global,Module,exports,require
- CommonJS的加载机制,加载的是被输入值的拷贝,一旦某个值被导出了,那么模块内部的变化将不会在影响该值
// 定义模块math.js
var basicNum = 0;
function add(a, b) {
return a + b;
}
module.exports = { //在这里写上需要向外暴露的函数、变量
add: add,
basicNum: basicNum
}
// 引用自定义的模块时,参数包含路径,可省略.js
var math = require('./math');
math.add(2, 5);
问:在CommonJS里也支持 exports.属性 的方式导出,那么 exports 和 module.exports 两者有什么区别吗?
答:Node为每一个模块提供了一个 exports 变量(可以说是一个对象),指向 module.exports。这相当于每个模块中都有一句这样的命令 var exports = module.exports;而我们加载模块时就是读取的 exports 变量,但是当module.exports 与exports同时存在时,导出的模块为module.exports的值,推测应该是module.exports将exports上的值给覆盖了
// a.js
var name = 'Tom';
// 第一种情况,既不使用exports也不使用module.exports
module.exports = name; // 第一种情况只使用module.exports
exports.name = name; // 第二种情况只使用exports
exports.age = 23;
module.exports = { // 第三种情况同时使用module.exports和exports
name: 'Joe'
};
exports.age = 18;
// index.js
var a = require('./a');
console.log(a);
// 第一种情况: {}
// 第二种情况: 'Tom'
// 第三种情况: {name: 'Tom', age: 23}
// 第四种情况: {name: 'Joe} 导出的是module.exports,与书写顺序无关
详情可以看阮老师的教程,参考链接:http://javascript.ruanyifeng.com/nodejs/module.html#toc14
二、ES6
ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,旨在成为浏览器和服务器通用的模块解决方案。其模块功能主要由两个命令构成:export和import。export命令用于规定模块的对外接口,import命令用于输入其他模块提供的功能。
/** 定义模块 math.js **/
var basicNum = 0;
var add = function (a, b) {
return a + b;
};
export { basicNum, add };
/** 引用模块 **/
import { basicNum, add } from './math';
function test(ele) {
ele.textContent = add(99 + basicNum);
}
如上例所示,使用import命令的时候,用户需要知道所要加载的变量名或函数名。其实ES6还提供了export default命令,为模块指定默认输出,对应的import语句不需要使用大括号。这也更趋近于ADM的引用写法。
/** export default **/
//定义输出
export default { basicNum, add };
//引入
import math from './math';
function test(ele) {
ele.textContent = math.add(99 + math.basicNum);
}
ES6的模块不是对象,import命令会被 JavaScript 引擎静态分析,在编译时就引入模块代码,而不是在代码运行时加载,所以无法实现条件加载。ES6静态加载的设计思想,使得在编译时就可以确定模块的依赖关系,以及输入、输出的变量。
三、CommonJS和ES6的差异
1. CommonJS 模块输出的是一个值的拷贝,ES6 模块输出的是值的引用。
- CommonJS 模块输出的是值的拷贝,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。
- ES6 模块的运行机制与 CommonJS 不一样。JS 引擎对脚本静态分析的时候,遇到模块加载命令import,就会生成一个只读引用。等到脚本真正执行时,再根据这个只读引用,到被加载的那个模块里面去取值。换句话说,ES6 的import有点像 Unix 系统的“符号连接”,原始值变了,import加载的值也会跟着变。因此,ES6 模块是动态引用,并且不会缓存值,模块里面的变量绑定其所在的模块。
2. CommonJS 模块是运行时加载,ES6 模块是编译时输出接口。
- 运行时加载: CommonJS 模块就是对象;即在输入时是先加载整个模块,生成一个对象,然后再从这个对象上面读取方法,这种加载称为“运行时加载”。
- 编译时加载: ES6 模块不是对象,而是通过 export 命令显式指定输出的代码,import时采用静态命令的形式。即在import时可以指定加载某个输出值,而不是加载整个模块,这种加载称为“编译时加载”。
异步加载模块(浏览器端)
面对的问题:
- 多个文件的依赖关系,被依赖的文件需要在依赖他的文件之前加载到浏览器
- js加载时,浏览器会停止页面的渲染,加载的文件越多,页面失去相应的时间越长
四、AMD&Require.js
AMD(Asynchronous Module Definition)翻译过来就是异步模块化定义,是一个模块化开发的规范。AMD规范采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。使用require.js实现AMD规范的模块化:用require.config()指定引用路径等,用define()定义模块,用require()加载模块。
首先我们需要引入require.js文件和一个入口文件main.js。main.js中配置require.config()并规定项目中用到的基础模块。
/** 网页中引入require.js及main.js **/
<script src="js/require.js" data-main="js/main"></script>
/** main.js 入口文件/主模块 **/
// 首先用config()指定各模块路径和引用名
require.config({
baseUrl: "js/lib",
paths: {
"jquery": "jquery.min", //实际路径为js/lib/jquery.min.js
"underscore": "underscore.min",
}
});
// 执行基本操作
require(["jquery","underscore"],function($,_){
// some code here
});
引用模块的时候,我们将模块名放在[]中作为reqiure()的第一参数;如果我们定义的模块本身也依赖其他模块,那就需要将它们放在[ ]中作为define()的第一参数。
五、CMD&Sea.js
CMD(Common Moudle Definition)翻译过来即通用模块定义,CMD是另一种js模块化方案,它与AMD很类似,不同点在于:AMD 推崇依赖前置、提前执行,CMD推崇依赖就近、延迟执行。此规范其实是在sea.js推广过程中产生的。
/** AMD写法 **/
define(["a", "b", "c", "d", "e", "f"], function(a, b, c, d, e, f) {
// 等于在最前面声明并初始化了要用到的所有模块
a.doSomething();
if (false) {
// 即便没用到某个模块 b,但 b 还是提前执行了
b.doSomething()
}
});
/** CMD写法 **/
define(function(require, exports, module) {
var a = require('./a'); //在需要时申明
a.doSomething();
if (false) {
var b = require('./b');
b.doSomething();
}
});
/** sea.js **/
// 定义模块 math.js
define(function(require, exports, module) {
var $ = require('jquery.js');
var add = function(a,b){
return a+b;
}
exports.add = add;
});
// 加载模块
seajs.use(['math.js'], function(math){
var sum = math.add(1+2);
});
六、AMD和CMD的区别——对于依赖模块的执行时机不同
- AMD依赖前置,在定义模块时就声明其所要依赖的模块
- CMD是按需加载依赖,在用到那个模块再去require
- AMD在使用前就准备好,CMD是用到了再去准备模块
- AMD的用户体验好,因为提前加载了模块;CMD的性能好,因为只有在用户需要的时候才加载
补充:JS加载模块肯定是异步的,那么AMD / CMD,如何做到在执行代码过程中,解析模块并且出现阻塞呢?
AMD / CMD 在编译过程,会将定义的函数转为字符串,然后使用正则表达式去匹配 require ,并获取所需加载模块的地址,然后提前加载模块
【注意】参考博客:http://blog.liucunyang.cn/2017/12/01/module/#more
https://juejin.im/post/5ab28582518825611a40603e