es6 循环加载ES6模块

循环加载ES6模块

“循环加载”(circular dependency)指的是,a脚本的执行依赖b脚本,而b脚本的执行又依赖a脚本。

 
  1. // a.js
  2. var b = require('b');
  3. // b.js
  4. var a = require('a');

通常,“循环加载”表示存在强耦合,如果处理不好,还可能导致递归加载,使得程序无法执行,因此应该避免出现。

但是实际上,这是很难避免的,尤其是依赖关系复杂的大项目,很容易出现a依赖bb依赖cc又依赖a这样的情况。这意味着,模块加载机制必须考虑“循环加载”的情况。

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

CommonJS模块的加载原理

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

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

 
  1. {
  2. id: '...',
  3. exports: { ... },
  4. loaded: true,
  5. ...
  6. }

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

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

CommonJS模块的循环加载

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

让我们来看,Node官方文档里面的例子。脚本文件a.js代码如下。

 
  1. exports.done = false;
  2. var b = require('./b.js');
  3. console.log('在 a.js 之中,b.done = %j', b.done);
  4. exports.done = true;
  5. console.log('a.js 执行完毕');

上面代码之中,a.js脚本先输出一个done变量,然后加载另一个脚本文件b.js。注意,此时a.js代码就停在这里,等待b.js执行完毕,再往下执行。

再看b.js的代码。

 
  1. exports.done = false;
  2. var a = require('./a.js');
  3. console.log('在 b.js 之中,a.done = %j', a.done);
  4. exports.done = true;
  5. console.log('b.js 执行完毕');

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

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

 
  1. exports.done = false;

因此,对于b.js来说,它从a.js只输入一个变量done,值为false

然后,b.js接着往下执行,等到全部执行完毕,再把执行权交还给a.js。于是,a.js接着往下执行,直到执行完毕。我们写一个脚本main.js,验证这个过程。

 
  1. var a = require('./a.js');
  2. var b = require('./b.js');
  3. console.log('在 main.js 之中, a.done=%j, b.done=%j', a.done, b.done);

执行main.js,运行结果如下。

 
  1. $ node main.js
  2. b.js 之中,a.done = false
  3. b.js 执行完毕
  4. a.js 之中,b.done = true
  5. a.js 执行完毕
  6. main.js 之中, a.done=true, b.done=true

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

 
  1. exports.done = true;

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

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

 
  1. var a = require('a'); // 安全的写法
  2. var foo = require('a').foo; // 危险的写法
  3. exports.good = function (arg) {
  4. return a.foo('good', arg); // 使用的是 a.foo 的最新值
  5. };
  6. exports.bad = function (arg) {
  7. return foo('bad', arg); // 使用的是一个部分加载时的值
  8. };

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

ES6模块的循环加载

ES6 处理“循环加载”与 CommonJS 有本质的不同。ES6模块是动态引用,如果使用import从一个模块加载变量(即import foo from 'foo'),那些变量不会被缓存,而是成为一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。

请看下面这个例子。

 
  1. // a.mjs
  2. import {bar} from './b';
  3. console.log('a.mjs');
  4. console.log(bar);
  5. export let foo = 'foo';
  6. // b.mjs
  7. import {foo} from './a';
  8. console.log('b.mjs');
  9. console.log(foo);
  10. export let bar = 'bar';

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

 
  1. $ node --experimental-modules a.mjs
  2. b.mjs
  3. 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写成函数来解决。

 
  1. // a.mjs
  2. import {bar} from './b';
  3. console.log('a.mjs');
  4. console.log(bar());
  5. function foo() { return 'foo' }
  6. export {foo};
  7. // b.mjs
  8. import {foo} from './a';
  9. console.log('b.mjs');
  10. console.log(foo());
  11. function bar() { return 'bar' }
  12. export {bar};

这时再执行a.mjs就可以得到预期结果。

 
  1. $ node --experimental-modules a.mjs
  2. b.mjs
  3. foo
  4. a.mjs
  5. bar

这是因为函数具有提升作用,在执行import {bar} from './b'时,函数foo就已经有定义了,所以b.mjs加载的时候不会报错。这也意味着,如果把函数foo改写成函数表达式,也会报错。

 
  1. // a.mjs
  2. import {bar} from './b';
  3. console.log('a.mjs');
  4. console.log(bar());
  5. const foo = () => 'foo';
  6. export {foo};

上面代码的第四行,改成了函数表达式,就不具有提升作用,执行就会报错。

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

 
  1. // even.js
  2. import { odd } from './odd'
  3. export var counter = 0;
  4. export function even(n) {
  5. counter++;
  6. return n === 0 || odd(n - 1);
  7. }
  8. // odd.js
  9. import { even } from './even';
  10. export function odd(n) {
  11. return n !== 0 && even(n - 1);
  12. }

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

运行上面这段代码,结果如下。

 
  1. $ babel-node
  2. > import * as m from './even.js';
  3. > m.even(10);
  4. true
  5. > m.counter
  6. 6
  7. > m.even(20)
  8. true
  9. > m.counter
  10. 17

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

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

 
  1. // even.js
  2. var odd = require('./odd');
  3. var counter = 0;
  4. exports.counter = counter;
  5. exports.even = function (n) {
  6. counter++;
  7. return n == 0 || odd(n - 1);
  8. }
  9. // odd.js
  10. var even = require('./even').even;
  11. module.exports = function (n) {
  12. return n != 0 && even(n - 1);
  13. }

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

 
  1. $ node
  2. > var m = require('./even');
  3. > m.even(10)
  4. TypeError: even is not a function
相关推荐
©️2020 CSDN 皮肤主题: 成长之路 设计师:Amelia_0503 返回首页