Vue / 系统课时

接口与模块 Mock

接口与模块 Mock

单元测试真正要验证的是当前模块的行为,而不是顺带验证网络、系统时钟、浏览器实现或第三方 SDK。本节用 Vitest 把这些外部依赖替换为可控 Mock,让测试结果稳定、失败原因集中,并保留对调用参数和异常分支的验证能力。

学习目标

  • 使用 Vitest 隔离网络请求、时间和浏览器 API。
  • 用 vi.mock 替换第三方模块,并验证调用参数。
  • 区分“替换依赖”和“验证实现细节”,避免过度 Mock。

先确定需要隔离的边界

适合 Mock 的对象有一个共同点:它们不属于当前测试单元,而且结果可能受外部环境影响。典型对象包括 HTTP 请求、当前时间、localStorage、matchMedia、支付或埋点 SDK。测试应保留业务输入与业务输出,只替换这些边界。

假设页面逻辑会读取当前时间、查询用户接口,并在成功后调用第三方审计模块。测试目标不是验证 fetch 或审计 SDK 本身,而是确认业务函数在固定依赖下返回正确结果。

用 Vitest 统一替换外部依赖

下面是一个最小业务模块。buildUserSummary 依赖网络、时间和第三方审计模块;浏览器 API 由同一测试文件单独验证。

ts
// src/user-summary.ts
import { audit } from './vendor-audit'

export interface UserDto {
  id: number
  name: string
}

export async function buildUserSummary(userId: number): Promise<string> {
  const response = await fetch(`/api/users/${userId}`)
  if (!response.ok) {
    throw new Error('load user failed')
  }

  const user = (await response.json()) as UserDto
  const year = new Date().getUTCFullYear()
  audit('user_loaded', { userId })

  return `${year}:${user.name}`
}

第三方模块保持极薄,生产环境可以在这里接真实 SDK。

ts
// src/vendor-audit.ts
export function audit(event: string, payload: Record<string, unknown>): void {
  console.info(event, payload)
}

测试中先声明模块 Mock,再固定系统时间,并用 vi.stubGlobal 替换全局 fetch 与浏览器 API。这样每个测试都能明确控制依赖返回值。

ts
// src/user-summary.test.ts
import { afterEach, describe, expect, it, vi } from 'vitest'

vi.mock('./vendor-audit', () => ({
  audit: vi.fn(),
}))

import { audit } from './vendor-audit'
import { buildUserSummary } from './user-summary'

describe('buildUserSummary', () => {
  afterEach(() => {
    vi.useRealTimers()
    vi.unstubAllGlobals()
    vi.clearAllMocks()
  })

  it('隔离网络、时间和第三方模块', async () => {
    vi.useFakeTimers()
    vi.setSystemTime(new Date('2030-06-01T00:00:00Z'))

    const fetchMock = vi.fn().mockResolvedValue(
      new Response(JSON.stringify({ id: 7, name: 'Ada' }), {
        status: 200,
        headers: { 'Content-Type': 'application/json' },
      }),
    )
    vi.stubGlobal('fetch', fetchMock)

    await expect(buildUserSummary(7)).resolves.toBe('2030:Ada')
    expect(fetchMock).toHaveBeenCalledWith('/api/users/7')
    expect(audit).toHaveBeenCalledWith('user_loaded', { userId: 7 })
  })

  it('隔离浏览器 matchMedia', () => {
    const matchMedia = vi.fn().mockReturnValue({
      matches: true,
      media: '(prefers-color-scheme: dark)',
    })
    vi.stubGlobal('matchMedia', matchMedia)

    expect(window.matchMedia('(prefers-color-scheme: dark)').matches).toBe(true)
  })
})

运行测试:

bash
npx vitest run src/user-summary.test.ts

预期输出:

text
✓ src/user-summary.test.ts (2 tests)
Test Files  1 passed (1)
Tests       2 passed (2)

不同 Vitest 版本会附带实际耗时 <TIME> 等信息,但通过数量应与示例一致。

给失败分支单独设置返回值

网络异常不需要真的断网。只要让同一个 fetch Mock 返回失败响应,就能验证业务是否正确抛错。这里仍然测试业务契约,而不是测试浏览器的网络栈。

ts
vi.stubGlobal(
  'fetch',
  vi.fn().mockResolvedValue(new Response(null, { status: 503 })),
)

await expect(buildUserSummary(7)).rejects.toThrow('load user failed')

这是片段示例,放在前述 describe 中即可;它依赖已经导入的 vi、expect 和 buildUserSummary。预期结果是该断言通过,且不会发出真实 HTTP 请求。

避免把 Mock 变成实现耦合

Mock 应围绕模块边界,而不是围绕内部每一步。比如断言“调用了 /api/users/7”属于外部契约;断言函数内部创建了几次临时对象通常没有价值。实现一重构就大面积改测试,往往说明测试观察了过多内部细节。

每个测试结束后恢复全局替换和假时间也很重要。否则前一个用例遗留的 fetch、时钟或浏览器 API 会污染后续测试,造成只在整套测试中出现的偶发失败。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

接口与模块 Mock

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通