IT博客汇
  • 首页
  • 精华
  • 技术
  • 设计
  • 资讯
  • 扯淡
  • 权利声明
  • 登录 注册

    JavaScript 模块的循环加载

    阮一峰发表于 2015-11-02 08:45:25
    love 0

    "循环加载"(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模块

    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,而是只返回已经执行的部分。

    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');
    exports.odd = 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: odd is not a function
    

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

    (完)

    文档信息

    • 版权声明:自由转载-非商用-非衍生-保持署名(创意共享3.0许可证)
    • 发表日期: 2015年11月 2日
    • 更多内容: 档案 » JavaScript
    • 购买文集: 《如何变得有思想》
    • 社交媒体: twitter, weibo
    • Feed订阅:


沪ICP备19023445号-2号
友情链接