美文网首页
node系列之modules

node系列之modules

作者: 一溪酒 | 来源:发表于2016-12-21 19:56 被阅读39次

    地址

    传送门

    说明

    模块也算是nodejs的核心了。每个js文件就是一个模块,通过exports对外开放自己的方法。正是因为有了module的存在,才能让nodejs实现模块化。

    功能模块

    • 访问主模块(最开始的调用者)
      1.js require 2.js, 2.js require 3.js。 在3.js 里面可以通过访问 require.main来获得1.js模块。
    // 1.js
    module.exports = {   
      a: 44
    };
    require('./2');
    //3.js
    console.log(require.main.exports);
    // output: {a: 44}
    

    这里需要注意的是,直接获取的require.main指的是这个模块,并不是module.exports对象。所以想要获取主模块对外的属性,可以通过require.main.exports来实现。所以require.main指的是module而不是module.exports

    • 循环依赖
      记住一个原则: 当require一个文件的时候,不管有没有遇到循环依赖,你获取到的这个模块,就是当前的module.exports。比如
    // 1.js
    console.log('1 starting');
    exports.a= 1;
    var b = require('./2.js');
    exports.b= 2;
    
    // 2.js
    console.log('2 starting');
    var b = require('./2.js');
    console.log(b);
    // output:  {a: 1}
    

    因为在1.js在加载 2.js的过程中,它是没有完全执行的(只有a属性而没有b属性),所以在2.js获取到的1.js,其实也就只有a属性。等这些文件都完全加载完之后,再更新require.cache。在此之前,都是半成品(虽然也会写入缓存)。

    缓存机制

    上面说得有点乱,现在再来理清一下缓存的机制。在刚加载这个文件的时候,就已经将这个模块放在缓存require.cache里面了,假如继续有修改的话,会发现缓存也会接着变化。比如

    console.log(require.cache);   // exports = {};
    module.exports.a = 2;
    console.log(require.cache);  // exports = {a: 2}
    

    执行上面这些语句的时候,可以对比一下两次输出,会发现缓存的对象已经存在了,只是可能会接着发生变化而已。下面有两个问题

    • 如果有一个模块未被完全加载,然后同时被另外的模块加载,那岂不是加载的数据不一样啦?
      A:是的,比如上面那个循环依赖的例子

    • 加载一个模块之后,可以通过修改它的数据来改变缓存吗,然后导致其他的调用者也发生变化吗?
      A:

    var a = require('./other');
    console.log(require.cache);
    a.aaaaa = 33333;
    console.log(require.cache);
    

    通过上面简单地例子,我们可以看出,是的。会改变。因为在这里,修改的是引用指向的内存块,所以能直接修改。

    文件模块

    在很多的nodejs开源项目里面,在某个文件夹下,会有个package.json文件。其中namemain是两个比较重要的参数。前者代表这个模块的名字;后者表示,当被加载的时候,去哪个地方寻找入口文件。比如在example文件下的
    package.json

    {  
      "name": "a6666",  
      "main": "./../test.js"
    }
    

    require('./example')的时候,发现有个说明文件,然后根据main查找入口文件。所以最终加载的是test.jsmain`参数默认是index.js。那么问题来了,假如某个文件夹下有个example文件夹和同名文件example.js,会加载哪个呢?手动试试就知道啦。我猜是加载目录。想要知道具体的原因的话,可以了解下模块加载的顺序。

    加载node_modules的顺序

    从当前的node_modules一直寻找,找不到的话继续在父目录寻找,直到找到为止,实在找不到就报错了。

    这里有个全局模块的概念,会在环境变量中查找node_modules。不过官方并不推荐,称之为“历史原因”,而且速度会降下来。所以建议是直接放在项目本地就好啦。

    模块包装器

    这是一个很重要的东西。因为有这个,才会有模块化存在。每个文件其实是经过包装的(不然你以为那5个“全局”变量是怎么来的)

    (function (exports, require, module, __filename, __dirname) {
      // Your module code actually lives in here
    });
    

    这一层我们开发者是感知不到的,因为在运行时期才会进行包装。所以我们能直接使用这些变量。有了这个东东,想要污染全局变量都难啊

    module的一些属性

    • module.children

    • module.parent
      上面这两个属性可以看出各个模块的加载次序。一个模块可以被加载多次,但是module.parent只有一个,随之而来的是,一个模块,只能是某一个模块的children,而不能是多个。因为,在第一次加载的时候,这些父子爷辈关系已经明确下来了。无论后面怎么加载与被加载,都不会发生变化。当然,手动修改缓存除外咯。

    • module.loaded 是否曾经被加载过

    • module.require(id) 返回缓存里面的 module.exports对象。

    • module.id 缓存的key(一般来说文件实际路径)

    • module.filename 缓存模块的文件路径

    • module.exports 用得最多的,就是这个家伙了。不解释了。

    小结

    nodejs的模块系统还是设计得挺好的,尤其是模块化。比较有意思的是模块加载机制。上面的 传送门 有得看,我也不解释了(其实我没深入看过,哈哈)

    相关文章

      网友评论

          本文标题:node系列之modules

          本文链接:https://www.haomeiwen.com/subject/myiqvttx.html