ES6-Module

历史上,JavaScript 一直没有模块(module)体系,无法将一个大程序拆分成互相依赖的小文件,再用简单的方法拼装起来。在 ES6 之前,社区制定了一些模块加载方案,最主要的有 CommonJS 和 AMD 两种。前者用于服务器,后者用于浏览器。ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,完全可以取代 CommonJS 和 AMD 规范,成为浏览器和服务器通用的模块解决方案。

ES6 模块的设计思想是尽量的静态化,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。CommonJS 和 AMD 模块,都只能在运行时确定这些东西,导致完全没办法在编译时做“静态优化”。

1
2
3
4
5
6
7
8
9
10
11
// CommonJS 模块就是对象,输入时必须查找对象属性。这种加载称为“运行时加载”,因为只有运行时才能得到这个对象。
let { stat, exists, readfile } = require('fs');
// 等同于
let _fs = require('fs');
let stat = _fs.stat;
let exists = _fs.exists;
let readfile = _fs.readfile;
// ES6 模块不是对象,而是通过 export 命令显式指定输出的代码,再通过 import 命令输入指定方法,其他方法不加载。这种加载称为“编译时加载”或者静态加载。
import { stat, exists, readFile } from 'fs';

ES6 模块还有以下好处:

  • 静态加载
  • 不再需要 UMD 模块格式了,将来服务器和浏览器都会支持 ES6 模块格式
  • 将来浏览器的新 API 就能用模块格式提供,不再必须做成全局变量或者 navigator 对象的属性
  • 不再需要对象作为命名空间(比如 Math 对象),未来这些功能可以通过模块提供

模块功能主要由两个命令构成:exportimportexport 命令用于规定模块的对外接口,import 命令用于输入其他模块提供的功能。importexport 命令只能在模块的顶层,不能在代码块之中。

export 命令用于规定模块的对外接口,必须与模块内部的变量建立一一对应关系,export 语句输出的接口,与其对应的值是动态绑定关系,即通过该接口,可以取到模块内部实时的值。export 命令可以出现在模块的任何位置,只要处于模块顶层就可以。可以用 as 重命名,可以用不同的名字输出两次。export default 命令,为模块指定默认输出,一个模块只能有一个默认输出,export default 就是输出一个叫做 default 的变量或方法,然后系统允许你为它取任意名字。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
export var firstName = 'Michael';
export var lastName = 'Jackson';
export var year = 1958;
var firstName = 'Michael';
var lastName = 'Jackson';
var year = 1958;
export { firstName, lastName, year };
export {
firstName as f,
lastName as l,
lastName as L
};
export function multiply(x, y) {
return x * y;
};
// 默认输出
export default function () {
console.log('foo');
}
// 因为 export default 命令的本质是将后面的值,赋给 default 变量,所以可以直接将一个值写在 export default 之后
export default 42;

import 命令用于输入其他模块提供的功能。如果想为输入的变量重新取一个名字,import 命令要使用 as 关键字,将输入的变量重命名。import 命令输入的变量都是只读的,因为它的本质是输入接口。如果输入的变量是一个对象,改写属性是允许的。import 命令具有提升效果,会提升到整个模块的头部,首先执行。由于 import 是静态执行,所以不能使用表达式和变量、if 语句,这些只有在运行时才能得到结果的语法结构。import 语句会执行所加载的模块。如果多次重复执行同一句 import 语句,那么只会执行一次,而不会执行多次。除了指定加载某个输出值,还可以使用整体加载,即用星号(*)指定一个对象,所有输出值都加载在这个对象上面,这个对象应该是可以静态分析的,所以不允许运行时改变。加载默认模块时,import 命令可以为该匿名函数指定任意名字。

1
2
3
4
5
6
7
8
9
import { firstName, lastName, year } from './profile.js';
import { lastName as surname } from './profile.js';
import 'lodash';
import * as circle from './circle';
// 加载默认输出
import customName from './export-default';

如果在一个模块之中,先输入后输出同一个模块,import 语句可以与 export 语句写在一起。但需要注意的是,写成一行以后,foobar 实际上并没有被导入当前模块,只是相当于对外转发了这两个接口,导致当前模块不能直接使用 foobar

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
export { foo, bar } from 'my_module';
export { foo as myFoo } from 'my_module';
// 忽略 my_module 模块的 default 方法
export * from 'my_module';
export { default } from 'foo';
export { es6 as default } from './someModule';
export { default as es6 } from './someModule';
export * as ns from "mod";
// 等同于
import * as ns from "mod";
export {ns};

ES2020提案 引入 import() 函数,支持动态加载模块。import 命令能够接受什么参数,import() 函数就能接受什么参数,两者区别主要是后者为动态加载。import() 返回一个 Promise 对象。 import() 函数可以用在任何地方,不仅仅是模块,非模块的脚本也可以使用。import() 函数与所加载的模块没有静态连接关系,这点也是与 import 语句不相同。import() 类似于 Node 的 require 方法,区别主要是前者是异步加载,后者是同步加载。import() 适用于按需加载、条件加载、动态的模块路径。import() 加载模块成功以后,这个模块会作为一个对象,当作 then 方法的参数。

1
2
3
4
5
6
7
8
9
const main = document.querySelector('main');
import(`./section-modules/${someVariable}.js`)
.then(module => {
module.loadPageInto(main);
})
.catch(err => {
main.textContent = err.message;
});

