深入解析Node.js模块机制：从CommonJS到加载流程

CommonJS模块规范基础

一、CommonJS的模块规范

Node.js的运行环境、浏览器环境以及W3C组织、CommonJS组织和ECMAScript标准制定组织之间存在着紧密的演进关系。

Node.js借鉴了CommonJS的Modules规范，实现了一套专属的模块系统。因此，理解CommonJS的原始规范是掌握Node.js模块机制的基础。

CommonJS对模块的定义相对简洁，主要包含三个核心部分：模块引用、模块定义以及模块标识。

1. 模块引用

模块引用的具体实现代码如下：

var math = require('math');

在CommonJS规范中，提供了require()方法。该方法接收模块标识符作为参数，将指定模块的API引入到当前的执行上下文中。

2. 模块定义

在模块内部，上下文提供了require()方法用于引入外部依赖。为了导出当前模块的功能，上下文提供了exports对象，它是模块唯一的导出出口。此外，还存在一个module对象，代表模块自身，而exports仅是module的一个属性。在Node.js中，一个文件即被视为一个模块，开发者只需将需要导出的方法或变量挂载到exports对象上即可定义导出行为：

// math.js
exports.add = function () { 
var sum = 0,  i = 0,  args = arguments,  l = args.length; 
while (i < l) {  sum += args[i++]; }
 return sum;
};

在另一个文件中，通过require()方法引入该模块后，即可调用其中定义的属性或方法：

// program.js
var math = require('math');
exports.increment = function (val) { return math.add(val, 1);};

3. 模块标识

模块标识是传递给require()方法的参数，它必须是符合小驼峰命名法的字符串，或者是以.、..开头的相对路径，亦或是绝对路径。标识符可以省略.js后缀。这种定义方式简洁明了，其核心价值在于将相关的方法和变量封装在私有作用域中，同时通过引入和导出机制，顺畅地连接上下游依赖。每个模块拥有独立的空间，互不干扰，引用过程清晰高效。

Node.js模块加载流程

二、Node的模块实现

Node.js在实现模块系统时，并未完全照搬规范，而是进行了取舍并增加了一些自身特性。尽管exports、require和module概念简单，但Node.js在底层实现过程中经历了一系列复杂处理。在Node.js中引入模块，通常需要经历以下三个步骤：

1. 路径分析

2. 文件定位

3. 编译执行

Node.js中的模块主要分为两类：一类是由Node.js提供的核心模块，另一类是用户编写的文件模块。

• 核心模块在Node源代码编译过程中，已被编译进二进制执行文件。Node进程启动时，部分核心模块直接加载至内存。因此，引入核心模块时，可以省略文件定位和编译执行步骤，且在路径分析中优先判断，加载速度最快。

• 文件模块在运行时动态加载，必须完整执行路径分析、文件定位和编译执行过程，因此加载速度相对较慢。

1. 优先从缓存加载

与浏览器缓存静态脚本以提升性能类似，Node.js对已引入的模块进行缓存，以减少二次引入的开销。区别在于，浏览器仅缓存文件，而Node.js缓存的是编译和执行后的对象。无论是核心模块还是文件模块，require()方法在二次加载相同模块时，均优先采用缓存，这是最高优先级的策略。不同之处在于，核心模块的缓存检查优先于文件模块的缓存检查。

2. 路径分析和文件定位

由于模块标识符有多种形式，不同标识符在查找和定位时存在显著差异。

1）. 模块标识符分析 Node.js基于模块标识符进行查找。在Node.js中，模块标识符主要分为以下几类：

核心模块，如http、fs、path等。 以.或..开头的相对路径文件模块。 以/开头的绝对路径文件模块。 非路径形式的文件模块，如自定义的connect模块。

• 核心模块

核心模块的优先级仅次于缓存加载。它在Node.js源代码编译过程中已编译为二进制代码，加载速度最快。如果尝试加载与核心模块标识符相同的自定义模块，将会失败。若希望加载自定义的http模块，必须使用不同的标识符或采用路径方式指定。

• 路径形式的文件模块

以.、..和/开头的标识符均被视为文件模块。在分析路径模块时，require()方法会将路径转换为真实路径，并以该真实路径为索引，将编译执行后的结果存入缓存，从而加速二次加载。由于文件模块明确了具体文件位置，查找过程节省了大量时间，其加载速度慢于核心模块。

• 自定义模块

自定义模块指非核心模块且非路径形式的标识符。它可能是一个文件或包的形式。这类模块的查找过程最为耗时，也是所有加载方式中最慢的一种。

2）. 文件定位

缓存加载策略使得二次引入时无需进行路径分析、文件定位和编译执行，大幅提升了再次加载模块的效率。但在文件定位过程中，仍需注意以下细节，包括文件扩展名分析、目录及包的处理。

• 文件扩展名分析

