JS 中怎么在 Vitest 中使用 vi.mock 和 vi.spyOn 进行高效模拟

梦涛小哥_7656

梦涛小哥_7656

2026-10-23

283人浏览

原创

vitest 中 vi.mock 用于模块级依赖替换,vi.spyon 用于运行时函数行为劫持;前者需顶层声明、仅对 es 模块生效,后者须作用于可访问对象属性并注意清理。

js 中怎么在 vitest 中使用 vi.mock 和 vi.spyon 进行高效模拟

在 Vitest 中高效模拟,关键不是“用哪个 API”,而是“在什么场景下用对的工具”。vi.mock 和 vi.spyOn 解决的是两类不同层级的问题:一个是模块级依赖替换,一个是运行时函数行为劫持。用错地方,测试就容易失效或难以维护。

vi.mock:用于替换整个模块的导入行为

当你需要让某个被测模块(比如 parent.ts)在加载时,把它的 import { child } from './child' 自动指向你定义的假实现,就必须用 vi.mock()。它在模块解析阶段介入,确保所有 import 都命中 mock 版本。

  • 必须写在文件顶层,且在目标模块 import 之后、测试之前(推荐紧接 imports 下方)
  • 只对 ES 模块(import/export)生效;若项目混用 require,vi.mock 会静默失效
  • 工厂函数返回的对象,会完全覆盖原模块导出 —— 不用再手动 mockReturnValue,直接返回值或 mock 函数都行
  • 适合模拟 API 调用、工具库、副作用函数等外部依赖

示例:

  // api.ts
  export async function fetchUser(id) {
    const res = await fetch(`/users/${id}`);
    return res.json();
  }

  // api.test.ts
  import { fetchUser } from './api';
  vi.mock('./api', async (importActual) => {
    const actual = await importActual();
    return {
      ...actual,
      fetchUser: vi.fn().mockResolvedValue({ id: 1, name: 'Alice' }),
    };
  });

  it('returns mocked user', async () => {
    expect(await fetchUser(1)).toEqual({ id: 1, name: 'Alice' });
    expect(fetchUser).toBeCalledTimes(1);
  });

vi.spyOn:用于观测或临时修改已有对象上的方法

vi.spyOn 不是“模拟模块”,而是“监听一个已存在引用的方法”。它适合验证某函数是否被调用、传了什么参数、调用了几次,或者临时改掉某个对象身上的方法(比如全局 console、第三方实例方法)。

chartjs-reporter
chartjs-reporter

此技能用于在用户需要将结构化数据(查询结果、CSV 摘要、JSON 记录或 Python 字典/列表)转换为独立的 HTML 页面时使用。

下载
  • 作用对象必须是可访问的变量/属性,例如 console.log、Math.random、instance.method
  • 对模块内部直调(如 parent() 内部直接调 child())无效 —— 因为那不是通过对象属性访问的
  • 记得用 .mockRestore() 清理,否则可能污染其他测试
  • 常用于打桩全局副作用、校验日志、拦截类方法调用

示例:

  it('logs warning when input is empty', () => {
    const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
    
    validateInput('');
    
    expect(warnSpy).toBeCalledWith('Input cannot be empty');
    warnSpy.mockRestore();
  });

别踩坑:常见误用与修复方式

很多失败不是 API 不好用,而是没理解 ESM 的静态绑定本质。

  • 想 mock 同一文件里的函数?不行 —— ESM 不允许重绑定本地变量。解法:把该函数拆到独立模块,再用 vi.mock 替换
  • vi.mock 写在 describe 或 it 里?不生效 —— 它必须在模块加载前注册,只能放在顶层
  • 测试中用了 require 导入?vi.mock 失效 —— 统一改为 import,这是现代 Vitest 测试的前提
  • mock 了但函数还是执行了?检查是否真的 import 了那个模块 —— 有些逻辑可能是动态 require 或 eval,这些无法被 vi.mock 拦截

组合使用更强大

真实场景往往需要两者配合。比如测试一个组件方法,既要 spy 它调用的内部状态更新函数,又要 mock 它依赖的 API 模块:

  • 用 vi.mock 替换 API 模块,控制返回数据
  • 用 vi.spyOn 监听组件实例方法或全局副作用,验证触发时机和参数
  • 测试结束后统一调用 vi.clearAllMocks() 快速重置所有 mock 状态

相关专题

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

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

2023.06.20

5126

5

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

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

2023.07.04

1249

3

js四舍五入
js四舍五入

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

2023.07.04

5044

6

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

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

2023.09.01

980

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1916

5

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

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

2023.09.04

3605

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4693

6

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

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

2023.09.20

3080

5

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

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

2023.09.20

988

7

热门下载

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

精品课程

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

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12.3万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习