21.Module 的加载实现

Module 的加载实现

Module 的加载实现

上一章介绍了模块的语法，本章介绍如何在浏览器和 Node 之中加载 ES6 模块，以及实际开发中常常遇到的一些问题（好比循环加载）。

浏览器加载

传统方法

HTML 网页中，浏览器经过<script>标签加载 JavaScript 脚本。

<!-- 页面内嵌的脚本 -->
<script type="application/javascript"> // module code </script>

<!-- 外部脚本 -->
<script type="application/javascript" src="path/to/myModule.js"> </script>

上面代码中，因为浏览器脚本的默认语言是 JavaScript，所以type="application/javascript"能够省略。

默认状况下，浏览器是同步加载 JavaScript 脚本，即渲染引擎遇到<script>标签就会停下来，等到执行完脚本，再继续向下渲染。若是是外部脚本，还必须加入脚本下载的时间。

若是脚本体积很大，下载和执行的时间就会很长，所以形成浏览器堵塞，用户会感受到浏览器“卡死”了，没有任何响应。这显然是很很差的体验，因此浏览器容许脚本异步加载，下面就是两种异步加载的语法。

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

上面代码中，<script>标签打开defer或async属性，脚本就会异步加载。渲染引擎遇到这一行命令，就会开始下载外部脚本，但不会等它下载和执行，而是直接执行后面的命令。

defer与async的区别是：defer要等到整个页面在内存中正常渲染结束（DOM 结构彻底生成，以及其余脚本执行完成），才会执行；async一旦下载完，渲染引擎就会中断渲染，执行这个脚本之后，再继续渲染。一句话，defer是“渲染完再执行”，async是“下载完就执行”。另外，若是有多个defer脚本，会按照它们在页面出现的顺序加载，而多个async脚本是不能保证加载顺序的。

加载规则

浏览器加载 ES6 模块，也使用<script>标签，可是要加入type="module"属性。

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

上面代码在网页中插入一个模块foo.js，因为type属性设为module，因此浏览器知道这是一个 ES6 模块。

浏览器对于带有type="module"的<script>，都是异步加载，不会形成堵塞浏览器，即等到整个页面渲染完，再执行模块脚本，等同于打开了<script>标签的defer属性。

<script type="module" src="./foo.js"></script>
<!-- 等同于 -->
<script type="module" src="./foo.js" defer></script>

若是网页有多个<script type="module">，它们会按照在页面出现的顺序依次执行。

<script>标签的async属性也能够打开，这时只要加载完成，渲染引擎就会中断渲染当即执行。执行完成后，再恢复渲染。

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

一旦使用了async属性，<script type="module">就不会按照在页面出现的顺序执行，而是只要该模块加载完成，就执行该模块。

ES6 模块也容许内嵌在网页中，语法行为与加载外部脚本彻底一致。

<script type="module"> import utils from "./utils.js"; // other code </script>

对于外部的模块脚本（上例是foo.js），有几点须要注意。

• 代码是在模块做用域之中运行，而不是在全局做用域运行。模块内部的顶层变量，外部不可见。
• 模块脚本自动采用严格模式，无论有没有声明use strict。
• 模块之中，可使用import命令加载其余模块（.js后缀不可省略，须要提供绝对 URL 或相对 URL），也可使用export命令输出对外接口。
• 模块之中，顶层的this关键字返回undefined，而不是指向window。也就是说，在模块顶层使用this关键字，是无心义的。
• 同一个模块若是加载屡次，将只执行一次。

下面是一个示例模块。

import utils from 'https://example.com/js/utils.js';

const x = 1;

console.log(x === window.x); //false
console.log(this === undefined); // true

delete x; // 句法错误，严格模式禁止删除变量

利用顶层的this等于undefined这个语法点，能够侦测当前代码是否在 ES6 模块之中。

const isNotModuleScript = this !== undefined;

ES6 模块与 CommonJS 模块的差别

讨论 Node 加载 ES6 模块以前，必须了解 ES6 模块与 CommonJS 模块彻底不一样。

它们有两个重大差别。

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

第二个差别是由于 CommonJS 加载的是一个对象（即module.exports属性），该对象只有在脚本运行完才会生成。而 ES6 模块不是对象，它的对外接口只是一种静态定义，在代码静态解析阶段就会生成。

下面重点解释第一个差别。

CommonJS 模块输出的是值的拷贝，也就是说，一旦输出一个值，模块内部的变化就影响不到这个值。请看下面这个模块文件lib.js的例子。

