Module 的加载实现

本章介绍如何在浏览器和 Node 之中加载 ES6模块,以及实际开发中经常遇到的一些问题(比如循环加载)

一、浏览器加载

1.1、传统方法

在 HTML 网页中,浏览器通过<script> 标签加载 JavaScript 脚本。默认情况下,浏览器同步加载 JavaScript 脚本,即渲染引擎遇到 <script> 标签就会停下来,等到脚本执行完毕再继续向下渲染。如果是外部脚本,还必须加入脚本下载的时间。
如果脚本体积很大,下载和执行的时间就会很长,因此造成浏览器堵塞。用户会感觉到浏览器“卡死”了,没有响应,这显然是很不好的体验,所以浏览器允许脚本异步加载。

下面就是两种异步加载的语法

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

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

defer 与 async 的区别

  • defer 要等到整个页面正常渲染结束才会执行
  • async 后者一旦下载完成,渲染引擎就会中断渲染,执行这个脚本以后再继续渲染。
    defer 是“渲染完再执行”, async 是“下载完就执行”。另外,如果有多个defer 脚本,则会按照他们在页面出现的顺序加载,而多个 async 脚本时不能保证加载顺序的

1.2、加载规则

浏览器加载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" sec="foo.js" defer></script>

<script> 标签的async 属性也可以打开,这时只要加载完成,渲染引擎就会中断渲染立即执行。执行完成后,再回复渲染

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

ES6 模块也允许内嵌在网页中,语法行为与加载外部脚本完全一致。

<script type="module">
  import utils from './utils.js'

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

利用顶层的 this 等于 undefined 这个语法点,可以检测当前代码是否在 ES6 模块之中

const isNotModuleScript = this !== undefined

二、ES6 模块与 CommonJS 模块的差异

ES6 模块与 CommonJS 模块的主要差异

  • CommonJS 模块输出的是一个值的复制,ES6模块输出的是值的引用。

  • CommonJS 模块时运行时加载,ES6模块时编译时输出接口
    因为 CommonJS 加载的是一个对象(即 module.exports 属性),该对象只有在脚本运行结束时才会生成。而ES6 模块不是对象,它的对外接口只是一种静态定义,在代码静态解析阶段就会生成。

下面重点解释第一个差异
CommonJS 模块输出的是值的复制,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。

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

因为 mod.counter 是一个原始类型的值,会被缓存。除非写成一个函数,否则得到内部变动后的值

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

上面的代码中,输出的 counter 属性实际上是一个取值器函数。再执行 main.js 就可以正确读取内部变量 counter 的变动

ES6 模块的运行机制与 CommonJs 不一样。JS 引擎对脚本静态分析的时候,遇到模块加载命令 import 就会生成一个只读引用。等到脚本真正执行时,再根据这个只读引用到被加载的模块中取值。原始值变了,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 内部的变化

由于 ES6 输入的模块变了只是一个 “符号连接”,所以这个变量是只读的,对它进行重新赋值会报错。

// lib.js
export let obj = {}

// main.js
import { obj } from './lib'

obj.prop = 123 // OK
obj = {} // TypeError

重新赋值就会报错。因为变量 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' 

执行结果输出1,这就证明了 x.js 和 y.js 加载的都是C的同一个实例

三、Node 加载

3.1、概述

Node 对 ES6模块的处理比较麻烦,因为它有自己的 CommonJS 模块格式,与 ES6 模块模式不兼容。目前的解决方案是,将两者分开,ES6 模块和 CommonJS 采用各自的加载方案。
在静态分析阶段,一个模块脚本只要有一行 import 或 export 语句,Node 就会认为该脚本为 ES6 模块,否则就为 CommonJS 模块。如果不输出任何接口,但是希望被 Node 认为是 ES6 模块,可以在脚本中加上如下语句。

export {}

上面的命令,是不输出任何接口的ES6标准写法。

如果不指定绝对路径,Node 加载 ES6 模块会一次寻找以下脚本,与 require() 的规则一致

import './foo'
// 依次寻找
// ./foo.js
// ./foo/package.json
// ./foo/index.js

import 'baz'
// 依次寻找
// ./node_modules/baz.js
// ./node_modules/baz/package.json
// ./node_modules/baz/index.js
// 寻找上一级目录
// ../node_modules/baz.js
// ../node_modules/baz/package.json
// ../node_modules/baz/index.js
// ...依次向上寻找

ES6 模块之中,顶层的 this 指向 undefined,CommonJS 模块的顶层 this 指向当前模块,这是两者的一个重大差异。

3.2、import 命令加载 CommonJS 模块

Node 采用 CommonJS 模块格式,模块的输出都定义在 module.exports 属性上面。在 Node 环境中,使用 import 命令加载 CommonJS 模块,Node 会自动将 module.exports 属性当做模块的默认输出,即等同于 export default

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

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

import 命令加载上面的模块,module.exports 会被视为默认输出

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

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

如果采用整体输入的写法(import * as xxx from someModule),default 会取代 module.exports 作为输入的接口

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)
  }
*/

Node 会自动为 baz 添加 default 属性,通过baz.default 获取 module.exports

