阮一峰:JavaScript 模块的循环加载

移动开发
"循环加载"(circular dependency)指的是,a脚本的执行依赖b脚本,而b脚本的执行又依赖a脚本。

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

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

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

[[154576]]

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

本文介绍JavaScript语言如何处理"循环加载"。目前,最常见的两种模块格式CommonJS和ES6,处理方法是不一样的,返回的结果也不一样。

CommonJS模块

CommonJS模块的重要特性是加载时执行,即脚本代码在require的时候,就会全部执行。因此,CommonJS规定,一旦发现某个模块被"循环加载",就立即停止加载,只输出已经执行的部分。

让我们来看,官方文档里面的例子。脚本文件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,而是只返回已经执行的部分。

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.  
  3. 在 b.js 之中,a.done = false 
  4. b.js 执行完毕 
  5. 在 a.js 之中,b.done = true 
  6. a.js 执行完毕 
  7. 在 main.js 之中, a.done=true, b.done=true 

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

  1. exports.done = true

ES6模块

ES6模块的运行机制与CommonJS不一样,它遇到模块加载命令import时,不会去执行模块,而是只生成一个引用。等到真的需要用到时,再到模块里面去取值。

因此,ES6模块是动态引用,不存在缓存值的问题,而且模块里面的变量,绑定其所在的模块。请看下面的例子。

  1. // m1.js 
  2. export var foo = 'bar'
  3. setTimeout(() => foo = 'baz'500); 
  4.  
  5. // m2.js 
  6. import {foo} from './m1.js'
  7. console.log(foo); 
  8. setTimeout(() => console.log(foo), 500); 

上面代码中,m1.js的变量foo,在刚加载时等于bar,过了500毫秒,又变为等于baz。

让我们看看,m2.js能否正确读取这个变化。

  1. $ babel-node m2.js 
  2.  
  3. bar 
  4. baz 

上面代码表明,ES6模块不会缓存运行结果,而是动态地去被加载的模块取值,以及变量总是绑定其所在的模块。

这导致ES6处理"循环加载"与CommonJS有本质的不同。ES6根本不会检查是否发生了"循环加载",只是生成一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。

请看下面的例子(摘自 Dr. Axel Rauschmayer 的《Exploring ES6》)。

  1. // a.js 
  2. import {bar} from './b.js'
  3. export function foo() { 
  4.   bar();   
  5.   console.log('执行完毕'); 
  6. foo(); 
  7.  
  8. // b.js 
  9. import {foo} from './a.js'
  10. export function bar() {   
  11.   if (Math.random() > 0.5) { 
  12.     foo(); 
  13.   } 

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

但是,ES6可以执行上面的代码。

  1. $ babel-node a.js 
  2.  
  3. 执行完毕 

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

我们再来看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); 

上面代码中,even.js里面的函数foo有一个参数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的过程中,foo()一共会执行6次,所以变量counter等于6。第二次调用even()时,参数n从20变为0,foo()一共会执行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'); 
  11. exports.odd = function(n) { 
  12.   return n != 0 && even(n - 1); 

上面代码中,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: odd is not a function

(完)

责任编辑:倪明 来源: 阮一峰的技术博客
相关推荐

2012-11-15 09:43:08

开发算法高斯模糊

2011-12-05 10:44:38

inodeLinux文件系统

2015-11-13 11:33:39

阮一峰ecmascript

2015-10-08 08:44:23

阮一峰Github清点对象

2015-09-17 15:23:56

阮一峰网页性能

2015-09-06 10:34:54

蒙特卡洛阮一峰

2015-09-24 09:43:08

阮一峰持续集成

2015-09-18 15:21:33

求职就业创业阮一峰

2011-07-28 14:29:45

JavaScript

2015-09-29 08:51:59

内存地址主引导

2013-08-20 18:39:34

JavaScript模requireJS

2017-03-28 21:25:19

无循环代码JavaScript

2021-11-22 22:14:46

JavaScript开发模块

2009-08-27 11:02:22

JavaScript事

2022-03-11 14:59:21

JavaScript数组字符串

2017-02-13 11:45:19

JavaScriptfor循环

2016-09-06 21:23:25

JavaScriptnode异步

2013-09-18 14:01:46

JavaScript

2020-12-25 10:28:41

JavaScript模块module

2010-09-13 09:18:22

JavaScript模块模式
点赞
收藏

51CTO技术栈公众号