高级 Mock 技术
中等 约 45 分钟
你将构建什么
一个用户服务的测试套件,mock 数据库客户端和邮件发送器,演示部分 mock、spy 方法和模块级 mock。
学习目标
- 用 jest.fn 创建部分 mock
- 在不替换的情况下 spy 现有方法
- 用 jest.mock 模拟整个模块
- 验证 mock 调用和交互
前置要求
- 用 jest.fn 基本 mock
- ES 模块导入
- 测试中的 async/await
步骤
- 1
创建待测试服务
创建一个依赖数据库客户端和邮件发送器的 UserService。这些依赖将在测试中被 mock。
代码// src/services/UserService.ts import { dbClient } from '../db/client'; import { emailSender } from '../email/sender'; export class UserService { async createUser(email: string, name: string) { const user = await dbClient.insert('users', { email, name }); await emailSender.sendWelcome(email, name); return user; } async getUser(id: number) { return dbClient.findById('users', id); } async deleteUser(id: number) { const user = await this.getUser(id); if (!user) throw new Error('User not found'); await dbClient.delete('users', id); await emailSender.sendGoodbye(user.email, user.name); } }预期结果
UserService 有三个方法,依赖 dbClient 和 emailSender。
- 2
用 jest.mock 模拟模块
使用 jest.mock 替换整个模块。这是 Jest/Vitest 中 mock 依赖最常见的方式。
代码import { UserService } from '../services/UserService'; import { dbClient } from '../db/client'; import { emailSender } from '../email/sender'; jest.mock('../db/client'); jest.mock('../email/sender'); const service = new UserService(); describe('UserService.createUser', () => { beforeEach(() => jest.clearAllMocks()); it('inserts user and sends welcome email', async () => { (dbClient.insert as jest.Mock).mockResolvedValue({ id: 1, email: '[email protected]', name: 'A' }); const user = await service.createUser('[email protected]', 'A'); expect(user).toEqual({ id: 1, email: '[email protected]', name: 'A' }); expect(dbClient.insert).toHaveBeenCalledWith('users', { email: '[email protected]', name: 'A' }); expect(emailSender.sendWelcome).toHaveBeenCalledWith('[email protected]', 'A'); }); });预期结果
测试通过 —— dbClient 和 emailSender 被 mock,其调用被验证。
- 3
spy 方法
使用 jest.spyOn 观察方法调用而不替换其实现。spy 适用于在保持真实行为的同时验证交互。
代码describe('UserService.getUser', () => { it('delegates to dbClient.findById', async () => { const spy = jest.spyOn(dbClient, 'findById').mockResolvedValue({ id: 1, name: 'A' }); const user = await service.getUser(1); expect(user).toEqual({ id: 1, name: 'A' }); expect(spy).toHaveBeenCalledWith('users', 1); spy.mockRestore(); }); });预期结果
spy 验证 findById 以正确参数被调用。
- 4
用 mock rejection 测试错误处理
使用 mockRejectedValue 模拟依赖失败,验证服务正确处理错误。
代码describe('UserService.deleteUser error handling', () => { beforeEach(() => jest.clearAllMocks()); it('throws when user not found', async () => { jest.spyOn(dbClient, 'findById').mockResolvedValue(null); await expect(service.deleteUser(999)).rejects.toThrow('User not found'); expect(dbClient.delete).not.toHaveBeenCalled(); }); it('sends goodbye email on successful delete', async () => { jest.spyOn(dbClient, 'findById').mockResolvedValue({ id: 1, email: '[email protected]', name: 'A' }); (dbClient.delete as jest.Mock).mockResolvedValue(undefined); await service.deleteUser(1); expect(emailSender.sendGoodbye).toHaveBeenCalledWith('[email protected]', 'A'); }); });预期结果
错误和成功路径都被测试 —— 服务正确处理缺失用户并发送邮件。
- 5
创建 mock 工厂
使用 jest.mock 配合工厂函数完全控制 mock 实现。这在模块有复杂导出时很有用。
代码jest.mock('../db/client', () => ({ dbClient: { insert: jest.fn(), findById: jest.fn(), delete: jest.fn(), update: jest.fn(), }, })); // Now you can configure each method independently beforeEach(() => { (dbClient.insert as jest.Mock).mockImplementation((table, data) => Promise.resolve({ id: Math.random(), ...data }) ); });预期结果
工厂提供完全控制 —— 每个方法都是带自定义行为的新 mock。
自己动手试试
起始代码
import { UserService } from '../services/UserService';
jest.mock('../db/client');
jest.mock('../email/sender');
// TODO: write tests
解决方案代码
jest.mock('../db/client', () => ({
dbClient: { insert: jest.fn(), findById: jest.fn(), delete: jest.fn() },
}));你学到了什么
你掌握了高级 mock —— 模块 mock、spy、mock 工厂和 rejection 测试。这些让你将任何代码与依赖隔离并测试所有交互路径。
相关资源
相关课程
- Mocking
替换依赖。
查阅不认识的术语
新手友好的术语表用大白话解释编程术语——变量、函数、DOM、Promise 等等。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。