ES6 - Module 的语法

一、 Module 的语法

以下内容全部源于： http://es6.ruanyifeng.com/#docs/module

一、 Module 的语法

1.1 概述

CommonJS 和 AMD 模块，都只能在运行时确定这些东西。
- 例：CommonJS 模块就是对象，输入时必须查找对象属性。

// CommonJS模块
let { stat, exists, readFile } = require('fs');

// 等同于
let _fs = require('fs');
let stat = _fs.stat;
let exists = _fs.exists;
let readfile = _fs.readfile;

上面代码的实质是整体加载fs模块（即加载fs的所有方法），生成一个对象（_fs），然后再从这个对象上面读取3个方法。这种加载称为“运行时加载”，因为只有运行时才能得到这个对象，导致完全没办法在编译时做“静态优化”。

ES6 模块的设计思想，是尽量的静态化，使得编译时就能确定模块的依赖关系，以及输入和输出的变量。
- ES6 模块不是对象，而是通过export命令显式指定输出的代码，再通过import命令输入。

// ES6模块
import { stat, exists, readFile } from 'fs';

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

1.2 Module 的好处

静态加载：由于 ES6 模块是编译时加载，使得静态分析成为可能。
- 有了它，就能进一步拓宽 JavaScript 的语法，比如引入宏（macro）和类型检验（type system）这些只能靠静态分析实现的功能。
不再需要UMD模块格式了，将来服务器和浏览器都会支持 ES6 模块格式。目前，通过各种工具库，其实已经做到了这一点。
将来浏览器的新 API 就能用模块格式提供，不再必须做成全局变量或者navigator对象的属性。
不再需要对象作为命名空间（比如Math对象），未来这些功能可以通过模块提供。

1.3 严格模式

ES6 的模块自动采用严格模式，不管你有没有在模块头部加上”use strict”;。
严格模式主要有以下限制。
- 变量必须声明后再使用
- 函数的参数不能有同名属性，否则报错
- 不能使用with语句
- 不能对只读属性赋值，否则报错
- 不能使用前缀0表示八进制数，否则报错
- 不能删除不可删除的属性，否则报错
- 不能删除变量delete prop，会报错，只能删除属性delete global[prop]
- eval不会在它的外层作用域引入变量
- eval和arguments不能被重新赋值
- arguments不会自动反映函数参数的变化
- 不能使用arguments.callee
- 不能使用arguments.caller
- 禁止this指向全局对象。【ES6 模块之中，顶层的this指向undefined，即不应该在顶层代码使用this。】
- 不能使用fn.caller和fn.arguments获取函数调用的堆栈
- 增加了保留字（比如protected、static和interface）

1.4 export 命令

export命令用于规定模块的对外接口。
- 一个模块就是一个独立的文件。
  - 该文件内部的所有变量，外部无法获取。
  - 如果你希望外部能够读取模块内部的某个变量，就必须使用export关键字输出该变量。

// 写法 1
// profile.js
export var firstName = 'Michael';
export var lastName = 'Jackson';
export var year = 1958;

// 写法2 --- 优先考虑使用这种写法。因为这样就可以在脚本尾部，一眼看清楚输出了哪些变量。
// profile.js
var firstName = 'Michael';
var lastName = 'Jackson';
var year = 1958;

export {firstName, lastName, year};

export命令除了输出变量，还可以输出函数或类（class）。
通常情况下，export输出的变量就是本来的名字，但是可以使用as关键字重命名。

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

// 使用as关键字，重命名了函数v1和v2的对外接口。重命名后，v2可以用不同的名字输出两次。
export {
  v1 as streamV1,
  v2 as streamV2,
  v2 as streamLatestVersion
};

export function v3() {
  //...
}

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

// 以下两种写法都会报错，因为没有提供对外的接口。
// 第一种写法直接输出1，第二种写法通过变量m，还是直接输出1。1只是一个值，不是接口。
// 报错
export 1;

// 报错
var m = 1;
export m;

// 正确写法

// 写法一
export var m = 1;

