"循環(huán)加載"（circular dependency）指的是，a腳本的執(zhí)行依賴b腳本，而b腳本的執(zhí)行又依賴a腳本。

// a.js
var b = require('b');

// b.js
var a = require('a');

通常，"循環(huán)加載"表示存在強耦合，如果處理不好，還可能導(dǎo)致遞歸加載，使得程序無法執(zhí)行，因此應(yīng)該避免出現(xiàn)。

但是實際上，這是很難避免的，尤其是依賴關(guān)系復(fù)雜的大項目，很容易出現(xiàn)a依賴b，b依賴c，c又依賴a這樣的情況。這意味著，模塊加載機制必須考慮"循環(huán)加載"的情況。

本文介紹JavaScript語言如何處理"循環(huán)加載"。目前，最常見的兩種模塊格式CommonJS和ES6，處理方法是不一樣的，返回的結(jié)果也不一樣。

一、CommonJS模塊的加載原理

介紹ES6如何處理"循環(huán)加載"之前，先介紹目前最流行的CommonJS模塊格式的加載原理。

CommonJS的一個模塊，就是一個腳本文件。require命令第一次加載該腳本，就會執(zhí)行整個腳本，然后在內(nèi)存生成一個對象。

{
 id: '...',
 exports: { ... },
 loaded: true,
 ...
}

上面代碼中，該對象的id屬性是模塊名，exports屬性是模塊輸出的各個接口，loaded屬性是一個布爾值，表示該模塊的腳本是否執(zhí)行完畢。其他還有很多屬性，這里都省略了。（詳細介紹情參見《require() 源碼解讀》。）

以后需要用到這個模塊的時候，就會到exports屬性上面取值。即使再次執(zhí)行require命令，也不會再次執(zhí)行該模塊，而是到緩存之中取值。

二、CommonJS模塊的循環(huán)加載

CommonJS模塊的重要特性是加載時執(zhí)行，即腳本代碼在require的時候，就會全部執(zhí)行。CommonJS的做法是，一旦出現(xiàn)某個模塊被"循環(huán)加載"，就只輸出已經(jīng)執(zhí)行的部分，還未執(zhí)行的部分不會輸出。

讓我們來看，官方文檔里面的例子。腳本文件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 執(zhí)行完畢');

上面代碼之中，a.js腳本先輸出一個done變量，然后加載另一個腳本文件b.js。注意，此時a.js代碼就停在這里，等待b.js執(zhí)行完畢，再往下執(zhí)行。

再看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 執(zhí)行完畢');

上面代碼之中，b.js執(zhí)行到第二行，就會去加載a.js，這時，就發(fā)生了"循環(huán)加載"。系統(tǒng)會去a.js模塊對應(yīng)對象的exports屬性取值，可是因為a.js還沒有執(zhí)行完，從exports屬性只能取回已經(jīng)執(zhí)行的部分，而不是最后的值。

a.js已經(jīng)執(zhí)行的部分，只有一行。

exports.done = false;

因此，對于b.js來說，它從a.js只輸入一個變量done，值為false。

然后，b.js接著往下執(zhí)行，等到全部執(zhí)行完畢，再把執(zhí)行權(quán)交還給a.js。于是，a.js接著往下執(zhí)行，直到執(zhí)行完畢。我們寫一個腳本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);

執(zhí)行main.js，運行結(jié)果如下。

$ node main.js

在 b.js 之中，a.done = false
b.js 執(zhí)行完畢
在 a.js 之中，b.done = true
a.js 執(zhí)行完畢
在 main.js 之中, a.done=true, b.done=true

上面的代碼證明了兩件事。一是，在b.js之中，a.js沒有執(zhí)行完畢，只執(zhí)行了第一行。二是，main.js執(zhí)行到第二行時，不會再次執(zhí)行b.js，而是輸出緩存的b.js的執(zhí)行結(jié)果，即它的第四行。

exports.done = true;