// lib.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  counter: counter,
  incCounter: incCounter,
};

上面代码输出内部变量counter和改写这个变量的内部方法incCounter。而后，在main.js里面加载这个模块。

// main.js
var mod = require('./lib');

console.log(mod.counter);  // 3
mod.incCounter();
console.log(mod.counter); // 3

上面代码说明，lib.js模块加载之后，它的内部变化就影响不到输出的mod.counter了。这是由于mod.counter是一个原始类型的值，会被缓存。除非写成一个函数，才能获得内部变更后的值。

// lib.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  get counter() {
    return counter
  },
  incCounter: incCounter,
};

上面代码中，输出的counter属性其实是一个取值器函数。如今再执行main.js，就能够正确读取内部变量counter的变更了。

$ node main.js
3
4

ES6 模块的运行机制与 CommonJS 不同。JS 引擎对脚本静态分析的时候，遇到模块加载命令import，就会生成一个只读引用。等到脚本真正执行时，再根据这个只读引用，到被加载的那个模块里面去取值。换句话说，ES6 的import有点像 Unix 系统的“符号链接”，原始值变了，import加载的值也会跟着变。所以，ES6 模块是动态引用，而且不会缓存值，模块里面的变量绑定其所在的模块。

仍是举上面的例子。

// 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一节中的例子。

// 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可否正确读取这个变化。

$ babel-node m2.js

bar
baz

上面代码代表，ES6 模块不会缓存运行结果，而是动态地去被加载的模块取值，而且变量老是绑定其所在的模块。

因为 ES6 输入的模块变量，只是一个“符号链接”，因此这个变量是只读的，对它进行从新赋值会报错。

// 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经过接口，输出的是同一个值。不一样的脚本加载这个接口，获得的都是一样的实例。

// 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的实例。不一样的脚本加载这个模块，获得的都是同一个实例。

// 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。

$ babel-node main.js
1

这就证实了x.js和y.js加载的都是C的同一个实例。

Node 加载

概述

Node 对 ES6 模块的处理比较麻烦，由于它有本身的 CommonJS 模块格式，与 ES6 模块格式是不兼容的。目前的解决方案是，将二者分开，ES6 模块和 CommonJS 采用各自的加载方案。

Node 要求 ES6 模块采用.mjs后缀文件名。也就是说，只要脚本文件里面使用import或者export命令，那么就必须采用.mjs后缀名。require命令不能加载.mjs文件，会报错，只有import命令才能够加载.mjs文件。反过来，.mjs文件里面也不能使用require命令，必须使用import。

目前，这项功能还在试验阶段。安装 Node v8.5.0 或以上版本，要用--experimental-modules参数才能打开该功能。

$ node --experimental-modules my-app.mjs

为了与浏览器的import加载规则相同，Node 的.mjs文件支持 URL 路径。

import './foo?query=1'; // 加载 ./foo 传入参数 ?query=1

上面代码中，脚本路径带有参数?query=1，Node 会按 URL 规则解读。同一个脚本只要参数不一样，就会被加载屡次，而且保存成不一样的缓存。因为这个缘由，只要文件名中含有:、%、#、?等特殊字符，最好对这些字符进行转义。

目前，Node 的import命令只支持加载本地模块（file:协议），不支持加载远程模块。

若是模块名不含路径，那么import命令会去node_modules目录寻找这个模块。

import 'baz';
import 'abc/123';

若是模块名包含路径，那么import命令会按照路径去寻找这个名字的脚本文件。

import 'file:///etc/config/app.json';
import './foo';
import './foo?search';
import '../bar';
import '/baz';

若是脚本文件省略了后缀名，好比import './foo'，Node 会依次尝试四个后缀名：./foo.mjs、./foo.js、./foo.json、./foo.node。若是这些脚本文件都不存在，Node 就会去加载./foo/package.json的main字段指定的脚本。若是./foo/package.json不存在或者没有main字段，那么就会依次加载./foo/index.mjs、./foo/index.js、./foo/index.json、./foo/index.node。若是以上四个文件仍是都不存在，就会抛出错误。

最后，Node 的import命令是异步加载，这一点与浏览器的处理方法相同。

内部变量

ES6 模块应该是通用的，同一个模块不用修改，就能够用在浏览器环境和服务器环境。为了达到这个目标，Node 规定 ES6 模块之中不能使用 CommonJS 模块的特有的一些内部变量。

首先，就是this关键字。ES6 模块之中，顶层的this指向undefined；CommonJS 模块的顶层this指向当前模块，这是二者的一个重大差别。

