如何在 Vitest 的 __mocks__ 中安全复用真实模块并仅局部打桩

陌芳大大_1238

陌芳大大_1238

2026-11-14

986人浏览

原创

如何在 Vitest 的 __mocks__ 中安全复用真实模块并仅局部打桩

Vitest 中无法直接在 __mocks__/ 文件内调用 vi.importActual(),但可通过在 __mocks__ 里嵌套 vi.mock() 并传入 importOriginal 回调,实现“自动导入真实模块 + 覆盖指定导出”的优雅打桩模式。

vitest 中无法直接在 `__mocks__/` 文件内调用 `vi.importactual()`,但可通过在 `__mocks__` 里嵌套 `vi.mock()` 并传入 `importoriginal` 回调,实现“自动导入真实模块 + 覆盖指定导出”的优雅打桩模式。

在大型 Vitest 项目中,频繁重复编写类似以下代码会显著降低可维护性:

vi.mock('react-router-dom', async () => {
  const actual = await vi.importActual('react-router-dom')
  return { ...actual, useNavigate: vi.fn() }
})

虽然你已将逻辑抽离至 __mocks__/react-router-dom.ts,但该文件默认是静态导出,不支持动态加载原始模块——这是 Vitest 当前的设计限制(GitHub #5482 明确标记为待支持特性)。

✅ 正确解法:在 __mocks__/ 中使用 vi.mock() 配合 importOriginal 回调

创建 __mocks__/react-router-dom.ts(注意:必须为 .ts 或 .js,且需确保类型兼容):

// __mocks__/react-router-dom.ts
import { vi } from 'vitest'

// 注意:此处 vi.mock 是在 mock 文件内调用,Vitest 会识别为“自动 mock 注册”
vi.mock('react-router-dom', async (importOriginal) => {
  const actual = await importOriginal()
  return {
    ...actual,
    useNavigate: vi.fn(),
    // ✅ 可按需覆盖任意导出,其余全部透传
    // useParams: vi.fn().mockReturnValue({ id: '123' }),
  }
})

⚠️ 关键前提:在测试入口或 test-setup.ts 中显式启用该 mock

Vite 6.4.5
Vite 6.4.5

Vite 6.4.5 历史版本 npm 官方下载,适合旧项目依赖固定、前端开发和生产环境构建。

下载
// test-setup.ts
import { vi } from 'vitest'

// 必须调用,否则 __mocks__/react-router-dom.ts 不会被激活
vi.mock('react-router-dom')

或在具体测试文件顶部声明:

// example.test.ts
import { vi } from 'vitest'

vi.mock('react-router-dom') // 启用 __mocks__/ 版本

describe('MyComponent', () => {
  it('triggers navigation on submit', () => {
    render(<mycomponent></mycomponent>)
    fireEvent.click(screen.getByText('Submit'))
    expect(useNavigate()).toHaveBeenCalled() // ✅ 使用的是 mock 实现
  })
})

? 原理说明:

  • vi.mock('react-router-dom') 在测试环境启动时触发 Vitest 的 mock 解析机制;
  • Vitest 检测到 __mocks__/react-router-dom.ts 存在,并执行其中的 vi.mock(...) 调用;
  • importOriginal() 回调等效于 vi.importActual(),但仅在此上下文中可用,确保原始模块被正确加载;
  • 所有未覆盖的导出(如 Link, Outlet, useParams 等)均来自真实 react-router-dom,行为完全一致。

? 最佳实践建议:

  • 将 vi.mock('xxx') 统一放在 test-setup.ts 中,避免每个测试文件重复声明;
  • 若需差异化 mock(如不同测试需不同 useNavigate 行为),可在测试内 再次调用 vi.mock() 覆盖(Vitest 支持 mock 重定义);
  • 为避免类型丢失,在 __mocks__/react-router-dom.ts 顶部添加类型断言或 declare module(见下方示例):
// __mocks__/react-router-dom.ts
import type * as Router from 'react-router-dom'
import { vi } from 'vitest'

vi.mock('react-router-dom', async (importOriginal) => {
  const actual = await importOriginal() as typeof Router
  return {
    ...actual,
    useNavigate: vi.fn(),
  }
})

此方案已在 Vitest v1.3+ 稳定运行,是当前最简洁、可复用、语义清晰的局部打桩模式。未来若 Vitest 原生支持 importActual in __mocks__,迁移成本极低——只需替换 importOriginal() 调用即可。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vite

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.06.20

5886

5

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

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

2023.07.04

1409

3

js四舍五入
js四舍五入

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

2023.07.04

5804

6

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

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

2023.09.01

1060

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

2036

5

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

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

2023.09.04

4005

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

5313

6

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

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

2023.09.20

3480

5

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

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

2023.09.20

1128

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二期_大前端线上班
第二期_大前端线上班

共345课时 | 82.6万人学习