0

0

Vitest 中 spyOn 必须在测试作用域内声明:原因与配置冲突解析

霞舞

霞舞

发布时间:2026-01-24 15:23:00

|

282人浏览过

|

来源于php中文网

原创

Vitest 中 spyOn 必须在测试作用域内声明:原因与配置冲突解析

vitest 的 `vi.spyon()` 无法在 `describe` 外部全局声明,因其依赖于 vitest 的自动 mock 重置机制;当启用 `mockreset`、`restoremocks` 或 `clearmocks` 等配置时,全局 spy 会在每个测试前被清除,导致断言失败。

在从 Jest 迁移至 Vitest 的过程中,开发者常会沿用 Jest 的“外部声明 spy”习惯(如在 describe 顶层定义 const spy = vi.spyOn(...)),但该模式在 Vitest 中默认不兼容——根本原因在于 Vitest 的 mock 生命周期管理策略与 Jest 存在关键差异。

Vitest 默认启用严格的 mock 隔离机制。当你在 vitest.config.ts 中配置了以下任一选项:

test: {
  mockReset: true,     // 每个测试前调用 mock.reset()
  restoreMocks: true,  // 每个测试后还原所有 mock(含 spyOn)
  clearMocks: true,    // 每个测试前清空 mock 调用记录和返回值
  threads: false,      // 单线程模式下 mock 状态更易受干扰(虽非主因,但加剧问题)
}

Vitest 就会在 每个 it() 执行前后主动干预 mock 状态

  • restoreMocks: true 会将 vi.spyOn() 创建的 spy 还原为原始方法(即取消监听);
  • clearMocks: true 会清空 .mock.calls、.mock.results 等内部状态;
  • 若 spy 在 describe 外声明,则其引用指向的已是被还原/清空后的“空壳”,后续 expect(spy).toHaveBeenCalledOnce() 必然失败。

✅ 正确实践:始终在 it() 或 beforeEach() 内创建 spy
这是最符合 Vitest 设计哲学的方式,确保每个测试拥有独立、干净的 spy 实例:

describe('PostboxList', () => {
  it('shows notification when fetching status is HasError', async () => {
    // ✅ 正确:spy 属于当前测试生命周期
    const notificationSpy = vi.spyOn(NotificationActions, 'addNotification');

    const store = mockStore({
      postbox: {
        documents: { data: [], fetchingStatus: DataFetchingStatus.HasError },
        messages: { data: [], fetchingStatus: DataFetchingStatus.HasError },
      },
    });

    render(, { store });

    expect(notificationSpy).toHaveBeenCalledOnce({
      title: 'POSTBOX.ERROR.TITLE',
      text: 'POSTBOX.ERROR.TEXT',
    });
  });
});

⚠️ 注意事项:

SpeechEasy
SpeechEasy

SpeechEasy是一种合成语音解决方案,可以让用户从文本生成高质量、易于理解的音频。

下载
  • 不要依赖 beforeAll() 声明 spy —— 它仍会受 restoreMocks/clearMocks 影响;
  • 如需复用 spy 创建逻辑,可封装为工厂函数,而非提前实例化:
    const createNotificationSpy = () => vi.spyOn(NotificationActions, 'addNotification');
    // 然后在 each it() 中调用:const spy = createNotificationSpy();
  • 若必须保留全局 spy(极少数场景),请显式禁用相关配置
    test: {
      mockReset: false,
      restoreMocks: false,
      clearMocks: false,
      // threads: false 可保留(单测调试友好),但需自行管理 mock 状态
    }

    ⚠️ 此方式牺牲测试隔离性,易引发跨测试污染,强烈不推荐用于 CI 或大型测试套件

总结:Vitest 的 spyOn 是“测试作用域绑定”的轻量级监控工具,其行为由框架的 mock 生命周期严格管控。迁移时应主动拥抱这一设计——将 spy 创建移入测试内部,既是解决报错的直接方案,更是保障测试健壮性与可维护性的最佳实践。

相关专题

更多
c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

527

2023.09.20

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

17

2026.01.23

c++空格相关教程合集
c++空格相关教程合集

本专题整合了c++空格相关教程,阅读专题下面的文章了解更多详细内容。

22

2026.01.23

yy漫画官方登录入口地址合集
yy漫画官方登录入口地址合集

本专题整合了yy漫画入口相关合集,阅读专题下面的文章了解更多详细内容。

91

2026.01.23

漫蛙最新入口地址汇总2026
漫蛙最新入口地址汇总2026

本专题整合了漫蛙最新入口地址大全,阅读专题下面的文章了解更多详细内容。

124

2026.01.23

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

14

2026.01.23

php远程文件教程合集
php远程文件教程合集

本专题整合了php远程文件相关教程,阅读专题下面的文章了解更多详细内容。

65

2026.01.22

PHP后端开发相关内容汇总
PHP后端开发相关内容汇总

本专题整合了PHP后端开发相关内容,阅读专题下面的文章了解更多详细内容。

59

2026.01.22

php会话教程合集
php会话教程合集

本专题整合了php会话教程相关合集,阅读专题下面的文章了解更多详细内容。

61

2026.01.22

热门下载

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

精品课程

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

共345课时 | 45.5万人学习

React 教程
React 教程

共58课时 | 4万人学习

Pandas 教程
Pandas 教程

共15课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号