Node.js 中 cjs 模块的奥秘：深入源代码探索

2023-12-01 22:33:59

前言

相信大家都知道如何在 Node.js 中加载一个模块：

const module = require('module-name');

没错，require 就是加载 cjs 模块的 API。作为 Node.js 中模块化开发的基石，cjs 模块系统有着悠久の歴史和广泛的应用。本文将带你深入 Node.js 源代码，探索 cjs 模块系统的奥秘。我们将从 require API 入手，深入剖析其工作原理，了解如何加载和执行 cjs 模块。通过这种方式，你将对 Node.js 的模块系统有更深入的理解，并能更好地编写和调试你的代码。

探索 `require` API

require API 是加载 cjs 模块的入口。它接收一个参数，即要加载的模块名称。这个模块名称可以是：

内置模块：由 Node.js 自带的模块，如 fs、path 等。
第三方模块：由 npm 等包管理器安装的模块。
相对路径模块：相对于当前模块所在目录的模块。

require API 的工作原理如下：

解析模块名称： require API 会根据模块名称的类型解析出模块的绝对路径。
检查模块缓存： 它会检查模块是否已加载，如果已加载，则直接返回缓存的模块。
加载模块： 如果模块未加载，则会根据模块路径加载模块文件。
执行模块： 加载完成后，require API 会执行模块文件，并将模块的导出对象返回。

通过这种机制，require API 可以高效地加载和执行 cjs 模块，为我们的开发提供了便利。

cjs 模块加载过程

让我们深入剖析 cjs 模块的加载过程：

模块文件查找： require API 根据模块名称解析出模块的绝对路径。对于内置模块，路径为 Node.js 内置的模块目录；对于第三方模块，路径为 npm 安装的目录；对于相对路径模块，路径为相对于当前模块所在目录的路径。
模块文件读取： 找到模块文件后，require API 会读取文件内容。
模块包装： 读取文件内容后，require API 会将文件内容包裹一层函数，称为模块包装器（module wrapper）。这个包装器负责执行模块代码并导出模块接口。
模块执行： 模块包装器被执行，模块代码被求值。在求值过程中，模块可以访问其自己的局部作用域和 Node.js 的内置对象。
模块导出： 模块执行完成后，模块包装器会导出模块的接口。导出方式可以是显式导出（通过 module.exports）或隐式导出（通过赋值给 exports）。
模块缓存： 执行完成后，模块及其导出对象会缓存起来，以备下次加载时使用。

通过这个过程，cjs 模块被加载并执行，为我们的代码复用和组织提供了基础。

cjs 模块的执行机制

cjs 模块的执行机制基于模块包装器。模块包装器是一个包裹模块代码的函数，它负责执行模块代码并导出模块接口。

模块包装器的执行过程如下：

函数调用： require API 调用模块包装器，传入模块的导出对象和一个 require 函数。
模块代码执行： 模块包装器内部执行模块代码。在执行过程中，模块代码可以访问自己的局部作用域和 Node.js 的内置对象。
模块导出： 模块执行完成后，模块包装器会导出模块的接口。导出方式可以是显式导出（通过 module.exports）或隐式导出（通过赋值给 exports）。
返回值： 模块包装器执行完成后，会返回模块的导出对象。

通过这种机制，cjs 模块的代码被执行，其接口被导出，为我们提供了模块化开发的手段。