# Module 历史上,JavaScript 一直没有模块(module)体系,无法将一个大程序拆分成互相依赖的小文件,再用简单的方法拼装起来。其他语言都有这项功能,比如 Ruby 的`require`、Python 的`import`,甚至就连 CSS 都有`@import`,但是 JavaScript 任何这方面的支持都没有,这对开发大型的、复杂的项目形成了巨大障碍。 在 ES6 之前,社区制定了一些模块加载方案,最主要的有 CommonJS 和 AMD 两种。前者用于服务器,后者用于浏览器。ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,完全可以取代现有的 CommonJS 和 AMD 规范,成为浏览器和服务器通用的模块解决方案。 ES6 模块的设计思想,是尽量的静态化,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。CommonJS 和 AMD 模块,都只能在运行时确定这些东西。比如,CommonJS 模块就是对象,输入时必须查找对象属性。 ```javascript // CommonJS模块 let { stat, exists, readFile } = require('fs'); // 等同于 let _fs = require('fs'); let stat = _fs.stat, exists = _fs.exists, readfile = _fs.readfile; ``` 上面代码的实质是整体加载`fs`模块(即加载`fs`的所有方法),生成一个对象(`_fs`),然后再从这个对象上面读取3个方法。这种加载称为“运行时加载”,因为只有运行时才能得到这个对象,导致完全没办法在编译时做“静态优化”。 ES6 模块不是对象,而是通过`export`命令显式指定输出的代码,再通过`import`命令输入。 ```javascript // ES6模块 import { stat, exists, readFile } from 'fs'; ``` 上面代码的实质是从`fs`模块加载3个方法,其他方法不加载。这种加载称为“编译时加载”或者静态加载,即 ES6 可以在编译时就完成模块加载,效率要比 CommonJS 模块的加载方式高。当然,这也导致了没法引用 ES6 模块本身,因为它不是对象。 由于 ES6 模块是编译时加载,使得静态分析成为可能。有了它,就能进一步拓宽 JavaScript 的语法,比如引入宏(macro)和类型检验(type system)这些只能靠静态分析实现的功能。 除了静态加载带来的各种好处,ES6 模块还有以下好处。 - 不再需要`UMD`模块格式了,将来服务器和浏览器都会支持 ES6 模块格式。目前,通过各种工具库,其实已经做到了这一点。 - 将来浏览器的新 API 就能用模块格式提供,不再必要做成全局变量或者`navigator`对象的属性。 - 不再需要对象作为命名空间(比如`Math`对象),未来这些功能可以通过模块提供。 ## 严格模式 ES6 的模块自动采用严格模式,不管你有没有在模块头部加上`"use strict";`。 严格模式主要有以下限制。 - 变量必须声明后再使用 - 函数的参数不能有同名属性,否则报错 - 不能使用`with`语句 - 不能对只读属性赋值,否则报错 - 不能使用前缀0表示八进制数,否则报错 - 不能删除不可删除的属性,否则报错 - 不能删除变量`delete prop`,会报错,只能删除属性`delete global[prop]` - `eval`不会在它的外层作用域引入变量 - `eval`和`arguments`不能被重新赋值 - `arguments`不会自动反映函数参数的变化 - 不能使用`arguments.callee` - 不能使用`arguments.caller` - 禁止`this`指向全局对象 - 不能使用`fn.caller`和`fn.arguments`获取函数调用的堆栈 - 增加了保留字(比如`protected`、`static`和`interface`) 上面这些限制,模块都必须遵守。由于严格模式是 ES5 引入的,不属于 ES6,所以请参阅相关 ES5 书籍,本书不再详细介绍了。 ## export 命令 模块功能主要由两个命令构成:`export`和`import`。`export`命令用于规定模块的对外接口,`import`命令用于输入其他模块提供的功能。 一个模块就是一个独立的文件。该文件内部的所有变量,外部无法获取。如果你希望外部能够读取模块内部的某个变量,就必须使用`export`关键字输出该变量。下面是一个 JS 文件,里面使用`export`命令输出变量。 ```javascript // profile.js export var firstName = 'Michael'; export var lastName = 'Jackson'; export var year = 1958; ``` 上面代码是`profile.js`文件,保存了用户信息。ES6将其视为一个模块,里面用`export`命令对外部输出了三个变量。 `export`的写法,除了像上面这样,还有另外一种。 ```javascript // profile.js var firstName = 'Michael'; var lastName = 'Jackson'; var year = 1958; export {firstName, lastName, year}; ``` 上面代码在`export`命令后面,使用大括号指定所要输出的一组变量。它与前一种写法(直接放置在`var`语句前)是等价的,但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部,一眼看清楚输出了哪些变量。 export命令除了输出变量,还可以输出函数或类(class)。 ```javascript export function multiply(x, y) { return x * y; }; ``` 上面代码对外输出一个函数`multiply`。 通常情况下,`export`输出的变量就是本来的名字,但是可以使用`as`关键字重命名。 ```javascript function v1() { ... } function v2() { ... } export { v1 as streamV1, v2 as streamV2, v2 as streamLatestVersion }; ``` 上面代码使用`as`关键字,重命名了函数`v1`和`v2`的对外接口。重命名后,`v2`可以用不同的名字输出两次。 需要特别注意的是,`export`命令规定的是对外的接口,必须与模块内部的变量建立一一对应关系。 ```javascript // 报错 export 1; // 报错 var m = 1; export m; ``` 上面两种写法都会报错,因为没有提供对外的接口。第一种写法直接输出1,第二种写法通过变量`m`,还是直接输出1。`1`只是一个值,不是接口。正确的写法是下面这样。 ```javascript // 写法一 export var m = 1; // 写法二 var m = 1; export {m}; // 写法三 var n = 1; export {n as m}; ``` 上面三种写法都是正确的,规定了对外的接口`m`。其他脚本可以通过这个接口,取到值`1`。它们的实质是,在接口名与模块内部变量之间,建立了一一对应的关系。 同样的,`function`和`class`的输出,也必须遵守这样的写法。 ```javascript // 报错 function f() {} export f; // 正确 export function f() {}; // 正确 function f() {} export {f}; ``` 另外,`export`语句输出的接口,与其对应的值是动态绑定关系,即通过该接口,可以取到模块内部实时的值。 ```javascript export var foo = 'bar'; setTimeout(() => foo = 'baz', 500); ``` 上面代码输出变量`foo`,值为`bar`,500毫秒之后变成`baz`。 这一点与CommonJS规范完全不同。CommonJS模块输出的是值的缓存,不存在动态更新,详见下文《ES6模块加载的实质》一节。 最后,`export`命令可以出现在模块的任何位置,只要处于模块顶层就可以。如果处于块级作用域内,就会报错,下一节的`import`命令也是如此。这是因为处于条件代码块之中,就没法做静态优化了,违背了ES6模块的设计初衷。 ```javascript function foo() { export default 'bar' // SyntaxError } foo() ``` 上面代码中,`export`语句放在函数之中,结果报错。 ## import 命令 使用`export`命令定义了模块的对外接口以后,其他 JS 文件就可以通过`import`命令加载这个模块。 ```javascript // main.js import {firstName, lastName, year} from './profile'; function setName(element) { element.textContent = firstName + ' ' + lastName; } ``` 上面代码的`import`命令,用于加载`profile.js`文件,并从中输入变量。`import`命令接受一对大括号,里面指定要从其他模块导入的变量名。大括号里面的变量名,必须与被导入模块(`profile.js`)对外接口的名称相同。 如果想为输入的变量重新取一个名字,`import`命令要使用`as`关键字,将输入的变量重命名。 ```javascript import { lastName as surname } from './profile'; ``` `import`后面的`from`指定模块文件的位置,可以是相对路径,也可以是绝对路径,`.js`路径可以省略。如果只是模块名,不带有路径,那么必须有配置文件,告诉 JavaScript 引擎该模块的位置。 ```javascript import {myMethod} from 'util'; ``` 上面代码中,`util`是模块文件名,由于不带有路径,必须通过配置,告诉引擎怎么取到这个模块。 注意,`import`命令具有提升效果,会提升到整个模块的头部,首先执行。 ```javascript foo(); import { foo } from 'my_module'; ``` 上面的代码不会报错,因为`import`的执行早于`foo`的调用。这种行为的本质是,`import`命令是编译阶段执行的,在代码运行之前。 由于`import`是静态执行,所以不能使用表达式和变量,这些只有在运行时才能得到结果的语法结构。 ```javascript // 报错 import { 'f' + 'oo' } from 'my_module'; // 报错 let module = 'my_module'; import { foo } from module; // 报错 if (x === 1) { import { foo } from 'module1'; } else { import { foo } from 'module2'; } ``` 上面三种写法都会报错,因为它们用到了表达式、变量和`if`结构。在静态分析阶段,这些语法都是没法得到值的。 最后,`import`语句会执行所加载的模块,因此可以有下面的写法。 ```javascript import 'lodash'; ``` 上面代码仅仅执行`lodash`模块,但是不输入任何值。 如果多次重复执行同一句`import`语句,那么只会执行一次,而不会执行多次。 ```javascript import 'lodash'; import 'lodash'; ``` 上面代码加载了两次`lodash`,但是只会执行一次。 ```javascript import { foo } from 'my_module'; import { bar } from 'my_module'; // 等同于 import { foo, bar } from 'my_module'; ``` 上面代码中,虽然`foo`和`bar`在两个语句中加载,但是它们对应的是同一个`my_module`实例。也就是说,`import`语句是 Singleton 模式。 ## 模块的整体加载 除了指定加载某个输出值,还可以使用整体加载,即用星号(`*`)指定一个对象,所有输出值都加载在这个对象上面。 下面是一个`circle.js`文件,它输出两个方法`area`和`circumference`。 ```javascript // circle.js export function area(radius) { return Math.PI * radius * radius; } export function circumference(radius) { return 2 * Math.PI * radius; } ``` 现在,加载这个模块。 ```javascript // main.js import { area, circumference } from './circle'; console.log('圆面积:' + area(4)); console.log('圆周长:' + circumference(14)); ``` 上面写法是逐一指定要加载的方法,整体加载的写法如下。 ```javascript import * as circle from './circle'; console.log('圆面积:' + circle.area(4)); console.log('圆周长:' + circle.circumference(14)); ``` ## export default 命令 从前面的例子可以看出,使用`import`命令的时候,用户需要知道所要加载的变量名或函数名,否则无法加载。但是,用户肯定希望快速上手,未必愿意阅读文档,去了解模块有哪些属性和方法。 为了给用户提供方便,让他们不用阅读文档就能加载模块,就要用到`export default`命令,为模块指定默认输出。 ```javascript // export-default.js export default function () { console.log('foo'); } ``` 上面代码是一个模块文件`export-default.js`,它的默认输出是一个函数。 其他模块加载该模块时,`import`命令可以为该匿名函数指定任意名字。 ```javascript // import-default.js import customName from './export-default'; customName(); // 'foo' ``` 上面代码的`import`命令,可以用任意名称指向`export-default.js`输出的方法,这时就不需要知道原模块输出的函数名。需要注意的是,这时`import`命令后面,不使用大括号。 `export default`命令用在非匿名函数前,也是可以的。 ```javascript // export-default.js export default function foo() { console.log('foo'); } // 或者写成 function foo() { console.log('foo'); } export default foo; ``` 上面代码中,`foo`函数的函数名`foo`,在模块外部是无效的。加载的时候,视同匿名函数加载。 下面比较一下默认输出和正常输出。 ```javascript // 第一组 export default function crc32() { // 输出 // ... } import crc32 from 'crc32'; // 输入 // 第二组 export function crc32() { // 输出 // ... }; import {crc32} from 'crc32'; // 输入 ``` 上面代码的两组写法,第一组是使用`export default`时,对应的`import`语句不需要使用大括号;第二组是不使用`export default`时,对应的`import`语句需要使用大括号。 `export default`命令用于指定模块的默认输出。显然,一个模块只能有一个默认输出,因此`export default`命令只能使用一次。所以,`import`命令后面才不用加大括号,因为只可能对应一个方法。 本质上,`export default`就是输出一个叫做`default`的变量或方法,然后系统允许你为它取任意名字。所以,下面的写法是有效的。 ```javascript // modules.js function add(x, y) { return x * y; } export {add as default}; // 等同于 // export default add; // app.js import { default as xxx } from 'modules'; // 等同于 // import xxx from 'modules'; ``` 正是因为`export default`命令其实只是输出一个叫做`default`的变量,所以它后面不能跟变量声明语句。 ```javascript // 正确 export var a = 1; // 正确 var a = 1; export default a; // 错误 export default var a = 1; ``` 上面代码中,`export default a`的含义是将变量`a`的值赋给变量`default`。所以,最后一种写法会报错。 有了`export default`命令,输入模块时就非常直观了,以输入 lodash 模块为例。 ```javascript import _ from 'lodash'; ``` 如果想在一条`import`语句中,同时输入默认方法和其他变量,可以写成下面这样。 ```javascript import _, { each } from 'lodash'; ``` 对应上面代码的`export`语句如下。 ```javascript export default function (obj) { // ··· } export function each(obj, iterator, context) { // ··· } export { each as forEach }; ``` 上面代码的最后一行的意思是,暴露出`forEach`接口,默认指向`each`接口,即`forEach`和`each`指向同一个方法。 如果要输出默认的值,只需将值跟在`export default`之后即可。 ```javascript export default 42; ``` `export default`也可以用来输出类。 ```javascript // MyClass.js export default class { ... } // main.js import MyClass from 'MyClass'; let o = new MyClass(); ``` ## export 与 import 的复合写法 如果在一个模块之中,先输入后输出同一个模块,`import`语句可以与`export`语句写在一起。 ```javascript export { foo, bar } from 'my_module'; // 等同于 import { foo, bar } from 'my_module'; export { foo, boo}; ``` 上面代码中,`export`和`import`语句可以结合在一起,写成一行。 模块的接口改名和整体输出,也可以采用这种写法。 ```javascript // 接口改名 export { foo as myFoo } from 'my_module'; // 整体输出 export * from 'my_module'; ``` 默认接口的写法如下。 ```javascript export { default } from 'foo'; ``` 具名接口改为默认接口的写法如下。 ```javascript export { es6 as default } from './someModule'; // 等同于 import { es6 } from './someModule'; export default es6; ``` 同样地,默认接口也可以改名为具名接口。 ```javascript export { default as es6 } from './someModule'; ``` 另外,ES7有一个[提案](https://github.com/leebyron/ecmascript-more-export-from),简化先输入后输出的写法,拿掉输出时的大括号。 ```javascript // 现行的写法 export {v} from 'mod'; // 提案的写法 export v from 'mod'; ``` ## 模块的继承 模块之间也可以继承。 假设有一个`circleplus`模块,继承了`circle`模块。 ```javascript // circleplus.js export * from 'circle'; export var e = 2.71828182846; export default function(x) { return Math.exp(x); } ``` 上面代码中的`export *`,表示再输出`circle`模块的所有属性和方法。注意,`export *`命令会忽略`circle`模块的`default`方法。然后,上面代码又输出了自定义的`e`变量和默认方法。 这时,也可以将`circle`的属性或方法,改名后再输出。 ```javascript // circleplus.js export { area as circleArea } from 'circle'; ``` 上面代码表示,只输出`circle`模块的`area`方法,且将其改名为`circleArea`。 加载上面模块的写法如下。 ```javascript // main.js import * as math from 'circleplus'; import exp from 'circleplus'; console.log(exp(math.e)); ``` 上面代码中的`import exp`表示,将`circleplus`模块的默认方法加载为`exp`方法。 ## ES6模块加载的实质 ES6模块加载的机制,与CommonJS模块完全不同。CommonJS模块输出的是一个值的拷贝,而ES6模块输出的是值的引用。 CommonJS模块输出的是被输出值的拷贝,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。请看下面这个模块文件`lib.js`的例子。 ```javascript // lib.js var counter = 3; function incCounter() { counter++; } module.exports = { counter: counter, incCounter: incCounter, }; ``` 上面代码输出内部变量`counter`和改写这个变量的内部方法`incCounter`。然后,在`main.js`里面加载这个模块。 ```javascript // main.js var mod = require('./lib'); console.log(mod.counter); // 3 mod.incCounter(); console.log(mod.counter); // 3 ``` 上面代码说明,`lib.js`模块加载以后,它的内部变化就影响不到输出的`mod.counter`了。这是因为`mod.counter`是一个原始类型的值,会被缓存。除非写成一个函数,才能得到内部变动后的值。 ```javascript // lib.js var counter = 3; function incCounter() { counter++; } module.exports = { get counter() { return counter }, incCounter: incCounter, }; ``` 上面代码中,输出的`counter`属性实际上是一个取值器函数。现在再执行`main.js`,就可以正确读取内部变量`counter`的变动了。 ```bash $ node main.js 3 4 ``` ES6模块的运行机制与CommonJS不一样,它遇到模块加载命令`import`时,不会去执行模块,而是只生成一个动态的只读引用。等到真的需要用到时,再到模块里面去取值,换句话说,ES6的输入有点像Unix系统的“符号连接”,原始值变了,`import`输入的值也会跟着变。因此,ES6模块是动态引用,并且不会缓存值,模块里面的变量绑定其所在的模块。 还是举上面的例子。 ```javascript // lib.js export let counter = 3; export function incCounter() { counter++; } // main.js import { counter, incCounter } from './lib'; console.log(counter); // 3 incCounter(); console.log(counter); // 4 ``` 上面代码说明,ES6模块输入的变量`counter`是活的,完全反应其所在模块`lib.js`内部的变化。 再举一个出现在`export`一节中的例子。 ```javascript // m1.js export var foo = 'bar'; setTimeout(() => foo = 'baz', 500); // m2.js import {foo} from './m1.js'; console.log(foo); setTimeout(() => console.log(foo), 500); ``` 上面代码中,`m1.js`的变量`foo`,在刚加载时等于`bar`,过了500毫秒,又变为等于`baz`。 让我们看看,`m2.js`能否正确读取这个变化。 ```bash $ babel-node m2.js bar baz ``` 上面代码表明,ES6模块不会缓存运行结果,而是动态地去被加载的模块取值,并且变量总是绑定其所在的模块。 由于ES6输入的模块变量,只是一个“符号连接”,所以这个变量是只读的,对它进行重新赋值会报错。 ```javascript // lib.js export let obj = {}; // main.js import { obj } from './lib'; obj.prop = 123; // OK obj = {}; // TypeError ``` 上面代码中,`main.js`从`lib.js`输入变量`obj`,可以对`obj`添加属性,但是重新赋值就会报错。因为变量`obj`指向的地址是只读的,不能重新赋值,这就好比`main.js`创造了一个名为`obj`的const变量。 最后,`export`通过接口,输出的是同一个值。不同的脚本加载这个接口,得到的都是同样的实例。 ```javascript // mod.js function C() { this.sum = 0; this.add = function () { this.sum += 1; }; this.show = function () { console.log(this.sum); }; } export let c = new C(); ``` 上面的脚本`mod.js`,输出的是一个`C`的实例。不同的脚本加载这个模块,得到的都是同一个实例。 ```javascript // x.js import {c} from './mod'; c.add(); // y.js import {c} from './mod'; c.show(); // main.js import './x'; import './y'; ``` 现在执行`main.js`,输出的是1。 ```bash $ babel-node main.js 1 ``` 这就证明了`x.js`和`y.js`加载的都是`C`的同一个实例。 ## 浏览器的模块加载 浏览器使用 ES6 模块的语法如下。 ```html ``` 上面代码在网页中插入一个模块`foo.js`,由于`type`属性设为`module`,所以浏览器知道这是一个 ES6 模块。 浏览器对于带有`type="module"`的` ``` 然后,使用`System.import`方法加载模块文件。 ```html ``` 上面代码中的`./app`,指的是当前目录下的app.js文件。它可以是ES6模块文件,`System.import`会自动将其转码。 需要注意的是,`System.import`使用异步加载,返回一个 Promise 对象,可以针对这个对象编程。下面是一个模块文件。 ```javascript // app/es6-file.js: export class q { constructor() { this.es6 = 'hello'; } } ``` 然后,在网页内加载这个模块文件。 ```html ``` 上面代码中,`System.import`方法返回的是一个 Promise 对象,所以可以用`then`方法指定回调函数。