HTML 网页中,浏览器通过 <script> 标签加载 JavaScript 脚本,默认情况下,浏览器是同步加载 JavaScript 脚本。这显然是很不好的体验,所以浏览器允许脚本异步加载,下面就是两种异步加载的语法。

1
2
<script src="path/to/myModule.js" defer></script>
<script src="path/to/myModule.js" async></script>

deferasync 的区别是:defer 要等到整个页面在内存中正常渲染结束(DOM 结构完全生成,以及其他脚本执行完成),才会执行;async 一旦下载完,渲染引擎就会中断渲染,执行这个脚本以后,再继续渲染。一句话,defer 是“渲染完再执行”,async 是“下载完就执行”。另外,如果有多个 defer 脚本,会按照它们在页面出现的顺序加载,而多个 async 脚本是不能保证加载顺序的。

浏览器加载 ES6 模块,也使用 <script> 标签,但是要加入 type="module" 属性。浏览器对于带有 type="module"<script>,都是异步加载,不会造成堵塞浏览器,即等到整个页面渲染完,再执行模块脚本,等同于打开了 <script> 标签的 defer 属性。<script> 标签的 async 属性也可以打开,这时只要加载完成,渲染引擎就会中断渲染立即执行。

1
<script type="module" src="./foo.js"></script>

代码是在模块作用域之中运行,而不是在全局作用域运行。模块内部的顶层变量,外部不可见。模块脚本自动采用严格模式,不管有没有声明use strict。模块之中,顶层的 this 关键字返回 undefined,而不是指向 window。也就是说,在模块顶层使用 this 关键字,是无意义的。同一个模块如果加载多次,将只执行一次。利用顶层的 this 等于 undefined 这个语法点,可以侦测当前代码是否在 ES6 模块之中。

ES6 模块与 CommonJS 模块完全不同:

  • CommonJS 模块输出的是一个值的拷贝,ES6 模块输出的是值的引用
  • CommonJS 模块是运行时加载,ES6 模块是编译时输出接口

Node.js 要求,.mjs 文件总是以 ES6 模块加载,.cjs 文件总是以 CommonJS 模块加载,.js 文件的加载取决于 package.json 里面 type 字段的设置,取值为 modulecommonjs

package.json 文件有两个字段可以指定模块的入口文件:mainexportsexports 字段的优先级高于 main 字段。exports 有多种用法:

  • 可以指定脚本或子目录的别名
  • 别名如果是.,就代表模块的主入口,优先级高于 main 字段,可以简写成 exports字段的值
  • 条件加载,利用 . 这个别名,可以为 ES6 模块和 CommonJS 指定不同的入口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// 指定脚本或子目录的别名
{
"exports": {
"./submodule": "./src/submodule.js"
}
}
import submodule from 'es-module-package/submodule';
// 模块的主入口
{
"exports": {
".": "./main.js"
}
}
// 等同于
{
"exports": "./main.js"
}
// 条件加载
{
"type": "module",
"exports": {
".": {
"require": "./main.cjs",
"default": "./main.js"
}
}
}
// 等同于,如果同时还有其他别名,就不能采用简写
{
"exports": {
"require": "./main.cjs",
"default": "./main.js"
}
}

CommonJS 的一个模块,就是一个脚本文件。require 命令第一次加载该脚本,就会执行整个脚本,然后在内存生成一个对象,以后需要用到这个模块的时候,就会到这个对象上面取值,即使再次执行 require 命令,也不会再次执行该模块,而是到缓存之中取值。也就是说,CommonJS 模块无论加载多少次,都只会在第一次加载时运行一次,以后再加载,就返回第一次运行的结果,除非手动清除系统缓存。CommonJS 模块的重要特性是加载时执行,即脚本代码在 require 的时候,就会全部执行。一旦出现某个模块被”循环加载”,就只输出已经执行的部分,还未执行的部分不会输出。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// a.js
exports.done = false;
var b = require('./b.js');
console.log('在 a.js 之中,b.done = %j', b.done);
exports.done = true;
console.log('a.js 执行完毕');
// b.js
exports.done = false;
var a = require('./a.js');
console.log('在 b.js 之中,a.done = %j', a.done);
exports.done = true;
console.log('b.js 执行完毕');
// main.js
var a = require('./a.js');
var b = require('./b.js');
console.log('在 main.js 之中, a.done=%j, b.done=%j', a.done, b.done);
// 在 b.js 之中,a.done = false
// b.js 执行完毕
// 在 a.js 之中,b.done = true
// a.js 执行完毕
// 在 main.js 之中, a.done=true, b.done=true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// a.mjs
import {bar} from './b';
console.log('a.mjs');
console.log(bar);
export let foo = 'foo';
// b.mjs
import {foo} from './a';
console.log('b.mjs');
console.log(foo);
export let bar = 'bar';
// $ node --experimental-modules a.mjs
// b.mjs
// ReferenceError: foo is not defined

ES6 处理循环加载时,首先,执行 a.mjs 以后,引擎发现它加载了 b.mjs,因此会优先执行 b.mjs,然后再执行 a.mjs。接着,执行 b.mjs 的时候,已知它从 a.mjs 输入了 foo 接口,这时不会去执行 a.mjs,而是认为这个接口已经存在了,继续往下执行。执行到第三行 console.log(foo) 的时候,才发现这个接口根本没定义,因此报错。解决这个问题的方法,就是让 b.mjs 运行的时候,foo 已经有定义了,这可以通过将 foo 写成函数来解决,因为函数具有提升作用。