Modules 模块

一、Modules

ES6 新增了模块功能，可以取代 CommonJS 和 AMD 规范，成为浏览器和服务器通用的模块解决方案。

1、设计思想

尽量的静态化，使得编译时就能确定模块的依赖关系，以及输入和输出的变量。CommonJS 和 AMD 模块，都只能在运行时确定这些东西。

import { stat, exists, readFile } from 'fs';

上面代码的实质是从 fs 模块加载 3 个方法，其他方法不加载。这种加载称为“编译时加载”或者静态加载，即 ES6 可以在编译时就完成模块加载，效率要比 CommonJS 模块的加载方式高。当然，这也导致了没法引用 ES6 模块本身，因为它不是对象。

2、优势

由于 ES6 模块是编译时加载，使得静态分析成为可能。有了它，就能进一步拓宽 JavaScript 的语法，比如引入宏（macro）和类型检验（type system）这些只能靠静态分析实现的功能。

除了静态加载带来的各种好处，ES6 模块还有以下好处。

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

本章介绍 ES6 模块的语法，下一章介绍如何在浏览器和 Node 之中，加载 ES6 模块。

3、自动采用严格模式

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）

上面这些限制，模块都必须遵守。尤其需要注意 this 的限制。ES6 模块之中，顶层的 this 指向 undefined，即不应该在顶层代码使用 this。

二、export

export 命令用于规定模块的对外接口。

一个模块就是一个独立的文件。该文件内部的所有变量，外部无法获取。如果希望外部能够读取模块内部的某个变量，就必须使用 export 关键字输出该变量。下面是一个 JS 文件，里面使用 export 命令输出变量。

1、基本用法

export const city1 = 'Guangzhou';
export const city2 = 'Shenzhen';

上面代码是 profile.js 文件，保存了用户信息。ES6 将其视为一个模块，里面用 export 命令对外部输出了三个变量。

export 的写法，除了像上面这样，还有另外一种。

const city1 = 'Guangzhou';
const city2 = 'Shenzhen';

export { city1, city2 };

上面代码在 export 命令后面，使用大括号指定所要输出的一组变量。它与前一种写法（直接放置在 const 语句前）是等价的，但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部，一眼看清楚输出了哪些变量。

export 命令除了输出变量，还可以输出函数或类（class）。

export function multiply(x, y) {
  return x * y;
};

上面代码对外输出一个函数 multiply。

2、as 关键字重命名

通常情况下，export 输出的变量就是本来的名字，但是可以使用 as 关键字重命名。

function v1() { ... }
function v2() { ... }

export {
  v1 as streamV1,
  v2 as streamV2,
  v2 as streamLatestVersion
};

上面代码使用 as 关键字，重命名了函数 v1 和 v2 的对外接口。重命名后，v2 可以用不同的名字输出两次。

3、export default

3-1、基本用法

export default 命令，为模块指定默认输出。

export default function () {
  console.log('foo');
}

上面代码是一个模块文件 export-default.js，它的默认输出是一个函数。

export default 也可以用来输出类。

// MyClass.js
export default class { ... }

// main.js
import MyClass from 'MyClass';

3-2、指定名字导入

其他模块加载该模块时，import 命令可以为该匿名函数指定任意名字。

import customName from './export-default';

customName();

上面代码的 import 命令，可以用任意名称指向 export-default.js 输出的方法，这时就不需要知道原模块输出的函数名。需要注意的是，这时 import 命令后面，不使用大括号。

export default 命令用在非匿名函数前，也是可以的。

export default function foo() {
  console.log('foo');
}

function foo() {
  console.log('foo');
}

export default foo;

上面代码中，foo 函数的函数名 foo，在模块外部是无效的。加载的时候，视同匿名函数加载。

3-3、与 export 结合使用

以输入 lodash 模块为例。

import _ from 'lodash';

如果想在一条 import 语句中，同时输入默认方法和其他接口，可以写成下面这样。

// export.js
export default function (obj) {
}

export function each(obj, iterator, context) {
}

