文章目录
  1. 1. 简单模块定义和使用
  2. 2. 模块载入策略
    1. 2.1. 文件模块类型
    2. 2.2. .js文件编译过程
  3. 3. require方法中的文件查找策略
    1. 3.1. 从文件模块缓存中加载
    2. 3.2. 从原生模块加载
    3. 3.3. 从原生模块加载
      1. 3.3.1. require方法接受的参数
  4. 4. 查找文件模块过程

以前JS的规范十分薄弱,没有模块系统、标准库、标准接口和包管理系统,不利于JS大规模的应用。于是便有了CommonJS规范的出现,其目标是为了构建JavaScript在包括Web服务器,桌面,命令行工具,及浏览器方面的生态系统。

CommonJS制定了解决这些问题的一些规范,而Node.js就是这些规范的一种实现。Node.js自身实现了require方法作为其引入模块的方法,同时NPM也基于CommonJS定义的包规范,实现了依赖管理和模块自动安装等功能。这里我们将深入一下Node.js的require机制和NPM基于包规范的应用。

简单模块定义和使用

  1. 定义一个模块hello.js:

    funtion hello(name) {
        console.log('Hello' + name);
    }
    exports.hello = hello;
    
  2. 调用hello.js,调用模块就成为main.js:

    var hello = require('./hello.js');
    hello.hello();
    

    在以上示例中,hello.js 通过 exports 对象把 hello 作为模块的访 问接口,在 main.js 中通过 require(‘./hello’) 加载这个模块,然后就可以直接访 问main.js 中 exports 对象的成员函数了。

有时候我们只是想把一个对象封装到模块中,格式如下:

module.exports = function() {
  // ...
}

实例:

//hello.js 
function Hello() { 
    varname; 
    this.setName = function(thyName) { 
        name = thyName; 
    }; 
    this.sayHello = function() { 
        console.log('Hello ' + name); 
    }; 
}; 
module.exports = Hello;

模块接口的唯一变化是使用 module.exports = Hello 代替了exports.world = function(){}。 在外部引用该模块时,其接口对象就是要输出的 Hello 对象本身,而不是原先的 exports。

模块载入策略

Node.js的模块分为两类,一类为原生(核心)模块,一类为文件模块。原生模块在Node.js源代码编译的时候编译进了二进制执行文件,加载的速度最快。另一类文件模块是动态加载的,加载速度比原生模块慢。但是Node.js对原生模块和文件模块都进行了缓存,于是在第二次require时,是不会有重复开销的。其中原生模块都被定义在lib这个目录下面,文件模块则不定性。

由于通过命令行加载启动的文件几乎都为文件模块。我们从Node.js如何加载文件模块开始谈起。加载文件模块的工作,主要由原生模块module来实现和完成,该原生模块在启动时已经被加载,进程直接调用到runMain静态方法。

// bootstrap main module.
Module.runMain = function () {
    // Load the main module--the command line argument.
    Module._load(process.argv[1], null, true);
};

_load静态方法在分析文件名之后执行

var module = new Module(id, parent);

并根据文件路径缓存当前模块对象,该模块实例对象则根据文件名加载。

module.load(filename);

文件模块类型

在文件模块中,又分为3类模块。这三类文件模块以后缀来区分,Node.js会根据后缀名来决定加载方法。

  1. .js: 通过fs模块同步读取js文件并编译执行。
  2. .node: 是预编译好的插件模块,通过C/C++进行编写的Addon。通过dlopen方法进行加载。
  3. .json:是json格式对象,读取文件,调用JSON.parse解析加载。

.js文件编译过程

Node.js在编译js文件的过程中实际完成的步骤有对js文件内容进行头尾包装。以main.js为例,包装之后的main.js将会变成以下形式:

(function (exports, require, module, __filename, __dirname) {
    var hello = require('./hello.js');
    hello.hello();
});

这段代码会通过vm原生模块的runInThisContext方法执行(类似eval,只是具有明确上下文,不污染全局),返回为一个具体的function对象。最后传入module对象的exports,require方法,module,文件名,目录名作为实参并执行。

