CommonJs模块加载原理
-
CommonJS的一个模块,就是一个脚本文件。
require
命令第一次加载该脚本,就会执行整个脚本,然后在内存生成一个对象。 -
关于exports属性,以后需要用到这个模块的时候,就会到
exports
属性上面取值。即使再次执行require
命令,也不会再次执行该模块,而是到缓存之中取值。
CommonJs循环加载
- CommonJS模块的重要特性是加载时执行,即脚本代码在
require
的时候,就会全部执行。CommonJS的做法是,一旦出现某个模块被"循环加载",就只输出已经执行的部分,还未执行的部分不会输出。
让我们来看,官方文档里面的例子。脚本文件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;
ES6循环加载
-
ES6 处理“循环加载”与 CommonJS 有本质的不同。ES6 模块是动态引用,如果使用
import
从一个模块加载变量(即import foo from 'foo'
),那些变量不会被缓存,而是成为一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。 -
因此,ES6模块是动态引用,不存在缓存值的问题,而且模块里面的变量,绑定其所在的模块。请看下面的例子。
// 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模块不会缓存运行结果,而是动态地去被加载的模块取值,以及变量总是绑定其所在的模块。
再看一个例子
// 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为入口执行一下
node a.js
// b.js
// ReferenceError: Cannot access 'foo' before initialization
让我们一行行来看,ES6 循环加载是怎么处理的。首先,执行a
以后,引擎发现它加载了b
,因此会优先执行b
,然后再执行a.mjs
。接着,执行b
的时候,已知它从a
输入了foo
接口,这时不会去执行a
,而是认为这个接口已经存在了,继续往下执行。执行到第三行console.log(foo)
的时候,才发现这个接口根本没定义,因此报错。
这导致ES6处理"循环加载"与CommonJS有本质的不同。ES6根本不会关心是否发生了"循环加载",只是生成一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。
注意:这个例子中a.js中还没有定义foo,看下一个例子中,b没有执行未定义的foo,而是又回到a去定义了之后,才执行,故没有报错
再看一个例子,a要使用的bar,就执行b
// a.js
import {bar} from './b.js';
export function foo() {
bar();
console.log('执行完毕');
}
foo();
// b.js
import {foo} from './a.js';
export function bar() {
if (Math.random() > 0.5) {
foo();
}
}
按照CommonJS规范,上面的代码是没法执行的。a
先加载b
,然后b
又加载a
,这时a
还没有任何执行结果,即a在调用b之前还没有export
,缓存中没有东西,所以输出结果为null
,即对于b.js
来说,变量foo
的值等于null
,于是,a
执行foo()
时,通过bar()
调用的foo()
就会报错。
但是,ES6可以执行上面的代码。原因就在于ES6加载的变量,都是动态引用其所在的模块。只要引用是存在的,代码就能执行。如例子中的foo是存在的,CommonJs根据中途值返回的是null,那之后就以为它是null了
总结
-
在被引用的模块要暴露东西出来时,CommonJS是值拷贝,其在缓存中,而ES6是引用拷贝,真正需要时,再去对应的地方(没有缓存的概念)。
-
require用于import不同,前者是函数,运行时加载,后者编译阶段直接加载。
-
CommonJs 动态加载->静态绑定。
-
ES6 静态加载->动态绑定。
-
两者都会执行被加载模块的代码,但是在循环调用时,已经开始执行的模块再一次被调用时,都不会重新开始执行,CommonJs会返回执行的中途的exports值;而ES6仅仅生成引用,只要引用指向的对象存在即可。
-
CommonJS由于是值拷贝,错会一直错到底,而ES6是引用,有未定义,如果后续补充了,那么可以正确调用了。