Module的加载实现
1.浏览器加载
传统方法
HTML 网页中,浏览器通过
1 <!-- 页面内嵌的脚本 --> 2 <script type="application/javascript"> 3 // module code 4 </script> 5 6 <!-- 外部脚本 --> 7 <script type="application/javascript" src="path/to/myModule.js"> 8 </script>
默认情况下,浏览器是同步加载 JavaScript 脚本,即渲染引擎遇到
如果脚本体积很大,下载和执行的时间就会很长,因此造成浏览器堵塞,用户会感觉到浏览器“卡死”了,没有任何响应。这显然是很不好的体验,所以浏览器允许脚本异步加载,下面就是两种异步加载的语法
<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>
浏览器对于带有type="module"的<script>,都是异步加载,不会造成堵塞浏览器,即等到整个页面渲染完,再执行模块脚本,等同于打开了<script>标签的defer属性。<script>标签的async属性也可以打开
ES6 模块也允许内嵌在网页中,语法行为与加载外部脚本完全一致
1 <script type="module"> 2 import utils from "./utils.js"; 3 // other code 4 </script>
对于外部的模块脚本(上例是foo.js),有几点需要注意
代码是在模块作用域之中运行,而不是在全局作用域运行。模块内部的顶层变量,外部不可见
- 模块脚本自动采用严格模式,不管有没有声明use strict
- 模块之中,可以使用import命令加载其他模块(.js后缀不可省略,需要提供绝对 URL 或相对
URL),也可以使用export命令输出对外接口 - 模块之中,顶层的this关键字返回undefined,而不是指向window。也就是说,在模块顶层使用this关键字,是无意义的
- 同一个模块如果加载多次,将只执行一次
利用顶层的this等于undefined这个语法点,可以侦测当前代码是否在 ES6 模块之中
2.ES6 模块与 CommonJS 模块的差异
讨论 Node 加载 ES6 模块之前,必须了解 ES6 模块与 CommonJS 模块完全不同
- CommonJS 模块输出的是一个值的拷贝,ES6 模块输出的是值的引用
- CommonJS 模块是运行时加载,ES6 模块是编译时输出接口
第二个差异是因为 CommonJS 加载的是一个对象(即module.exports属性),该对象只有在脚本运行完才会生成。而 ES6 模块不是对象,它的对外接口只是一种静态定义,在代码静态解析阶段就会生成
下面重点解释第一个差异
CommonJS 模块输出的是值的拷贝,也就是说,一旦输出一个值,模块内部的变化就影响不到这个值。请看下面这个模块文件lib.js的例子
1 // lib.js 2 var counter = 3; 3 function incCounter() { 4 counter++; 5 } 6 module.exports = { 7 counter: counter, 8 incCounter: incCounter, 9 };
上面代码输出内部变量counter和改写这个变量的内部方法incCounter。然后,在main.js里面加载这个模块
1 // main.js 2 var mod = require('./lib'); 3 4 console.log(mod.counter); // 3 5 mod.incCounter(); 6 console.log(mod.counter); // 3
上面代码说明,lib.js模块加载以后,它的内部变化就影响不到输出的mod.counter了。这是因为mod.counter是一个原始类型的值,会被缓存。除非写成一个函数,才能得到内部变动后的值
1 // lib.js 2 var counter = 3; 3 function incCounter() { 4 counter++; 5 } 6 module.exports = { 7 get counter() { 8 return counter 9 }, 10 incCounter: incCounter, 11 };
上面代码中,输出的counter属性实际上是一个取值器函数。现在再执行main.js,就可以正确读取内部变量counter的变动了
$ node main.js
3
4
ES6 模块的运行机制与 CommonJS 不一样。JS 引擎对脚本静态分析的时候,遇到模块加载命令import,就会生成一个只读引用。等到脚本真正执行时,再根据这个只读引用,到被加载的那个模块里面去取值。换句话说,ES6 的import有点像 Unix 系统的“符号连接”,原始值变了,import加载的值也会跟着变。因此,ES6 模块是动态引用,并且不会缓存值,模块里面的变量绑定其所在的模块
由于 ES6 输入的模块变量,只是一个“符号连接”,所以这个变量是只读的,对它进行重新赋值会报错
最后,export通过接口,输出的是同一个值。不同的脚本加载这个接口,得到的都是同样的实例
3.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命令会按照路径去寻找这个名字的脚本文件
如果脚本文件省略了后缀名,比如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
ES6 模块加载 CommonJS 模块
CommonJS 模块的输出都定义在module.exports这个属性上面。Node 的import命令加载 CommonJS 模块,Node 会自动将module.exports属性,当作模块的默认输出,即等同于export default xxx
下面是一个 CommonJS 模块
1 // a.js 2 module.exports = { 3 foo: 'hello', 4 bar: 'world' 5 }; 6 7 // 等同于 8 export default { 9 foo: 'hello', 10 bar: 'world' 11 };
import命令实际上输入的是这样一个对象{ default: module.exports }
下面是一些例子
1 // b.js 2 module.exports = null; 3 4 // es.js 5 import foo from './b'; 6 // foo = null; 7 8 import * as bar from './b'; 9 // bar = { default:null };
上面代码中,es.js采用第二种写法时,要通过bar.default这样的写法,才能拿到module.exports
1 // c.js 2 module.exports = function two() { 3 return 2; 4 }; 5 6 // es.js 7 import foo from './c'; 8 foo(); // 2 9 10 import * as bar from './c'; 11 bar.default(); // 2 12 bar(); // throws, bar is not a function
上面代码中,bar本身是一个对象,不能当作函数调用,只能通过bar.default调用。
CommonJS 模块的输出缓存机制,在 ES6 加载方式下依然有效
CommonJS 模块加载 ES6 模块
CommonJS 模块加载 ES6 模块,不能使用require命令,而要使用import()函数。ES6 模块的所有输出接口,会成为输入对象的属性
4.循环加载
“循环加载”(circular dependency)指的是,a脚本的执行依赖b脚本,而b脚本的执行又依赖a脚本
1 // a.js 2 var b = require('b'); 3 4 // b.js 5 var a = require('a');
CommonJS 模块的加载原理
CommonJS 的一个模块,就是一个脚本文件。require命令第一次加载该脚本,就会执行整个脚本,然后在内存生成一个对象
1 { 2 id: '...', 3 exports: { ... }, 4 loaded: true, 5 ... 6 }
上面代码就是 Node 内部加载模块后生成的一个对象。该对象的id属性是模块名,exports属性是模块输出的各个接口,loaded属性是一个布尔值,表示该模块的脚本是否执行完毕。其他还有很多属性,这里都省略了。
以后需要用到这个模块的时候,就会到exports属性上面取值。即使再次执行require命令,也不会再次执行该模块,而是到缓存之中取值。也就是说,CommonJS 模块无论加载多少次,都只会在第一次加载时运行一次,以后再加载,就返回第一次运行的结果,除非手动清除系统缓存
CommonJS 模块的循环加载
CommonJS 模块的重要特性是加载时执行,即脚本代码在require的时候,就会全部执行。一旦出现某个模块被"循环加载",就只输出已经执行的部分,还未执行的部分不会输出
ES6 模块的循环加载
ES6 处理“循环加载”与 CommonJS 有本质的不同。ES6 模块是动态引用,如果使用import从一个模块加载变量(即import foo from ‘foo’),那些变量不会被缓存,而是成为一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值
5.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 对象,可以针对这个对象编程。下面是一个模块文件
1 // app/es6-file.js: 2 export class q { 3 constructor() { 4 this.es6 = 'hello'; 5 } 6 }
然后,在网页内加载这个模块文件
1 <script> 2 3 System.import('app/es6-file').then(function(m) { 4 console.log(new m.q().es6); // hello 5 }); 6 7 </script>
上面代码中,System.import方法返回的是一个 Promise 对象,所以可以用then方法指定回调函数