这就是为什么require并没有定义在main.js 文件中,但是这个方法却存在的原因。从Node.js的API文档中可以看到还有filename、dirname、module、exports几个没有定义但是却存在的变量。其中filename和dirname在查找文件路径的过程中分析得到后传入的。module变量是这个模块对象自身,exports是在module的构造函数中初始化的一个空对象({},而不是null)。

在这个主文件中,可以通过require方法去引入其余的模块。而其实这个require方法实际调用的就是load方法。

oad方法在载入、编译、缓存了module后,返回module的exports对象。这就是hello.js文件中只有定义在exports对象上的方法才能被外部调用的原因。

以上所描述的模块载入机制均定义在lib/module.js中

require方法中的文件查找策略

由于Node.js中存在4类模块(原生模块和3种文件模块),尽管require方法极其简单,但是内部的加载却是十分复杂的,其加载优先级也各自不同。

从文件模块缓存中加载

尽管原生模块与文件模块的优先级不同,但是都不会优先于从文件模块的缓存中加载已经存在的模块。

从原生模块加载

原生模块的优先级仅次于文件模块缓存的优先级。require方法在解析文件名之后,优先检查模块是否在原生模块列表中。以http模块为例,尽管在目录下存在一个http/http.js/http.node/http.json文件,require(“http”)都不会从这些文件中加载,而是从原生模块中加载。

原生模块也有一个缓存区,同样也是优先从缓存区加载。如果缓存区没有被加载过,则调用原生模块的加载方式进行加载和执行。

从原生模块加载

当文件模块缓存中不存在,而且不是原生模块的时候,Node.js会解析require方法传入的参数,并从文件系统中加载实际的文件.

require方法接受的参数

  1. http、fs、path等,原生模块。
  2. ./mod或../mod,相对路径的文件模块。
  3. /pathtomodule/mod,绝对路径的文件模块。
  4. mod,非原生模块的文件模块。

查找文件模块过程

在进入路径查找之前我们先描述一下module path这个Node.js中的概念。对于每一个被加载的文件模块,创建这个模块对象的时候,这个模块便会有一个paths属性,其值根据当前文件的路径计算得到。

module path的生成规则为:从当前文件目录开始查找node_modules目录;然后依次进入父目录,查找父目录下的node_modules目录;依次迭代,直到根目录下的node_modules目录。

除此之外还有一个全局module path,是当前node执行文件的相对目录(../../lib/node)。

简而言之,如果require绝对路径的文件,查找时不会去遍历每一个node_modules目录,其速度最快。其余流程如下:

  1. 从module path数组中取出第一个目录作为查找基准。
  2. 直接从目录中查找该文件,如果存在,则结束查找。如果不存在,则进行下一条查找。
  3. 尝试添加.js、.json、.node后缀后查找,如果存在文件,则结束查找。如果不存在,则进行下一条。
  4. 尝试将require的参数作为一个包来进行查找,读取目录下的package.json文件,取得main参数指定的文件。
  5. 尝试查找该文件,如果存在,则结束查找。如果不存在,则进行第3条查找。
  6. 如果继续失败,则取出module path数组中的下一个目录作为基准查找,循环第1至5个步骤。
  7. 如果继续失败,循环第1至6个步骤,直到module path中的最后一个值。
  8. 如果仍然失败,则抛出异常。

整个查找过程十分类似原型链的查找和作用域的查找。所幸Node.js对路径查找实现了缓存机制,否则由于每次判断路径都是同步阻塞式进行,会导致严重的性能消耗。

文章目录
  1. 1. 简单模块定义和使用
  2. 2. 模块载入策略
    1. 2.1. 文件模块类型
    2. 2.2. .js文件编译过程
  3. 3. require方法中的文件查找策略
    1. 3.1. 从文件模块缓存中加载
    2. 3.2. 从原生模块加载
    3. 3.3. 从原生模块加载
      1. 3.3.1. require方法接受的参数
  4. 4. 查找文件模块过程