// 写法二
var m = 1;
export {m};

// 写法三
var n = 1;
export {n as m};

同样的，function和class的输出，也必须遵守这样的写法。

// 报错
function f() {}
export f;

// 正确
export function f() {};

// 正确
function f() {}
export {f};

export语句输出的接口，与其对应的值是动态绑定关系，即通过该接口，可以取到模块内部实时的值。

// 输出变量foo，值为bar，500毫秒之后变成baz。
export var foo = 'bar';
setTimeout(() => foo = 'baz', 500);

export命令可以出现在模块的任何位置，只要处于模块顶层就可以。如果处于块级作用域内，就会报错。【因为处于条件代码块之中，就没法做静态优化了，违背了ES6模块的设计初衷。】

1.5 import 命令

import命令用于输入其他模块提供的功能。
- import后面的from指定模块文件的位置，可以是相对路径，也可以是绝对路径，.js后缀可以省略。
- 如果只是模块名，不带有路径，那么必须有配置文件，告诉 JavaScript 引擎该模块的位置。
import命令具有提升效果，会提升到整个模块的头部，首先执行。【import命令是编译阶段执行的，在代码运行之前。】

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

function setName(element) {
  element.textContent = firstName + ' ' + lastName;
}

上面代码的import命令，用于加载profile.js文件，并从中输入变量。 import命令接受一对大括号，里面指定要从其他模块导入的变量名。大括号里面的变量名，必须与被导入模块（profile.js）对外接口的名称相同。

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

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

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

// 报错原因：因为它们用到了表达式、变量和if结构。在静态分析阶段，这些语法都是没法得到值的。
// 报错
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';
}

import语句会执行所加载的模块，因此可以有下面的写法。

// 仅仅执行lodash模块，但是不输入任何值。
import 'lodash';

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

import { foo } from 'my_module';
import { bar } from 'my_module';

// 等同于
import { foo, bar } from 'my_module';

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

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

1.6 模块的整体加载

除了指定加载某个输出值，还可以使用整体加载，即用星号（*）指定一个对象，所有输出值都加载在这个对象上面。
- 模块整体加载所在的那个对象（下例是circle），应该是可以静态分析的，所以不允许运行时改变。

import * circle from './circle';

console.log('圆面积：' + circle.area(4));
console.log('圆周长：' + circle.circumference(14));

// 下面两行都是不允许的
circle.foo = 'hello';
circle.area = function () {};

1.7 export default 命令

使用import命令的时候，用户需要知道所要加载的变量名或函数名，否则无法加载。
为了给用户提供方便，让他们不用阅读文档就能加载模块，就要用到export default命令，为模块指定默认输出。

// 第一组 -- 默认输出
export default function crc32() { // 输出
  // ...
}

import crc32 from 'crc32'; // 输入

// 第二组 -- 正常输出
export function crc32() { // 输出
  // ...
};

import {crc32} from 'crc32'; // 输入

export default命令用于指定模块的默认输出：
- 本质：export default就是输出一个叫做 default的变量或方法 ，然后系统允许你为它取任意名字。
  - 因此，export default后面不能跟变量声明语句。
  - 也可直接将值写在export default后面
    - 例：export default 42;(正确) export 42;(错误)
- 一个模块只能有一个默认输出，因此export default命令只能使用一次。所以，import命令后面才不用加大括号，因为只可能对应一个方法。

// 任意名
// 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 var a = 1;

// 正确
var a = 1;
export default a;

// 错误
export default var a = 1;

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

import _, { each, each as forEach } from 'lodash';

// 对应上面的代码的export语句如下
export default function (obj) {
  // ···
}

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

export { each as forEach };

export default也可以用来输出类。

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

// main.js
import MyClass from 'MyClass';
let o = new MyClass();

1.8 export 与 import 的复合写法

如果在一个模块之中，先输入后输出同一个模块，import语句可以与export语句写在一起。

export {foo, bar} from 'my-module';

// 等价于
import {foo, bar} from 'my-module';
export {foo, bar};