export { each as forEach }; // 暴露出 `forEach` 接口，默认指向 `each` 接口

// import.js
import _, { each, forEach } from 'lodash';

3-4、与 export 的区别

下面比较一下默认输出和正常输出。

export default function crc32() { }
import crc32 from 'crc32';

export function crc32() { };
import { crc32 } from 'crc32';

上面代码中，

• 第一组使用 export default，对应的 import 语句不需要使用大括号；
• 第二组使用 export，对应的 import 语句需要使用大括号。

export default 命令用于指定模块的默认输出。显然，一个模块只能有一个默认输出，因此 export default 命令只能使用一次。所以，import 命令后面才不用加大括号，因为只可能唯一对应 export default 命令。

4、export 常见错误写法

4-1、需要指定对外的接口

需要特别注意的是，export 命令规定的是对外的接口，必须与模块内部的变量建立一一对应关系。

// 错误写法一
export 1;
// 正确写法一
export const a = 1;
// 正确写法一
export default 1;

// 错误写法二
const a = 1;
export a;
// 正确写法二
const a = 1;
export { a };

上面的两种错误写法没有提供对外的接口，1 只是一个值，不是接口。因此需要在接口名与模块内部变量之间，建立一一对应的关系。

而 export default 本质上是输出一个叫做 default 的变量或方法，将后面的值，赋给 default 变量，所以 export default 1 的写法是正确的。

4-2、需要写在模块顶层

export 命令出现在模块的位置需要在模块顶层就可以，不能处于块级作用域内，否则会报错。

// 错误写法
function foo() {
  export const name = 'hello'
}
foo()
// 正确写法
export const name = 'hello'

上面代码中，export 语句放在函数之中，结果报错。

4-3、export default 不能跟变量声明语句

正是因为 export default 命令只是输出一个叫做 default 的变量，所以它后面不能跟变量声明语句。

// 正确写法
export const a = 1;
// 正确写法
const a = 1;
export default a;
// 错误写法
export default const a = 1; // 报错

上面代码中，export default a 的含义是将变量 a 的值赋给变量 default。所以，最后一种写法会报错。

三、import

import 命令用于输入其他模块提供的功能。

使用 export 命令定义了模块的对外接口以后，其他 JS 文件就可以通过 import 命令加载这个模块。

import { firstName, lastName, year } from './profile.js';

上面代码的 import 命令，用于加载 profile.js 文件，并从中输入变量。

import 命令接受一对大括号，里面指定要从其他模块导入的变量名。大括号里面的变量名，必须与被导入模块（profile.js）对外接口的名称相同。

如果想为输入的变量重新取一个名字，import 命令要使用 as 关键字，将输入的变量重命名。

import { lastName as surname } from './profile.js';

1、输入的变量只读

import 命令输入的变量都是只读的，因为它的本质是输入接口。也就是说，不允许在加载模块的脚本里面，改写接口，例如：

// 错误写法
import { a } from './xxx.js'
a = {};

上面代码中，脚本加载了变量 a，对其重新赋值就会报错，因为 a 是一个只读的接口。

// 可行但不建议
import { a } from './xxx.js'
a.foo = 'hello';

上面代码中，a 的属性可以成功改写，并且其他模块也可以读到改写后的值。不过，这种写法很难查错，建议凡是输入的变量，都当作完全只读，不要轻易改变它的属性。

2、声明自动提升

注意，import 命令具有提升效果，会提升到整个模块的头部，首先执行。

foo();
import { foo } from 'my_module';  // import 会提升到顶部

上面的代码不会报错，因为 import 的执行早于 foo 的调用。

这种行为的本质是，import 命令是编译阶段执行的，在代码运行之前。

3、省略模块路径

import 后面的 from 指定模块文件的位置，可以是相对路径，也可以是绝对路径。

如果不带有路径，只是一个模块名，那么必须有配置文件，告诉 JS 引擎该模块的位置。

import { myMethod } from 'util';

上面代码中，util 是模块文件名，由于不带有路径，必须通过配置，告诉引擎怎么取到这个模块。

4、不带 from 的加载模块写法

