React / 系统课时

模拟请求与异步状态

模拟请求与异步状态

本课用一个用户列表组件覆盖完整异步链路:请求发出时显示加载状态,成功后展示数据,失败时显示错误提示,点击重试后重新请求。通过 MSW 在网络边界拦截请求,可以不修改组件代码就稳定复现不同响应。

学习目标

  • 使用 MSW 为 Vitest 测试提供可控的 HTTP 响应
  • 使用异步查询验证加载、成功和错误状态
  • 在单个测试中覆盖失败后重试成功的状态迁移

建立异步测试环境

在 React 18 与 Vite 项目中安装测试依赖和 MSW:

bash
npm install --save-dev vitest jsdom @testing-library/react @testing-library/jest-dom @testing-library/user-event msw

预期输出如下,<N> 为动态包数量:

text
added <N> packages

创建 vitest.config.ts:

ts
import react from '@vitejs/plugin-react'
import { defineConfig } from 'vitest/config'

export default defineConfig({
  plugins: [react()],
  test: {
    environment: 'jsdom',
    setupFiles: './src/test/setup.ts',
  },
})

配置的生效行为是:测试文件获得浏览器式 DOM,并在每个测试套件加载前执行统一 setup。最终可通过本课末尾的测试命令验证。

实现加载、成功与失败状态

创建 src/UserPanel.tsx。组件把请求过程收敛为 loading、success 和 error 三种状态,重试按钮复用同一个加载函数:

tsx
import { useCallback, useEffect, useState } from 'react'

type User = {
  id: number
  name: string
}

const API_URL = 'https://example.test/api/users'

export function UserPanel() {
  const [status, setStatus] = useState<'loading' | 'success' | 'error'>(
    'loading',
  )
  const [users, setUsers] = useState<User[]>([])

  const loadUsers = useCallback(async () => {
    setStatus('loading')

    try {
      const response = await fetch(API_URL)

      if (!response.ok) {
        throw new Error(`HTTP ${response.status}`)
      }

      const data = (await response.json()) as User[]
      setUsers(data)
      setStatus('success')
    } catch {
      // 页面只暴露可执行的错误反馈,不泄漏底层异常细节。
      setStatus('error')
    }
  }, [])

  useEffect(() => {
    void loadUsers()
  }, [loadUsers])

  if (status === 'loading') {
    return <p role="status">正在加载用户...</p>
  }

  if (status === 'error') {
    return (
      <div role="alert">
        加载失败
        <button type="button" onClick={() => void loadUsers()}>
          重试
        </button>
      </div>
    )
  }

  return (
    <section>
      <h2>用户列表</h2>
      <ul aria-label="用户列表">
        {users.map((user) => (
          <li key={user.id}>{user.name}</li>
        ))}
      </ul>
    </section>
  )
}

异步组件的关键不是某次 fetch 调用本身,而是请求结果如何驱动页面状态迁移。测试需要分别停留在各状态并观察对应界面。

异步组件状态与测试覆盖关系

使用 MSW 拦截真实请求边界

创建 src/test/server.ts。默认处理器延迟返回成功数据,使测试能够先观察加载状态:

ts
import { delay, http, HttpResponse } from 'msw'
import { setupServer } from 'msw/node'

export const API_URL = 'https://example.test/api/users'

const successHandler = http.get(API_URL, async () => {
  // 显式延迟让 loading 状态在 Node 测试中可稳定观察。
  await delay(80)

  return HttpResponse.json([{ id: 1, name: 'Ada' }])
})

export const server = setupServer(successHandler)

创建 src/test/setup.ts,统一管理拦截器生命周期:

ts
import '@testing-library/jest-dom/vitest'
import { afterAll, afterEach, beforeAll } from 'vitest'
import { server } from './server'

beforeAll(() => server.listen({ onUnhandledRequest: 'error' }))
afterEach(() => server.resetHandlers())
afterAll(() => server.close())

onUnhandledRequest: 'error' 能让遗漏的接口模拟立即失败;resetHandlers 会在每个用例后移除运行时覆盖,避免一个错误响应污染其他测试。

验证成功、错误与重试

创建 src/UserPanel.test.tsx。第一个用例验证加载到成功,第二个用例先覆盖为 500 响应,再在点击重试前覆盖为成功响应:

tsx
import { render, screen } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { http, HttpResponse } from 'msw'
import { describe, expect, it } from 'vitest'
import { UserPanel } from './UserPanel'
import { API_URL, server } from './test/server'

describe('UserPanel', () => {
  it('先显示加载状态,再展示接口数据', async () => {
    render(<UserPanel />)

    expect(screen.getByRole('status')).toHaveTextContent('正在加载用户')
    expect(await screen.findByText('Ada')).toBeInTheDocument()
    expect(screen.queryByRole('status')).not.toBeInTheDocument()
  })

  it('请求失败后显示错误,并可重试成功', async () => {
    const user = userEvent.setup()

    // 运行时处理器优先于默认成功处理器,仅影响当前测试。
    server.use(
      http.get(API_URL, () =>
        HttpResponse.json({ message: '服务异常' }, { status: 500 }),
      ),
    )

    render(<UserPanel />)

    expect(await screen.findByRole('alert')).toHaveTextContent('加载失败')

    // 重试前切换为成功响应,模拟服务恢复。
    server.use(
      http.get(API_URL, () =>
        HttpResponse.json([{ id: 2, name: 'Lin' }]),
      ),
    )

    await user.click(screen.getByRole('button', { name: '重试' }))

    expect(screen.getByRole('status')).toBeInTheDocument()
    expect(await screen.findByText('Lin')).toBeInTheDocument()
    expect(screen.queryByRole('alert')).not.toBeInTheDocument()
  })
})

运行测试:

bash
npx vitest run src/UserPanel.test.tsx

预期输出:

text
✓ src/UserPanel.test.tsx (2 tests)
Test Files  1 passed (1)
Tests       2 passed (2)

异步断言的关键边界

同步出现的加载提示使用 getByRole,因为它应在首次渲染后立即存在。接口响应后的数据或错误提示使用 findBy...,它会等待元素出现;验证旧状态已经消失时使用 queryBy...,避免 getBy... 因找不到元素而直接抛错。

不要用固定 setTimeout 等待请求,也不要直接模拟组件内部的 loadUsers。MSW 保留了 fetch、状态更新和渲染这一整条真实执行路径,只替换不可控的网络响应,因此更适合验证异步组件行为。

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

目录与阅读设置

阅读设置

17

记录一个想法

模拟请求与异步状态

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

登录哪都通