其次，如下这些顶层变量在 ES6 模块之中都是不存在的。

• arguments
• require
• module
• exports
• __filename
• __dirname

若是你必定要使用这些变量，有一个变通方法，就是写一个 CommonJS 模块输出这些变量，而后再用 ES6 模块加载这个 CommonJS 模块。可是这样一来，该 ES6 模块就不能直接用于浏览器环境了，因此不推荐这样作。

// expose.js
module.exports = {__dirname};

// use.mjs
import expose from './expose.js';
const {__dirname} = expose;

上面代码中，expose.js是一个 CommonJS 模块，输出变量__dirname，该变量在 ES6 模块之中不存在。ES6 模块加载expose.js，就能够获得__dirname。

ES6 模块加载 CommonJS 模块

CommonJS 模块的输出都定义在module.exports这个属性上面。Node 的import命令加载 CommonJS 模块，Node 会自动将module.exports属性，看成模块的默认输出，即等同于export default xxx。

下面是一个 CommonJS 模块。

// a.js
module.exports = {
  foo: 'hello',
  bar: 'world'
};

// 等同于
export default {
  foo: 'hello',
  bar: 'world'
};

import命令加载上面的模块，module.exports会被视为默认输出，即import命令实际上输入的是这样一个对象{ default: module.exports }。

因此，一共有三种写法，能够拿到 CommonJS 模块的module.exports。

// 写法一
import baz from './a';
// baz = {foo: 'hello', bar: 'world'};

// 写法二
import {default as baz} from './a';
// baz = {foo: 'hello', bar: 'world'};

// 写法三
import * as baz from './a';
// baz = {
// get default() {return module.exports;},
// get foo() {return this.default.foo}.bind(baz),
// get bar() {return this.default.bar}.bind(baz)
// }

上面代码的第三种写法，能够经过baz.default拿到module.exports。foo属性和bar属性就是能够经过这种方法拿到了module.exports。

下面是一些例子。

// b.js
module.exports = null;

// es.js
import foo from './b';
// foo = null;

import * as bar from './b';
// bar = { default:null };

上面代码中，es.js采用第二种写法时，要经过bar.default这样的写法，才能拿到module.exports。

// c.js
module.exports = function two() {
  return 2;
};

// es.js
import foo from './c';
foo(); // 2

import * as bar from './c';
bar.default(); // 2
bar(); // throws, bar is not a function

上面代码中，bar自己是一个对象，不能看成函数调用，只能经过bar.default调用。

CommonJS 模块的输出缓存机制，在 ES6 加载方式下依然有效。

// foo.js
module.exports = 123;
setTimeout(_ => module.exports = null);

上面代码中，对于加载foo.js的脚本，module.exports将一直是123，而不会变成null。

因为 ES6 模块是编译时肯定输出接口，CommonJS 模块是运行时肯定输出接口，因此采用import命令加载 CommonJS 模块时，不容许采用下面的写法。

// 不正确
import { readfile } from 'fs';

上面的写法不正确，由于fs是 CommonJS 格式，只有在运行时才能肯定readfile接口，而import命令要求编译时就肯定这个接口。解决方法就是改成总体输入。

// 正确的写法一
import * as express from 'express';
const app = express.default();

// 正确的写法二
import express from 'express';
const app = express();

CommonJS 模块加载 ES6 模块

CommonJS 模块加载 ES6 模块，不能使用require命令，而要使用import()函数。ES6 模块的全部输出接口，会成为输入对象的属性。

// es.mjs
let foo = { bar: 'my-default' };
export default foo;
foo = null;

// cjs.js
const es_namespace = await import('./es');
// es_namespace = {
// get default() {
// ...
// }
// }
console.log(es_namespace.default);
// { bar:'my-default' }

上面代码中，default接口变成了es_namespace.default属性。另外，因为存在缓存机制，es.js对foo的从新赋值没有在模块外部反映出来。

下面是另外一个例子。

// es.js
export let foo = { bar:'my-default' };
export { foo as bar };
export function f() {};
export class c {};

// cjs.js
const es_namespace = await import('./es');
// es_namespace = {
// get foo() {return foo;}
// get bar() {return foo;}
// get f() {return f;}
// get c() {return c;}
// }

循环加载

“循环加载”（circular dependency）指的是，a脚本的执行依赖b脚本，而b脚本的执行又依赖a脚本。

// a.js
var b = require('b');

// b.js
var a = require('a');

一般，“循环加载”表示存在强耦合，若是处理很差，还可能致使递归加载，使得程序没法执行，所以应该避免出现。

