require() 函数工作原理和常见坑点剖析

2023-09-15 12:16:00

在日常的前端/Node开发中，require是最常使用的api之一，了解其背后的逻辑有助于我们日常的开发以及排坑。但在阅读源码的时候，我们往往会觉得枯燥无味，看完了，看起来好像也知道了代码是怎么执行的，但又不完全清楚，为什么是这么做呢？这一节我们就来简单聊一下 require 的实现原理以及常见的坑点。

require 的工作原理

require 的本质是通过 CommonJS 规范实现的，我们可以直接用一个简单的栗子来了解一下 require 的具体工作原理。

比如我们有一个入口文件 index.js：

console.log('index.js');
require('./foo.js');

foo.js 作为模块文件，它的内容如下：

console.log('foo.js');
exports.foo = function () {
  console.log('foo');
};

现在，我们可以通过 node index.js 来运行这个程序。

解析模块路径

首先，Node.js 会解析模块的路径。在上面的例子中，模块路径是 ./foo.js。Node.js 会将这个路径解析成一个绝对路径，即 C:\Users\username\path\to\foo.js。
检查缓存

在解析完模块路径后，Node.js 会检查缓存中是否存在这个模块。如果存在，则直接从缓存中加载模块。如果不存在，则继续下一步。
加载模块

如果模块不在缓存中，则 Node.js 会加载模块。加载模块的过程包括以下几个步骤：
- 读取模块文件的内容。
- 将模块文件的内容解析成 JavaScript 代码。
- 执行 JavaScript 代码。
缓存模块

在加载完模块后，Node.js 会将模块缓存起来。这样，当下次需要加载这个模块时，就可以直接从缓存中加载，而不需要重新加载。
返回模块

最后，Node.js 会返回模块。在上面的例子中，模块是 foo.js，它是一个对象，包含了一个 foo 函数。

require 的常见坑点

在使用 require 的时候，我们可能会遇到一些常见的坑点。这些坑点包括：

循环引用

循环引用是指两个模块相互引用。当出现循环引用时，Node.js 会抛出 RangeError: Maximum call stack size exceeded 错误。为了避免循环引用，我们可以使用 require.cache 来控制模块的加载顺序。
模块缓存

模块缓存是一个非常有用的功能，但它也可能会导致一些问题。比如，当我们修改了一个模块的文件后，如果模块已经缓存，那么修改后的文件将不会被加载。为了避免这个问题，我们可以使用 require.resolve() 来强制加载模块的最新版本。
模块路径

模块路径是 require 的一个重要参数。如果模块路径不正确，则 Node.js 会抛出 Error: Cannot find module 'xxx' 错误。为了避免这个问题，我们可以使用 path.resolve() 来解析模块路径。