JavaScript 中 CommonJS 怎么在单元测试中重写 require 缓存进行模块隔离测试

落磊同学_9317

落磊同学_9317

2026-08-24

861人浏览

原创

commonjs 单元测试中 mock 失效的根源是 require.cache 缓存机制;需在 beforeeach 中先清除被测模块及依赖的缓存,再 require 以触发重新加载,配合 vi.mock 实现有效 mock。

javascript 中 commonjs 怎么在单元测试中重写 require 缓存进行模块隔离测试

在 CommonJS 环境下做单元测试时,模块缓存(require.cache)是导致 mock 失效的根源之一。因为 require 一旦加载过某个模块,后续调用会直接返回缓存中的 module.exports,不会重新执行模块代码——这使得 vi.mock 或手动替换无法影响已加载的依赖。

理解 require.cache 的作用机制

Node.js 将每个已加载的模块路径映射到一个 Module 实例,存于 require.cache 对象中。它的键是模块的绝对路径(由 require.resolve 返回),值是该模块的 module 对象,其中 exports 是对外暴露的内容。

只要缓存存在,require('./xxx') 就永远返回同一份导出对象,哪怕你改了源文件或试图重赋值 exports。

清除缓存并强制重新加载模块

要实现真正的模块隔离,必须在每次测试前清除目标模块及其所有依赖的缓存,再触发重新 require。关键步骤如下:

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载
  • 用 require.resolve('./path') 获取模块的绝对路径(避免相对路径解析歧义)
  • 从 require.cache 中删除该路径对应的条目
  • 如果该模块依赖其他被 mock 的模块(如 ../helpers/aws),也要一并清除它们的缓存
  • 在 beforeEach 或 setup 钩子中执行,确保每个测试用例都拿到“干净”的模块实例

配合 vi.mock 使用的正确顺序

Vitest 的 vi.mock 是静态分析阶段生效的,但仅对 ESM 有效;在 CommonJS 中,它无法拦截 require 调用。所以必须手动控制加载时机:

  • 先清除缓存(包括被测模块和被 mock 模块)
  • 再调用 vi.mock(虽然它本身不生效,但可保留语义一致性)
  • 最后在测试内部 require 目标模块——此时会走全新加载流程,读取 mock 后的导出

示例写法:

beforeEach(() => {<br>  const awsPath = require.resolve('../src/helpers/aws');<br>  const authPath = require.resolve('../src/client-authenticator');<br>  delete require.cache[awsPath];<br>  delete require.cache[authPath];<br>});<br><br>it('should use mocked ssmClient', () => {<br>  vi.mock('../src/helpers/aws', () => ({<br>    ssmClient: vi.fn(),<br>    getParameterCommand: vi.fn(),<br>  }));<br>  const ClientAuthenticator = require('../src/client-authenticator'); // 此时才加载<br>  expect(ClientAuthenticator.something()).toBeDefined();<br>});

避免副作用:清理间接依赖缓存

如果被测模块 A require 了 B,B 又 require 了 C,而你想 mock C,那么只清 C 的缓存还不够——B 的缓存里仍持有旧的 C 导出。稳妥做法是:

  • 递归遍历 require.cache,找出所有引用了目标模块路径的 module.parent
  • 或更简单:在测试前统一清空整个缓存(仅限单个测试文件内,不影响其他测试):
    Object.keys(require.cache).forEach(key => delete require.cache[key]);
  • 注意:不要在全局 beforeAll 清空,否则破坏测试间隔离

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4186

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1069

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4064

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

840

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1716

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3045

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

3973

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2540

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

828

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 11.9万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习