// b.js
modulex.exports = null

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

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

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()

3.3、require 命令加载 ES6 模块

采用 require 命令加载 ES6 模块时,ES6 模块的所有输出接口都会成为输入对象的属性。

// es.js
let foo = { bar: 'my-default' }
export default foo
foo = null
  
// cjs.js
const es_namespace = require('./es')
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 = require('./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')

通常,“循环加载” 表示存在强耦合,如果处理不好,还可能导致递归加载,使得程序无法执行,因此应该避免出现这些现象。但实际上,这是很难避免的
对于 JavaScript 语言来说,目前最常见的两种模块格式 CommonJS 和 ES6 在处理“循环加载”时的方法是不一样的,返回的结果也不一样。

4.1、CommonJS 模块的加载原理

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

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

上面的代码就是 Node 内部加载模块生成的一个对象。

  • id 属性是模块名
  • exports 属性时模块输出的各个接口
  • loaded 属性是一个布尔值,表示该模块的脚本是否执行完毕。
    其他还有很多属性

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

4.2、CommonJS 模块的循环加载

CommonJS 模块的重要特性是加载时执行,即脚本代码在 require 的时候就会全部执行。

下面是 Node 关系文档中的例子:

a.js

exprots.done = false
var b = require('./b.js')
console.log('在 a.js 之中,b.done = %j', b.done)
exports.done = true
console.log('a.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 执行完毕')

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的执行结果。总而言之:CommonJS 输出的是被输出值的复制,而不是引用。

由于 CommonJS 模块遇到循环加载时返回的是当前已经执行的部分的值,而不是代码全部执行后的值,两者可能会有差异。所以,输入变量的时候必须非常小心。

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

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

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

如果发生循环加载,require('a').foo 的值很可能会被改写,改用 require('a') 会跟保险一点

4.3、ES6 模块的循环加载

ES6 处理 “循环加载” 与 CommonJS 有本质的不同。ES6 模块是动态引用,如果使用 import 从一个模块中加载变量,那么,变量不会被缓存,而是成为一个指向被加载模块的引用。

a.js

// a.js 如下
import { bar } from './b.js'
console.log('a.js')
console.log(bar)

export let foo = 'foo'

b.js

import { foo } from './a.js'
console.log('b.js')
console.log(foo)

export let bar = 'bar'

执行 a.js,结果如下

// b.js
// undefined
// a.js
// bar

上面的代码执行顺序如下

由于 a.js 的第一行是加载 b.js,所以先执行的是 b.js。而 b.js 的第一行又是加载 a.js,这时由于 a.js 已经开始执行,所以不会重复执行,而是继承执行 b.js,因此第一行输出的是 b.js

接着,b.js 要打印变量 foo,这时 a.js 还没执行完,取不到 foo 的值,因此打印出来的是 undefined。b.js 执行完便会开始执行 a.js,这时便会一切正常。

下面是 稍微复杂的例子

a.js

import { bar } from './b.js'
export function foo() {
  console.log('foo')
  bar()
  console.log('执行完毕')
}
foo()

b.js

import { foo } from './a.js'
export function bar() {
  console.log('bar')
  if (Math.random() > 0.5) {
    foo()
  }
}

按照 CommonJS 规范,上面的代码是无法执行的。a 先加载 b,然后 b 又加载 a,这时 a 还没有任何执行结果,所以输出结果为 null,即对于 b.js 来说,变量 foo 的值等于 null,后面的 foo() 就会报错。

ES6可以执行上面的代码

foo
bar 
执行完毕

// 执行结果也可能是
foo
bar
foo
bar
执行完毕
执行完毕

// 也可能会更多次的嵌套

a.js 之所以能够执行,原因在于 ES6 加载的变量都是动态引用其所在模块的。只要引用存在,代码就能执行。

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

event.js

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

odd.js

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

运行上面的代码,结果如下

import * as m from './event.js'
m.event(10) // true
m.counter // 6
m.event(20) // true
m.counter // 11 + 6 ---> 17

上面的代码中,参数n 从 10 变成 0 的过程中,event() 一个会执行6次,所以变量 counter 等于6.第二次调用 event() 时,参数 n 从 20 变为0,event() 一共执行11 次,加上前面的6次,所以变量 counter 等于 17.

这个例子要是改写成 CommonJS,则会报错,根本无法执行。

五、模块的转码

浏览器目前还不支持 ES6 模块,为了实现使用,我们可以将其转为 ES5 的写法。除了 Babel 可以用来转码,还有以下两个方法可以用来转码

5.1、ES6 module transpiler

ES6 module transplier 是square 公司开源的一个转码器,可以将ES6 模块转为 CommonJS 模块或 AMD 模块,从而在浏览器中使用。

首先,安装这个转码器

$ npm install -g es6-module-transpiler

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

$ compile-modules convert file1.js file2.js

-0 参数可以指定转码后的文件名

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

5.2、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.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 方法指定回调函数

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 198,932评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,554评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 145,894评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,442评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,347评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,899评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,325评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,980评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,196评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,163评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,085评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,826评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,389评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,501评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,753评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,171评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,616评论 2 339

推荐阅读更多精彩内容