import 语句会执行所加载的模块，例如：

import 'lodash';

上面代码仅仅执行 lodash 模块，但是不输入任何值。

如果多次重复执行同一句 import 语句，那么只会执行一次，而不会执行多次。

import 'lodash';
import 'lodash';

上面代码加载了两次 lodash，但是只会执行一次。

5、可在任何地方执行

import() 函数可以用在任何地方，不仅仅是模块，非模块的脚本也可以使用。它是运行时执行，也就是说，什么时候运行到这一句，就会加载指定的模块。

另外，import() 函数与所加载的模块没有静态连接关系，这点也是与 import 语句不相同。import() 类似于 Node 的 require 方法，区别主要是前者是异步加载，后者是同步加载。

下面是 import() 的一些应用：

5-1、按需加载

import() 可以在需要的时候，再加载某个模块。

button.addEventListener('click', event => {
  import('./dialogBox.js')
  .then(dialogBox => {
    dialogBox.open();
  })
  .catch(error => {
    
  })
});

上面代码中，import() 方法放在 click 事件的监听函数之中，只有用户点击了按钮，才会加载这个模块。

5-2、条件加载

import() 可以放在 if 代码块，根据不同的情况，加载不同的模块。

if (condition) {
  import('moduleA').then(...);
} else {
  import('moduleB').then(...);
}

上面代码中，如果满足条件，就加载模块 A，否则加载模块 B。

5-3、动态的模块路径

import() 允许模块路径动态生成。

import(f())
.then(...);

上面代码中，根据函数 f 的返回结果，加载不同的模块。

5-4、注意点

import() 加载模块成功以后，这个模块会作为一个对象，当作 then 方法的参数。因此，可以使用对象解构赋值的语法，获取输出接口：

import('./myModule.js')
.then(({export1, export2}) => {
 });

上面代码中，export1 和 export2 都是 myModule.js 的输出接口，可以解构获得。

如果模块有 default 输出接口，可以用参数直接获得。

import('./myModule.js')
.then(myModule => {
  console.log(myModule.default);
});

上面的代码也可以使用具名输入的形式。

import('./myModule.js')
.then(({default: theDefault}) => {
  console.log(theDefault);
});

如果想同时加载多个模块，可以采用下面的写法。

Promise.all([
  import('./module1.js'),
  import('./module2.js'),
  import('./module3.js'),
])
.then(([module1, module2, module3]) => {
   ···
});

import() 也可以用在 async 函数之中。

async function main() {
  const myModule = await import('./myModule.js');
  const {export1, export2} = await import('./myModule.js');
  const [module1, module2, module3] =
    await Promise.all([
      import('./module1.js'),
      import('./module2.js'),
      import('./module3.js'),
    ]);
}
main();

6、import 常见错误写法

由于 import 静态执行，所以不能使用表达式和变量，这些只有在运行时才能得到结果的语法结构。

// 错误写法一
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 结构。在静态分析阶段，这些语法都是没法得到值的。

目前通过 Babel 转码，CommonJS 模块的 require 命令和 ES6 模块的 import 命令可以写在同一个模块中，但最好不要这样做。因为 import 在静态解析阶段执行，所以它是一个模块之中最早执行的。下面的代码可能不会得到预期结果：

// 不建议
require('core-js/modules/es6.symbol');
require('core-js/modules/es6.promise');
import React from 'React';

四、export * 和 import *

除了指定加载某个输出值，还可以使用整体加载，即用星号（*）指定一个对象，所有输出值都加载在这个对象上面，举个例子：

导出阶段：

export function a() {
  ...
}

export function b() {
  ...
}

导入阶段（逐一指定写法）：

import { a, b } from 'mod';

导出阶段（整体加载写法）：

import * from 'mod';
import * as xx from 'mod';

export * 表示整体输出，可以将多个子模块组合到一个父模块中，以父模块统一导出，例如：

export * from "mod";
export * as name from "mod";

注意：当文件中 export 与 export default 混合使用时，export * 对 export default 导出的模块无效，只适用于 export。