ES6模块

1. 概述

在ES6之前，模块加载的方案主要有CommonJS和AMD。前者用于服务器，后者用于浏览器。ES6在语言规格层面上实现了模块化，直接用import和export在浏览器中导入和导出各个模块，一个js文件代表一个js模块，相当简洁，可以完全取代现有的CommonJS和AMD规范。

2.1 export命令

模块功能主要由两个命令构成：export和import。export命令用于规定模块的对外接口，import命令用于输入其他模块提供的功能。

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

1
2
// profile.js
export var year = 2018;

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

  • export的写法，除了像上面这样，还有另外一种。
1
2
3
4
// profile.js
var year = 2018;
export { year };

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

  • export命令除了输出变量，还可以输出函数或类（class）。
1
2
3
4
//对外输出一个函数multiply。
export function multiply(x, y) {
  return x * y;
};
  • 通常情况下，export输出的变量就是本来的名字，但是可以使用as关键字重命名。并且重命名后，可以用不同的名字输出两次。
1
2
3
4
5
6
7
8
function v1() { ... }
function v2() { ... }
export {
  v1 as streamV1,
  v2 as streamV2,
  v2 as streamLatestVersion
};
  • 另外，export命令规定的是对外的接口，必须与模块内部的变量建立一一对应关系。
1
2
3
4
5
6
// 报错
export 1;
// 报错
var m = 1;
export m;

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

1
2
3
4
5
6
7
// 写法一
export var m = 1;
// 写法二
var m = 1;
export { m };

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

  • export语句输出的接口，与其对应的值是动态绑定关系，即通过该接口，可以取到模块内部实时的值。
1
2
export var foo = 'bar';
setTimeout(() => foo = 'baz', 500);

上面代码输出变量foo，值为bar，500 毫秒之后变成baz。

最后，export命令可以出现在模块的任何位置，只要处于模块顶层就可以。如果处于块级作用域内，就会报错，import命令也是如此。

1
2
3
4
function foo() {
  export default 'bar' // SyntaxError
}
foo()

上面代码中，export语句放在函数之中，结果报错。因为处于条件代码块之中，就没法做静态优化了，违背了 ES6 模块的设计初衷。

2.2 import命令

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

1
2
3
4
5
6
// main.js
import { year } from './profile.js';
function setYear(element) {
  element.textContent = year;
}

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

  • 如果想为输入的变量重新取一个名字，import命令要使用as关键字，将输入的变量重命名。
1
import { year as nextYer } from './profile.js';

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

1
2
3
import { a } from './xxx.js'
a = {}; // Syntax Error : 'a' is read-only;

上面代码中，脚本加载了变量a，对其重新赋值就会报错，因为a是一个只读的接口。但是，如果a是一个对象，改写a的属性是允许的。

1
2
3
import { a } from './xxx.js'
a.foo = 'hello'; // 合法操作

上面代码中，a的属性可以成功改写，并且其他模块也可以读到改写后的值。

另外，import后面的from指定模块文件的位置，可以是相对路径，也可以是绝对路径，.js后缀可以省略。import命令具有提升效果，会提升到整个模块的头部，首先执行。

1
2
3
foo();
import { foo } from 'my_module';

上面的代码不会报错，因为import的执行早于foo的调用。这种行为的本质是，import命令是编译阶段执行的，在代码运行之前。

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

1
2
3
4
5
6
7
8
9
10
11
12
13
// 报错
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语句会执行所加载的模块，因此可以有下面的写法。

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

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

1
2
import 'lodash';
import 'lodash';

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

1
2
3
4
5
import { foo } from 'my_module';
import { bar } from 'my_module';
// 等同于
import { foo, bar } from 'my_module';

上面代码中，虽然foo和bar在两个语句中加载，但是它们对应的是同一个my_module实例。

2.3 模块的整体加载

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

如下circle.js文件，它输出两个方法area和circumference。

1
2
3
4
5
6
7
8
9
// circle.js
export function area(radius) {
  return Math.PI * radius * radius;
}
export function circumference(radius) {
  return 2 * Math.PI * radius;
}

下面，加载这个模块。

1
2
3
4
5
6
// main.js
import { area, circumference } from './circle';
console.log('圆面积：' + area(4));
console.log('圆周长：' + circumference(14));

上面写法是逐一指定要加载的方法，整体加载的写法如下。

1
2
3
4
import * as circle from './circle';
console.log('圆面积：' + circle.area(4));
console.log('圆周长：' + circle.circumference(14));

注意，模块整体加载所在的那个对象（上例是circle），应该是可以静态分析的，所以不允许运行时改变。下面的写法都是不允许的。

1
2
3
4
5
import * as circle from './circle';
// 下面两行都是不允许的
circle.foo = 'hello';
circle.area = function () {};

2.4 export default命令

使用export default命令，可以为模块指定默认输出。

1
2
3
4
// export-default.js
export default function () {
  console.log('foo');
}

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

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

1
2
3
// import-default.js
import customName from './export-default';
customName(); // 'foo'

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

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

1
2
3
4
5
6
7
8
9
10
11
12
// export-default.js
export default function foo() {
  console.log('foo');
}
// 或者写成
function foo() {
  console.log('foo');
}
export default foo;

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 第一组
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命令。本质上，export default就是输出一个叫做default的变量或方法，然后系统允许你为它取任意名字。所以，下面的写法是有效的。
1
2
3
4
5
6
7
8
9
10
11
12
// modules.js
function add(x, y) {
  return x * y;
}
export {add as default};
// 等同于
// export default add;
// app.js
import { default as foo } from 'modules';
// 等同于
// import foo from 'modules';
  • 因为export default命令其实只是输出一个叫做default的变量，所以它后面不能跟变量声明语句。