三、ES6模塊的循環(huán)加載

ES6模塊的運行機制與CommonJS不一樣，它遇到模塊加載命令import時，不會去執(zhí)行模塊，而是只生成一個引用。等到真的需要用到時，再到模塊里面去取值。

因此，ES6模塊是動態(tài)引用，不存在緩存值的問題，而且模塊里面的變量，綁定其所在的模塊。請看下面的例子。

// 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毫秒，又變?yōu)榈扔赽az。

讓我們看看，m2.js能否正確讀取這個變化。

$ babel-node m2.js

bar
baz

面代碼表明，ES6模塊不會緩存運行結(jié)果，而是動態(tài)地去被加載的模塊取值，以及變量總是綁定其所在的模塊。

這導(dǎo)致ES6處理"循環(huán)加載"與CommonJS有本質(zhì)的不同。ES6根本不會關(guān)心是否發(fā)生了"循環(huán)加載"，只是生成一個指向被加載模塊的引用，需要開發(fā)者自己保證，真正取值的時候能夠取到值。

請看下面的例子（摘自 Dr. Axel Rauschmayer 的《Exploring ES6》）。

// a.js
import {bar} from './b.js';
export function foo() {
 bar(); 
 console.log('執(zhí)行完畢');
}
foo();

// b.js
import {foo} from './a.js';
export function bar() { 
 if (Math.random() > 0.5) {
 foo();
 }
}

按照CommonJS規(guī)范，上面的代碼是沒法執(zhí)行的。a先加載b，然后b又加載a，這時a還沒有任何執(zhí)行結(jié)果，所以輸出結(jié)果為null，即對于b.js來說，變量foo的值等于null，后面的foo()就會報錯。

但是，ES6可以執(zhí)行上面的代碼。

$ babel-node a.js

執(zhí)行完畢

a.js之所以能夠執(zhí)行，原因就在于ES6加載的變量，都是動態(tài)引用其所在的模塊。只要引用是存在的，代碼就能執(zhí)行。

我們再來看ES6模塊加載器SystemJS給出的一個例子。

// even.js
import { odd } from './odd'
export var counter = 0;
export function even(n) {
 counter++;
 return n == 0 || odd(n - 1);
}

// odd.js
import { even } from './even';
export function odd(n) {
 return n != 0 && even(n - 1);
}

上面代碼中，even.js里面的函數(shù)foo有一個參數(shù)n，只要不等于0，就會減去1，傳入加載的odd()。odd.js也會做類似操作。

運行上面這段代碼，結(jié)果如下。

$ babel-node
> import * as m from './even.js';
> m.even(10);
true
> m.counter
6
> m.even(20)
true
> m.counter
17

上面代碼中，參數(shù)n從10變?yōu)?的過程中，foo()一共會執(zhí)行6次，所以變量counter等于6。第二次調(diào)用even（）時，參數(shù)n從20變?yōu)?，foo()一共會執(zhí)行11次，加上前面的6次，所以變量counter等于17。

這個例子要是改寫成CommonJS，就根本無法執(zhí)行，會報錯。

// even.js
var odd = require('./odd');
var counter = 0;
exports.counter = counter;
exports.even = function(n) {
 counter++;
 return n == 0 || odd(n - 1);
}

// odd.js
var even = require('./even').even;
module.exports = function(n) {
 return n != 0 && even(n - 1);
}

上面代碼中，even.js加載odd.js，而odd.js又去加載even.js，形成"循環(huán)加載"。這時，執(zhí)行引擎就會輸出even.js已經(jīng)執(zhí)行的部分（不存在任何結(jié)果），所以在odd.js之中，變量even等于null，等到后面調(diào)用even(n-1)就會報錯。

$ node
> var m = require('./even');
> m.even(10)
TypeError: even is not a function

[說明] 本文是我寫的《ECMAScript 6入門》第20章《Module》中的一節(jié)。

最新評論