"循環加載"(circular dependency)指的是,a腳本的執行依賴b腳本,而b腳本的執行又依賴a腳本。
// a.jsvar b = require('b');// b.jsvar 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 = falseb.js 執行完畢在 a.js 之中,b.done = truea.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.jsexport var foo = 'bar';setTimeout(() => foo = 'baz', 500);// m2.jsimport {foo} from './m1.js';console.log(foo);setTimeout(() => console.log(foo), 500);
上面代碼中,m1.js的變量foo,在剛加載時等于bar,過了500毫秒,又變為等于baz。
讓我們看看,m2.js能否正確讀取這個變化。
$ babel-node m2.jsbarbaz
面代碼表明,ES6模塊不會緩存運行結果,而是動態地去被加載的模塊取值,以及變量總是綁定其所在的模塊。
這導致ES6處理"循環加載"與CommonJS有本質的不同。ES6根本不會關心是否發生了"循環加載",只是生成一個指向被加載模塊的引用,需要開發者自己保證,真正取值的時候能夠取到值。
請看下面的例子(摘自 Dr. Axel Rauschmayer 的《Exploring ES6》)。
// a.jsimport {bar} from './b.js';export function foo() { bar(); console.log('執行完畢');}foo();// b.jsimport {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.jsimport { odd } from './odd'export var counter = 0;export function even(n) { counter++; return n == 0 || odd(n - 1);}// odd.jsimport { 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.counter6> m.even(20)true> m.counter17
上面代碼中,參數n從10變為0的過程中,foo()一共會執行6次,所以變量counter等于6。第二次調用even()時,參數n從20變為0,foo()一共會執行11次,加上前面的6次,所以變量counter等于17。
這個例子要是改寫成CommonJS,就根本無法執行,會報錯。
// even.jsvar odd = require('./odd');var counter = 0;exports.counter = counter;exports.even = function(n) { counter++; return n == 0 || odd(n - 1);}// odd.jsvar 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》中的一節。