模块的接口改名和整体输出，默认接口。

// 接口改名
export {foo as myFoo} from 'my_module';

//整体输出
export * from 'my_module';

// 默认接口
export {default} from 'foo';

具名接口和默认接口的转换

// 具名接口改为默认接口
export {es6 as default} from './someModule';

// 等价于
import {es6} from './someModule';
export default es6;

// 默认接口改为具名接口
export {default as es6} from './someModule';

下面三种import语句，没有对应的复合写法。

import * as someIdentifier from "someModule";
import someIdentifier from "someModule";
import someIdentifier, { namedIdentifier } from "someModule";

为了做到形式的对称，现在有提案，提出补上这三种复合写法。

export * as someIdentifier from "someModule";
export someIdentifier from "someModule";
export someIdentifier, { namedIdentifier } from "someModule";

1.9 模块的继承

假设有一个circleplus模块，继承了circle模块。

// circleplus.js
export * from 'circle'; // 表示再输出circle模块的所有属性和方法，export * 命令会忽略circle模块的default方法
export var e = 2.71828182846;
export default function(x) {
  return Math.exp(x);
}

也可以将circle的属性或方法，改名后再输出。

// circleplus.js

export { area as circleArea } from 'circle';

加载上面模块的写法如下。

// main.js

import * as math from 'circleplus';
import exp from 'circleplus'; // import exp表示，将circleplus模块的默认方法加载为exp方法。
console.log(exp(math.e));

1.10 跨模块常量

const声明的常量只在当前代码块有效。
如果想设置跨模块的常量（即跨多个文件），或者说一个值要被多个模块共享，可以采用下面的写法。

// constants.js 模块
export const A = 1;
export const B = 3;
export const C = 4;

// test1.js 模块
import * as constants from './constants';
console.log(constants.A); // 1
console.log(constants.B); // 3

// test2.js 模块
import {A, B} from './constants';
console.log(A); // 1
console.log(B); // 3

如果要使用的常量非常
- 可以建一个专门的constants目录，将各种常量写在不同的文件里面，保存在该目录下。
- 然后，将这些文件输出的常量，合并在index.js里面。
- 使用的时候，直接加载index.js就可以了。

// constants/db.js
export const db = {
  url: 'http://my.couchdbserver.local:5984',
  admin_username: 'admin',
  admin_password: 'admin password'
};

// constants/user.js
export const users = ['root', 'admin', 'staff', 'ceo', 'chief', 'moderator'];

// constants/index.js
export {db} from './db';
export {users} from './users';

// script.js
import {db, users} from './index';

1.11 import()

import(specifier)函数，完成动态加载。
- specifier：指定所要加载的模块的位置。
import命令能够接受什么参数（静态加载），import()函数就能接受什么参数（动态加载）。
import()返回一个 Promise 对象。

const main = document.querySelector('main');

import(`./section-modules/${someVariable}.js`)
  .then(module => {
    module.loadPageInto(main);
  })
  .catch(err => {
    main.textContent = err.message;
  });

import()函数可以用在任何地方，不仅仅是模块，非模块的脚本也可以使用。
- 它是运行时执行，也就是说，什么时候运行到这一句，也会加载指定的模块。
- import()函数与所加载的模块没有静态连接关系，这点也是与import语句不相同。
import()类似于 Node 的require方法，区别主要是前者是异步加载，后者是同步加载。

import()适用场合

1.按需加载
- 在需要的时候，再加载某个模块。
- 例子：import()方法放在click事件的监听函数之中，只有用户点击了按钮，才会加载这个模块。

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

2.条件加载
- 例子：import()可以放在if代码块，根据不同的情况，加载不同的模块。
3.动态的模块路径
- 允许模块路径动态生成。
- 例子：根据函数f的返回结果，加载不同的模块。

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

注意点

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

// export1和export2都是myModule.js的输出接口，可以解构获得。
import('./myModule.js')
.then(({export1, export2}) => {
  // ...·
});

如果模块有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();

Enjoy life!

目录