可是实际上，这是很难避免的，尤为是依赖关系复杂的大项目，很容易出现a依赖b，b依赖c，c又依赖a这样的状况。这意味着，模块加载机制必须考虑“循环加载”的状况。

对于 JavaScript 语言来讲，目前最多见的两种模块格式 CommonJS 和 ES6，处理“循环加载”的方法是不同的，返回的结果也不同。

CommonJS 模块的加载原理

介绍 ES6 如何处理“循环加载”以前，先介绍目前最流行的 CommonJS 模块格式的加载原理。

CommonJS 的一个模块，就是一个脚本文件。require命令第一次加载该脚本，就会执行整个脚本，而后在内存生成一个对象。

{
  id: '...',
  exports: { ... },
  loaded: true,
  ...
}

上面代码就是 Node 内部加载模块后生成的一个对象。该对象的id属性是模块名，exports属性是模块输出的各个接口，loaded属性是一个布尔值，表示该模块的脚本是否执行完毕。其余还有不少属性，这里都省略了。

之后须要用到这个模块的时候，就会到exports属性上面取值。即便再次执行require命令，也不会再次执行该模块，而是到缓存之中取值。也就是说，CommonJS 模块不管加载多少次，都只会在第一次加载时运行一次，之后再加载，就返回第一次运行的结果，除非手动清除系统缓存。

CommonJS 模块的循环加载

CommonJS 模块的重要特性是加载时执行，即脚本代码在require的时候，就会所有执行。一旦出现某个模块被"循环加载"，就只输出已经执行的部分，还未执行的部分不会输出。

让咱们来看，Node 官方文档里面的例子。脚本文件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 执行完毕');

上面代码之中，a.js脚本先输出一个done变量，而后加载另外一个脚本文件b.js。注意，此时a.js代码就停在这里，等待b.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 执行完毕');

上面代码之中，b.js执行到第二行，就会去加载a.js，这时，就发生了“循环加载”。系统会去a.js模块对应对象的exports属性取值，但是由于a.js尚未执行完，从exports属性只能取回已经执行的部分，而不是最后的值。

a.js已经执行的部分，只有一行。

exports.done = false;

所以，对于b.js来讲，它从a.js只输入一个变量done，值为false。

而后，b.js接着往下执行，等到所有执行完毕，再把执行权交还给a.js。因而，a.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);

执行main.js，运行结果以下。

$ node main.js

在 b.js 之中，a.done = false
b.js 执行完毕
在 a.js 之中，b.done = true
a.js 执行完毕
在 main.js 之中, a.done=true, b.done=true

上面的代码证实了两件事。一是，在b.js之中，a.js没有执行完毕，只执行了第一行。二是，main.js执行到第二行时，不会再次执行b.js，而是输出缓存的b.js的执行结果，即它的第四行。

exports.done = true;

总之，CommonJS 输入的是被输出值的拷贝，不是引用。

另外，因为 CommonJS 模块遇到循环加载时，返回的是当前已经执行的部分的值，而不是代码所有执行后的值，二者可能会有差别。因此，输入变量的时候，必须很是当心。

var a = require('a'); // 安全的写法
var foo = require('a').foo; // 危险的写法

exports.good = function (arg) {
  return a.foo('good', arg); // 使用的是 a.foo 的最新值
};

exports.bad = function (arg) {
  return foo('bad', arg); // 使用的是一个部分加载时的值
};

上面代码中，若是发生循环加载，require('a').foo的值极可能后面会被改写，改用require('a')会更保险一点。

ES6 模块的循环加载

ES6 处理“循环加载”与 CommonJS 有本质的不一样。ES6 模块是动态引用，若是使用import从一个模块加载变量（即import foo from 'foo'），那些变量不会被缓存，而是成为一个指向被加载模块的引用，须要开发者本身保证，真正取值的时候可以取到值。

请看下面这个例子。

// 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';

上面代码中，a.mjs加载b.mjs，b.mjs又加载a.mjs，构成循环加载。执行a.mjs，结果以下。

$ node --experimental-modules a.mjs
b.mjs
ReferenceError: foo is not defined

上面代码中，执行a.mjs之后会报错，foo变量未定义，这是为何？

让咱们一行行来看，ES6 循环加载是怎么处理的。首先，执行a.mjs之后，引擎发现它加载了b.mjs，所以会优先执行b.mjs，而后再执行a.js。接着，执行b.mjs的时候，已知它从a.mjs输入了foo接口，这时不会去执行a.mjs，而是认为这个接口已经存在了，继续往下执行。执行到第三行console.log(foo)的时候，才发现这个接口根本没定义，所以报错。