CommonJS模块规范允许标识符中不包含文件扩展名。此时，Node.js会按.js、.json、.node的顺序补足扩展名并依次尝试。尝试过程中需调用fs模块同步阻塞式地判断文件是否存在。由于Node.js是单线程模型，这可能导致性能问题。优化技巧是：对于.node和.json文件，在传递给require()的标识符中显式带上扩展名，可略微提升速度。

• 目录分析和包

在分析标识符时，若require()未找到对应文件但发现目录，Node.js会将该目录视为包进行处理。

在此过程中，Node.js对CommonJS包规范提供了一定支持。首先，Node.js在当前目录下查找package.json（CommonJS包规范定义的包描述文件），通过JSON.parse()解析出包描述对象，并从中提取main属性指定的文件名进行定位。若文件名缺少扩展名，将进入扩展名分析步骤。若main属性指定的文件名错误或不存在package.json文件，Node.js会将index作为默认文件名，依次查找index.js、index.node、index.json。

若在目录分析中未能定位到任何文件，自定义模块将进入下一个模块路径进行查找。若遍历完所有模块路径仍未找到目标文件，则抛出查找失败的异常。

3）. 模块编译 在Node.js中，每个文件模块都是一个对象，其定义如下：

function Module(id, parent) {  
  this.id = id;  
  this.exports = {};  
  this.parent = parent;  
   if (parent && parent.children) {   
   parent.children.push(this);  
  }  
  this.filename = null;  
   this.loaded = false;  
  this.children = []; 
}  

编译和执行是引入文件模块的最后阶段。定位到具体文件后，Node.js会新建一个模块对象，并根据路径载入并编译。针对不同文件扩展名，载入方法有所不同，具体如下：

• .js文件。

通过fs模块同步读取文件后编译执行。

• .node文件。

这是用C/C++编写的扩展文件，通过dlopen()方法加载最后编译生成的文件。

• .json文件。

通过fs模块同步读取文件后，使用JSON.parse()解析返回结果。

• 其余扩展名文件。

它们均被视为.js文件进行载入。

每个编译成功的模块，其文件路径将作为索引缓存在Module._cache对象上，以提高二次引入的性能。

JavaScript模块的编译

回顾CommonJS模块规范，每个模块文件中存在require、exports、module这3个变量，但它们在模块文件中并未显式定义，那么它们从何而来？此外，Node.js API文档中提到的__filename和__dirname变量又是如何产生的？若将模块直接定义在浏览器端，可能会污染全局变量。

事实上，在编译过程中，Node.js对获取的JavaScript文件内容进行了头尾包装。在头部添加了(function (exports, require, module, __filename, __dirname) {\n，在尾部添加了\n});。一个正常的JavaScript文件会被包装成如下形式：

(function (exports, require, module, __filename, __dirname) {
 var math = require('math');
 exports.area = function (radius) {
  return Math.PI * radius * radius;
 };
});

这样，每个模块文件之间实现了作用域隔离。包装后的代码通过vm原生模块的runInThisContext()方法执行（类似于eval，但具有明确上下文，不污染全局），返回一个具体的function对象。最后，将当前模块对象的exports属性、require()方法、module（模块对象自身），以及在文件定位中得到的完整文件路径和文件目录作为参数传递给该function()执行。

包结构与NPM

3. 包和NPM

在模块之外，包和NPM是将模块联系起来的重要机制。

CommonJS的包规范定义相对简单，由包结构和包描述文件两部分组成。前者用于组织包中的各种文件，后者用于描述包的相关信息，供外部读取和分析。

1. 包结构

包本质上是一个存档文件，即一个目录直接打包为.zip或tar.gz格式，安装后解压还原为目录。完全符合CommonJS规范的包目录应包含以下文件：

package.json：包描述文件。 bin：用于存放可执行二进制文件的目录。 lib：用于存放JavaScript代码的目录。 doc：用于存放文档的目录。 test：用于存放单元测试用例的代码。

2. 包描述文件

包描述文件用于表达非代码相关的信息，它是一个JSON格式的文件——package.json，位于包的根目录下，是包的重要组成部分。NPM的所有行为均与包描述文件的字段密切相关。

具体细节可参考NPM官网对package.json的定义规范。

用户可以通过npm adduser和npm publish命令将自己的package上传至npm仓库。

AMD、CMD与多环境兼容

三、题外话： AMD、CMD、兼容多种模块规范的类库

1. AMD

AMD是CommonJS模块规范的一个延伸，其模块定义如下： define(id?, dependencies?, factory);

2. CMD

3. 兼容

为了使同一模块能在前后端运行，编写代码时需考虑兼容前端已实现模块规范的环境。为保持前后端一致性，类库开发者需将类库代码包装在一个闭包内。以下代码演示如何将hello()方法定义到不同的运行环境中，它能够兼容Node.js、AMD、CMD以及常见的浏览器环境：

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持本站。