JavaScript 模組的循環載入實作方法_javascript技巧

"循環載入"（circular dependency）指的是，a腳本的執行依賴b腳本，而b腳本的執行又依賴a腳本。

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

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

通常，"循環加載"表示存在強耦合，如果處理不好，還可能導致遞歸加載，使得程式無法執行，因此應該避免出現。

但實際上，這是很難避免的，尤其是依賴關係複雜的大項目，很容易出現a依賴b，b依賴c，c又依賴a這樣的情況。這意味著，模組載入機制必須考慮"循環載入"的情況。

本文介紹JavaScript語言如何處理"循環載入"。目前，最常見的兩種模組格式CommonJS和ES6，處理方法是不一樣的，回傳的結果也不一樣。

一、CommonJS模組的載入原理

介紹ES6如何處理"循環載入"之前，先介紹目前最受歡迎的CommonJS模組格式的載入原理。

CommonJS的一個模組，就是一個腳本檔。 require指令第一次載入該腳本，就會執行整個腳本，然後在記憶體產生一個物件。

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

上面程式碼中，該物件的id屬性是模組名，exports屬性是模組輸出的各個接口，loaded屬性是一個布林值，表示該模組的腳本是否執行完畢。其他還有很多屬性，這裡都省略了。 （詳細介紹情請參閱《require() 原始碼解讀》。）

以後需要用到這個模組的時候，就會到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不一樣，它遇到模組載入指令import時，不會去執行模組，而是只產生一個引用。等到真的需要用到時，再到模組裡面去取值。

因此，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模組不會快取運行結果，而是動態地去被載入的模組取值，以及變數總是綁定其所在的模組。

這導致ES6處理"循環載入"與CommonJS有本質的不同。 ES6根本不會在乎是否發生了"循環載入"，只是產生一個指向被載入模組的引用，需要開發者自己保證，真正取值的時候能夠取到值。

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

// 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还没有任何执行结果，所以输出结果为null，即对于b.js来说，变量foo的值等于null，后面的foo()就会报错。

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

$ babel-node a.js

执行完毕

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

我们再来看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里面的函数foo有一个参数n，只要不等于0，就会减去1，传入加载的odd()。odd.js也会做类似操作。

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

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

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

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

// 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，形成"循环加载"。这时，执行引擎就会输出even.js已经执行的部分（不存在任何结果），所以在odd.js之中，变量even等于null，等到后面调用even(n-1)就会报错。

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

[说明] 本文是我写的《ECMAScript 6入门》第20章《Module》中的一节。