1
2
3
4
5
6
7
8
9
// 正确
export var a = 1;
// 正确
var a = 1;
export default a;
// 错误
export default var a = 1;

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

  • 同样地，因为export default命令的本质是将后面的值，赋给default变量，所以可以直接将一个值写在export default之后。
1
2
3
4
5
// 正确
export default 42;
// 报错
export 42;

上面代码中，后一句报错是因为没有指定对外的接口，而前一句指定外对接口为default。

  • 如果想在一条import语句中，同时输入默认方法和其他接口，可以写成下面这样。
1
import _, { each, each as forEach } from 'lodash';

对应上面代码的export语句如下。

1
2
3
4
5
6
7
8
9
export default function (obj) {
  // ···
}
export function each(obj, iterator, context) {
  // ···
}
export { each as forEach };

上面代码的最后一行的意思是，暴露出forEach接口，默认指向each接口，即forEach和each指向同一个方法。

  • export default也可以用来输出类。
1
2
3
4
5
6
// MyClass.js
export default class { ... }
// main.js
import MyClass from 'MyClass';
let o = new MyClass();

2.5 export 与 import 的复合写法

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

1
2
3
4
5
export { foo, bar } from 'my_module';
// 可以简单理解为
import { foo, bar } from 'my_module';
export { foo, bar };

上面代码中，export和import语句可以结合在一起，写成一行。但需要注意的是，写成一行以后，foo和bar实际上并没有被导入当前模块，只是相当于对外转发了这两个接口，当前模块不能直接使用foo和bar。

  • 模块的接口改名和整体输出，也可以采用这种写法。
1
2
3
4
5
// 接口改名
export { foo as myFoo } from 'my_module';
// 整体输出
export * from 'my_module';
  • 具名接口改为默认接口的写法如下。
1
2
3
4
5
export { es6 as default } from './someModule';
// 等同于
import { es6 } from './someModule';
export default es6;
  • 同样地，默认接口也可以改名为具名接口。
1
export { default as es6 } from './someModule';

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

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

3.1 模块的继承

模块之间可以继承。

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

1
2
3
4
5
6
7
// 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的属性或方法，改名后再输出。
1
2
3
4
// circleplus.js
//输出circle模块的area方法，且将其改名为circleArea。
export { area as circleArea } from 'circle';

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

1
2
3
4
5
// main.js
import * as math from 'circleplus';
import exp from 'circleplus';
console.log(exp(math.e));

上面代码中的import exp表示，将circleplus模块的默认方法加载为exp方法。

3.2 跨模块常量

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 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目录，将各种常量写在不同的文件里面，保存在该目录下。

1
2
3
4
5
6
7
8
9
// 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'];

然后，将这些文件输出的常量，合并在index.js里面。

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

使用的时候，直接加载index.js就可以了。

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

4.1 import()

前面说过，import命令会被 JavaScript 引擎静态分析，先于模块内的其他模块执行。所以，下面的代码会报错。

1
2
3
4
// 报错
if (x === 2) {
  import MyModual from './myModual';
}

上面代码中，引擎处理import语句是在编译时，这时不会去分析或执行if语句，所以import语句放在if代码块之中毫无意义，因此会报句法错误，而不是执行时错误。

1
2
const path = './' + fileName;
const myModual = require(path);

上面的语句就是动态加载，require到底加载哪一个模块，只有运行时才知道。import语句做不到这一点。

因此，有一个提案，建议引入import()函数，完成动态加载。

1
import(specifier)

上面代码中，import函数的参数specifier，指定所要加载的模块的位置。import命令能够接受什么参数，import()函数就能接受什么参数，两者区别主要是后者为动态加载。

import()返回一个 Promise 对象。下面是一个例子。

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

4.2 适用场合

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

1
2
3
4
5
6
7
8
9
button.addEventListener('click', event => {
  import('./dialogBox.js')
  .then(dialogBox => {
    dialogBox.open();
  })
  .catch(error => {
    /* Error handling */
  })
});

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

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

1
2
3
4
5
if (condition) {
  import('moduleA').then(...);
} else {
  import('moduleB').then(...);
}

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

（3）动态的模块路径。import()允许模块路径动态生成。

1
2
import(f())
.then(...);

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

4.3 注意点

  • import()加载模块成功以后，这个模块会作为一个对象，当作then方法的参数。因此，可以使用对象解构赋值的语法，获取输出接口。
1
2
3
4
import('./myModule.js')
.then(({export1, export2}) => {
  // ...·
});

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

  • 模块有default输出接口，可以用参数直接获得。
1
2
3
4
import('./myModule.js')
.then(myModule => {
  console.log(myModule.default);
});
  • 如果想同时加载多个模块，可以采用下面的写法。
1
2
3
4
5
6
7
8
Promise.all([
  import('./module1.js'),
  import('./module2.js'),
  import('./module3.js'),
])
.then(([module1, module2, module3]) => {
   ···
});
  • import()也可以用在 async 函数之中。
1
2
3
4
5
6
7
8
9
10
11
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();

未完待续……





参考书籍：《ES6标准入门(第3版)》

赏

谢谢你请我吃糖

微信

扫一扫，分享到微信

微信分享二维码

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

很惭愧<br><br>只做了一点微小的工作<br>谢谢大家