http://es6.ruanyifeng.com/#docs/module ES6
https://zhuanlan.zhihu.com/p/27644026 知乎
Ccommonjs Nodejs里的标准 这种加载称为“运行时加载”
require(‘’) 导入
exports.xxx = any; 导出
module.exports = any; 导出
注意,这种加载称为“运行时加载”
导出方法一 index.jsfunction isNumber (n) {return typeof n === 'number'}module.exports = {sum: function(a, b) {if(isNumber(a) && isNumber(b)) {return a + b} else {return NaN}}}导出方法二 index2.jslet a = 5;exports.a = a;注意,module.exprots导出后,代码后面的exports将失效index3.jsmodule.exprots = '后面要失效啊';exprots.a = 5;module.exprots = '在一次module.exports.'; // 后一次会覆盖前一次index4.jslet a = require('./index.js');let b = require('./index2.js');let c = require('./index3.js');console.log(a,b,c);node index4.js{sum: [Function: sum]}, {a:5}, '在一次module.exports.'
ES6 这种加载称为“编译时加载”或者静态加载
由于 ES6 模块是编译时加载,使得静态分析成为可能。有了它,就能进一步拓宽 JavaScript 的语法,比如引入宏(macro)和类型检验(type system)这些只能靠静态分析实现的功能。
ES6 的模块自动采用严格模式,不管你有没有在模块头部加上"use strict";。
严格模式主要有以下限制。
- 变量必须声明后再使用
- 函数的参数不能有同名属性,否则报错
- 不能使用
with语句 - 不能对只读属性赋值,否则报错
- 不能使用前缀 0 表示八进制数,否则报错
- 不能删除不可删除的属性,否则报错
- 不能删除变量
delete prop,会报错,只能删除属性delete global[prop] eval不会在它的外层作用域引入变量eval和arguments不能被重新赋值arguments不会自动反映函数参数的变化- 不能使用
arguments.callee - 不能使用
arguments.caller - 禁止
this指向全局对象 - 不能使用
fn.caller和fn.arguments获取函数调用的堆栈 - 增加了保留字(比如
protected、static和interface)
export 导出
// profile.jsexport var firstName = 'Michael';export var lastName = 'Jackson';export var year = 1958;// 输出了3个变量// profile2.jsvar firstName = 'Michael';var lastName = 'Jackson';var year = 1958;export {firstName, lastName, year};// 输出一个对象export function multiply(x, y) { // 输出一个函数return x * y;};function v1() { /* ... */ }function v2() { /* ... */ }export { // 输出一个对象,对象中有3个函数,使用as重命名v1 as streamV1,v2 as streamV2,v2 as streamLatestVersion};// 需要特别注意的是,export命令规定的是对外的接口,必须与模块内部的变量建立一一对应关系。// 报错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 的注意事项
export语句输出的接口,与其对应的值是动态绑定关系,即通过该接口,可以取到模块内部实时的值。
export var foo = 'bar';setTimeout(() => foo = 'baz', 500);
上面代码输出变量foo,值为bar,500 毫秒之后变成baz。
这一点与 CommonJS 规范完全不同。CommonJS 模块输出的是值的缓存,不存在动态更新
export命令可以出现在模块的任何位置,只要处于模块顶层就可以。如果处于块级作用域内,就会报错,下一节的import命令也是如此。这是因为处于条件代码块之中,就没法做静态优化了,违背了 ES6 模块的设计初衷。
function foo() {export default 'bar' // SyntaxError}foo()
上面代码中,export语句放在函数之中,结果报错。
import 导入
// main.jsimport {firstName, lastName, year} from './profile.js';function setName(element) {element.textContent = firstName + ' ' + lastName;}import { lastName as surname } from './profile.js';import {a} from './xxx.js'a = {}; // Syntax Error : 'a' is read-only;import {a} from './xxx.js'a.foo = 'hello'; // 合法操作
下面代码仅仅执行lodash模块,但是不输入任何值。
import 'lodash';// 如果多次重复执行同一句import语句,那么只会执行一次,而不会执行多次。import 'lodash';import 'lodash';import { foo } from 'my_module';import { bar } from 'my_module';// 等同于 虽然foo和bar在两个语句中加载,// 但是它们对应的是同一个my_module实例。也就是说,import语句是 Singleton 模式。 单例的import { foo, bar } from 'my_module';
import命令具有提升效果,会提升到整个模块的头部,首先执行。
foo();import { foo } from 'my_module';
下面三种写法都会报错,因为它们用到了表达式、变量和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 的注意事项
目前阶段,通过 Babel 转码,CommonJS 模块的require命令和 ES6 模块的import命令,可以写在同一个模块里面,但是最好不要这样做。因为import在静态解析阶段执行,所以它是一个模块之中最早执行的。下面的代码可能不会得到预期结果。
require('core-js/modules/es6.symbol');require('core-js/modules/es6.promise');import React from 'React';
模块的整体加载
除了指定加载某个输出值,还可以使用整体加载,即用星号(*)指定一个对象,所有输出值都加载在这个对象上面。
// circle.jsexport function area(radius) {return Math.PI * radius * radius;}export function circumference(radius) {return 2 * Math.PI * radius;}// main.jsimport * as circle from './circle';console.log('圆面积:' + circle.area(4));console.log('圆周长:' + circle.circumference(14));
export default 导出
从前面的例子可以看出,使用import命令的时候,用户需要知道所要加载的变量名或函数名,否则无法加载。但是,用户肯定希望快速上手,未必愿意阅读文档,去了解模块有哪些属性和方法。
为了给用户提供方便,让他们不用阅读文档就能加载模块,就要用到export default命令,为模块指定默认输出。
// export-default.jsexport default function () { // 匿名函数console.log('foo');}// import-default.jsimport customName from './export-default'; // 此时可以任意取名。customName(); // 'foo'// 第一组export default function crc32() { // 输出// ...}import crc32 from 'crc32'; // 输入// 第二组export function crc32() { // 输出// ...};import {crc32} from 'crc32'; // 输入
export default 的注意事项
// 正确export var a = 1;// 正确var a = 1;export default a;// 错误export default var a = 1;// 正确export default 42;// 报错export 42;import _ from 'lodash';如果想在一条import语句中,同时输入默认方法和其他接口,可以写成下面这样。import _, { each, forEach } from 'lodash';对应上面代码的export语句如下。export default function (obj) {// ···}export function each(obj, iterator, context) {// ···}export { each as forEach };
export 与 import 的复合写法
export { foo, bar } from 'my_module';// 相当于import { foo, bar } from 'my_module';export { foo, bar };export和import语句可以结合在一起,写成一行。但需要注意的是,写成一行以后,foo和bar实际上并没有被导入当前模块,只是相当于对外转发了这两个接口,导致当前模块不能直接使用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;下面三种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";
模块的继承
// circleplus.jsexport * from 'circle';export var e = 2.71828182846;export default function(x) {return Math.exp(x);}
跨模块常量
本书介绍const命令的时候说过,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); // 1console.log(constants.B); // 3// test2.js 模块import {A, B} from './constants';console.log(A); // 1console.log(B); // 3
如果要使用的常量非常多,可以建一个专门的constants目录,将各种常量写在不同的文件里面,保存在该目录下。
// constants/db.jsexport const db = {url: 'http://my.couchdbserver.local:5984',admin_username: 'admin',admin_password: 'admin password'};// constants/user.jsexport const users = ['root', 'admin', 'staff', 'ceo', 'chief', 'moderator'];
然后,将这些文件输出的常量,合并在index.js里面。
// constants/index.jsexport {db} from './db';export {users} from './users';
使用的时候,直接加载index.js就可以了。
// script.jsimport {db, users} from './constants/index';
import()
import命令会被 JavaScript 引擎静态分析,先于模块内的其他语句执行(import命令叫做“连接” binding 其实更合适)。所以,下面的代码会报错。
// 报错if (x === 2) {import MyModual from './myModual';}
上面代码中,引擎处理import语句是在编译时,这时不会去分析或执行if语句,所以import语句放在if代码块之中毫无意义,因此会报句法错误,而不是执行时错误。也就是说,import和export命令只能在模块的顶层,不能在代码块之中(比如,在if代码块之中,或在函数之中)。
这样的设计,固然有利于编译器提高效率,但也导致无法在运行时加载模块。在语法上,条件加载就不可能实现。如果import命令要取代 Node 的require方法,这就形成了一个障碍。因为require是运行时加载模块,import命令无法取代require的动态加载功能。
const path = './' + fileName;const myModual = require(path);
上面的语句就是动态加载,require到底加载哪一个模块,只有运行时才知道。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()可以在需要的时候,再加载某个模块。
button.addEventListener('click', event => {import('./dialogBox.js').then(dialogBox => {dialogBox.open();}).catch(error => {/* Error handling */})});
上面代码中,import()方法放在click事件的监听函数之中,只有用户点击了按钮,才会加载这个模块。
(2)条件加载import()可以放在if代码块,根据不同的情况,加载不同的模块。
if (condition) {import('moduleA').then(...);} else {import('moduleB').then(...);}
上面代码中,如果满足条件,就加载模块 A,否则加载模块 B。
(3)动态的模块路径import()允许模块路径动态生成。
import(f()).then(...);
注意点
import()加载模块成功以后,这个模块会作为一个对象,当作then方法的参数。因此,可以使用对象解构赋值的语法,获取输出接口。
import('./myModule.js').then(({export1, export2}) => {// ...·});
上面代码中,export1和export2都是myModule.js的输出接口,可以解构获得。
如果模块有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();
浏览器直接加载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); //falseconsole.log(this === undefined); // true
利用顶层的this等于undefined这个语法点,可以侦测当前代码是否在 ES6 模块之中。
const isNotModuleScript = this !== undefined;
Commonjs 与ES6 Module的区别总结
Node 加载 ES6 模块之前,必须了解 ES6 模块与 CommonJS 模块完全不同。
它们有三个重大差异。
- CommonJS 模块是运行时加载,ES6 模块是编译时输出接口。
- CommonJS 模块会缓存模块,第二次加载的时候会从缓存里取。
- ES6 的
import有点像 Unix 系统的“符号连接”,原始值变了,import加载的值也会跟着变。因此,ES6 模块是动态引用,并且不会缓存值,模块里面的变量绑定其所在的模块。而Commonjs模块导出的是值的拷贝(值拷贝的含义并非是指每次导出一个拷贝值,而是此模块被加载后会生成一个exports的导出对象,这个对象的内容改变,不会引起模块内定义的其他变量发生变化,而es6则与其不同,他会生成一个闭包空间,值会会随着引用的情况而改变)。
差异是因为 CommonJS 加载的是一个对象(即module.exports属性),该对象只有在脚本运行完才会生成。而 ES6 模块不是对象,它的对外接口只是一种静态定义,在代码静态解析阶段就会生成。
概述
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 模块之中都是不存在的。
argumentsrequiremoduleexports__filename__dirname
如果你一定要使用这些变量,有一个变通方法,就是写一个 CommonJS 模块输出这些变量,然后再用 ES6 模块加载这个 CommonJS 模块。但是这样一来,该 ES6 模块就不能直接用于浏览器环境了,所以不推荐这样做。
// expose.jsmodule.exports = {__dirname};// use.mjsimport 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.jsmodule.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.jsmodule.exports = null;// es.jsimport foo from './b';// foo = null;import * as bar from './b';// bar = { default:null };
上面代码中,es.js采用第二种写法时,要通过bar.default这样的写法,才能拿到module.exports。
// c.jsmodule.exports = function two() {return 2;};// es.jsimport foo from './c';foo(); // 2import * as bar from './c';bar.default(); // 2bar(); // throws, bar is not a function
上面代码中,bar本身是一个对象,不能当作函数调用,只能通过bar.default调用。
CommonJS 模块的输出缓存机制,在 ES6 加载方式下依然有效。
// foo.jsmodule.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.mjslet foo = { bar: 'my-default' };export default foo;// cjs.js// const es_namespace = await import('./es.mjs');// console.log(es_namespace);// 抛出异常,await is only valid in async function,仅在异步函数中有效const es_namespace = import('./es.mjs'); // import('./es.mjs');返回一个promisees_namespace.then(function(data){console.log(data); // [Module] { default: { bar: 'my-default' } }})// >node --experimental-modules cjs.js
上面代码中,default接口变成了es_namespace.default属性。
下面是另一个例子。
// es.jsexport let foo = { bar:'my-default' };export { foo as bar };export function f() {};export class c {};// cjs.jsconst 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.jsvar b = require('b');// b.jsvar 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 = falseb.js 执行完毕在 a.js 之中,b.done = truea.js 执行完毕在 main.js 之中, a.done=true, b.done=true
上面的代码证明了两件事。一是,在b.js之中,a.js没有执行完毕,只执行了第一行。二是,main.js执行到第二行时,不会再次执行b.js,而是输出缓存的b.js的执行结果,即它的第四行。
exports.done = true;
另外,由于 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.mjsimport {bar} from './b';console.log('a.mjs');console.log(bar);export let foo = 'foo';// b.mjsimport {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.mjsb.mjsReferenceError: foo is not defined
上面代码中,执行a.mjs以后会报错,foo变量未定义,这是为什么?
让我们一行行来看,ES6 循环加载是怎么处理的。首先,执行a.mjs以后,引擎发现它加载了b.mjs,因此会优先执行b.mjs,然后再执行a.mjs。接着,执行b.mjs的时候,已知它从a.mjs输入了foo接口,这时不会去执行a.mjs,而是认为这个接口已经存在了,继续往下执行。执行到第三行console.log(foo)的时候,才发现这个接口根本没定义,因此报错。
解决这个问题的方法,就是让b.mjs运行的时候,foo已经有定义了。这可以通过将foo写成函数来解决。
// a.mjsimport {bar} from './b';console.log('a.mjs');console.log(bar());function foo() { return 'foo' }export {foo};// b.mjsimport {foo} from './a';console.log('b.mjs');console.log(foo());function bar() { return 'bar' }export {bar};
这时再执行a.mjs就可以得到预期结果。
$ node --experimental-modules a.mjsb.mjsfooa.mjsbar
这是因为函数具有提升作用,在执行import {bar} from './b'时,函数foo就已经有定义了,所以b.mjs加载的时候不会报错。这也意味着,如果把函数foo改写成函数表达式,也会报错。
// a.mjsimport {bar} from './b';console.log('a.mjs');console.log(bar());const foo = () => 'foo';export {foo};
上面代码的第四行,改成了函数表达式,就不具有提升作用,执行就会报错。
我们再来看 ES6 模块加载器SystemJS给出的一个例子。
// even.jsimport { odd } from './odd'export var counter = 0;export function even(n) {counter++;return n === 0 || odd(n - 1);}// odd.jsimport { 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.counter6> m.even(20)true> m.counter17
上面代码中,参数n从 10 变为 0 的过程中,even()一共会执行 6 次,所以变量counter等于 6。第二次调用even()时,参数n从 20 变为 0,even()一共会执行 11 次,加上前面的 6 次,所以变量counter等于 17。
这个例子要是改写成 CommonJS,就根本无法执行,会报错。
// even.jsvar odd = require('./odd');var counter = 0;exports.counter = counter;exports.even = function (n) {counter++;return n == 0 || odd(n - 1);}// odd.jsvar 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等于undefined,等到后面调用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方法指定回调函数。
es6 与 commonjs的区别,值的拷贝与值的引用
commonjs 导出时,是值的拷贝,es6的导出,是值的引用,区别是什么呢?看下面的代码
// commonjs// a.jsvar const = 0;module.exports = {count: count,add: function(a, b){count+=1;return a + b;}}// index.jsvar count = require("./a").count;var add = require("./a").add;console.log(count); // 0add(2,3);console.log(count); // 0count+=1;console.log(count); // 1
// es6 值的引用// a.jslet count = 0;const add = function(a, b) {count+=1;return a + b;}export {count, add};// index.jsimport {count, add} form './a.js';console.log(count); // 0add(2,3);console.log(count); // 1// count+=1; 不可更改,会抛出SyntaxError: "count" is read-only
