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 状态

人民网AIGC-X
人民网AIGC-X

国内科研机构联合推出的AI生成内容检测工具

下载
  • 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(<PostboxList />, { store });

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

⚠️ 注意事项:

  • 不要依赖 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 创建移入测试内部,既是解决报错的直接方案,更是保障测试健壮性与可维护性的最佳实践。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

562

2023.09.20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

38

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

83

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

97

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

223

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

458

2026.03.04

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

169

2026.03.04

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

246

2026.03.03

热门下载

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

精品课程

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

共345课时 | 55.3万人学习

React 教程
React 教程

共58课时 | 6万人学习

Pandas 教程
Pandas 教程

共15课时 | 1.2万人学习

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

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