解决这个问题的方法，就是让b.mjs运行的时候，foo已经有定义了。这能够经过将foo写成函数来解决。

// a.mjs
import {bar} from './b';
console.log('a.mjs');
console.log(bar());
function foo() { return 'foo' }
export {foo};

// b.mjs
import {foo} from './a';
console.log('b.mjs');
console.log(foo());
function bar() { return 'bar' }
export {bar};

这时再执行a.mjs就能够获得预期结果。

$ node --experimental-modules a.mjs
b.mjs
foo
a.mjs
bar

这是由于函数具备提高做用，在执行import {bar} from './b'时，函数foo就已经有定义了，因此b.mjs加载的时候不会报错。这也意味着，若是把函数foo改写成函数表达式，也会报错。

// a.mjs
import {bar} from './b';
console.log('a.mjs');
console.log(bar());
const foo = () => 'foo';
export {foo};

上面代码的第四行，改为了函数表达式，就不具备提高做用，执行就会报错。

咱们再来看 ES6 模块加载器SystemJS给出的一个例子。

// even.js
import { odd } from './odd'
export var counter = 0;
export function even(n) {
  counter++;
  return n === 0 || odd(n - 1);
}

// odd.js
import { even } from './even';
export function odd(n) {
  return n !== 0 && even(n - 1);
}

上面代码中，even.js里面的函数even有一个参数n，只要不等于 0，就会减去 1，传入加载的odd()。odd.js也会作相似操做。

运行上面这段代码，结果以下。

$ babel-node
> import * as m from './even.js';
> m.even(10);
true
> m.counter
6
> m.even(20)
true
> m.counter
17

上面代码中，参数n从 10 变为 0 的过程当中，even()一共会执行 6 次，因此变量counter等于 6。第二次调用even()时，参数n从 20 变为 0，even()一共会执行 11 次，加上前面的 6 次，因此变量counter等于 17。

这个例子要是改写成 CommonJS，就根本没法执行，会报错。

// even.js
var odd = require('./odd');
var counter = 0;
exports.counter = counter;
exports.even = function (n) {
  counter++;
  return n == 0 || odd(n - 1);
}

// odd.js
var even = require('./even').even;
module.exports = function (n) {
  return n != 0 && even(n - 1);
}

上面代码中，even.js加载odd.js，而odd.js又去加载even.js，造成“循环加载”。这时，执行引擎就会输出even.js已经执行的部分（不存在任何结果），因此在odd.js之中，变量even等于null，等到后面调用even(n-1)就会报错。

$ node
> var m = require('./even');
> m.even(10)
TypeError: even is not a function

ES6 模块的转码

浏览器目前还不支持 ES6 模块，为了如今就能使用，能够将转为 ES5 的写法。除了 Babel 能够用来转码以外，还有如下两个方法，也能够用来转码。

ES6 module transpiler

ES6 module transpiler是 square 公司开源的一个转码器，能够将 ES6 模块转为 CommonJS 模块或 AMD 模块的写法，从而在浏览器中使用。

首先，安装这个转码器。

$ npm install -g es6-module-transpiler

而后，使用compile-modules convert命令，将 ES6 模块文件转码。

$ compile-modules convert file1.js file2.js

-o参数能够指定转码后的文件名。

$ compile-modules convert -o out.js file1.js

SystemJS

另外一种解决方法是使用 SystemJS。它是一个垫片库（polyfill），能够在浏览器内加载 ES6 模块、AMD 模块和 CommonJS 模块，将其转为 ES5 格式。它在后台调用的是 Google 的 Traceur 转码器。

使用时，先在网页内载入system.js文件。

<script src="system.js"></script>

而后，使用System.import方法加载模块文件。

<script> System.import('./app.js'); </script>

上面代码中的./app，指的是当前目录下的 app.js 文件。它能够是 ES6 模块文件，System.import会自动将其转码。

须要注意的是，System.import使用异步加载，返回一个 Promise 对象，能够针对这个对象编程。下面是一个模块文件。

// app/es6-file.js:

export class q {
  constructor() {
    this.es6 = 'hello';
  }
}

而后，在网页内加载这个模块文件。

<script> System.import('app/es6-file').then(function(m) { console.log(new m.q().es6); // hello }); </script>

上面代码中，System.import方法返回的是一个 Promise 对象，因此能够用then方法指定回调函数。