React / 系统课时

测试 Hooks 与异步逻辑

测试 Hooks 与异步逻辑

自定义 Hook 往往把状态、请求和副作用揉在一起,最容易漏测的是“加载中”和“失败”分支。本篇用 renderHook、可控的 Promise 模拟和 waitFor,把成功、失败两条异步路径都验证到,而不依赖真实网络。

学习目标

  • 使用 renderHook 直接驱动并观察自定义 Hook
  • 用 mock Promise 稳定验证 loading、success 与 error 状态
  • 正确使用 waitFor 等待异步状态收敛,避免固定延时测试

先明确异步 Hook 要验证什么

测试异步 Hook 时,不要只检查最终数据。一个完整请求通常至少经历“开始请求 → 等待 → 成功或失败”三个阶段;如果 UI 依赖这些状态,测试也应覆盖这些可观察行为。

更稳定的做法是把请求函数作为依赖传入 Hook。测试时用 vi.fn() 控制它返回成功或失败的 Promise,就能避免真实网络、随机延迟和后端数据变化影响结果。

异步 Hook 的测试状态流

用一个可运行测试覆盖成功与失败

下面的测试文件把 Hook 和测试放在同一文件中,便于独立运行。项目需已配置 Vitest、jsdom 和 @testing-library/react。

jsx
import { useEffect, useState } from 'react';
import { describe, expect, it, vi } from 'vitest';
import { renderHook, waitFor } from '@testing-library/react';

function useUser(fetchUser) {
  const [state, setState] = useState({ status: 'idle', data: null, error: null });

  useEffect(() => {
    let cancelled = false;
    // 每次请求开始都先暴露 loading,供调用方渲染加载态。
    setState({ status: 'loading', data: null, error: null });

    fetchUser().then(
      (data) => !cancelled && setState({ status: 'success', data, error: null }),
      (error) => !cancelled && setState({ status: 'error', data: null, error })
    );

    return () => {
      // 卸载后忽略迟到的 Promise,避免继续写入已失效的状态。
      cancelled = true;
    };
  }, [fetchUser]);

  return state;
}

describe('useUser', () => {
  it('handles the success branch', async () => {
    // mock Promise 让成功分支不依赖真实网络。
    const fetchUser = vi.fn().mockResolvedValue({ id: 42, name: 'Ada' });
    const { result } = renderHook(() => useUser(fetchUser));

    expect(result.current.status).toBe('loading');
    await waitFor(() => expect(result.current.status).toBe('success'));
    expect(result.current.data).toEqual({ id: 42, name: 'Ada' });
  });

  it('handles the error branch', async () => {
    const error = new Error('request failed');
    const fetchUser = vi.fn().mockRejectedValue(error);
    const { result } = renderHook(() => useUser(fetchUser));

    await waitFor(() => expect(result.current.status).toBe('error'));
    expect(result.current.error).toBe(error);
  });
});

预期结果如下。不同 Vitest 版本的终端排版可能不同,但两条用例都应通过。

text
handles the success branch: passed
handles the error branch: passed

为什么使用 waitFor 而不是固定延时

waitFor 会反复执行断言,直到断言通过或超时,因此它等待的是“可观察状态满足条件”。这比 setTimeout 或手写 sleep 更可靠:测试不会因为机器快慢不同而偶发失败,也不会无意义地等待一个固定时长。

这里先同步断言 loading,再等待 success 或 error。这样既验证了请求确实进入加载态,也验证了 Promise 完成后 Hook 能进入正确分支。

处理容易被忽略的边界

如果 Hook 会因为参数变化重新请求,还应增加“旧请求返回晚于新请求”或“组件卸载后 Promise 才完成”的测试。示例中的 cancelled 标记就是为了避免卸载后继续写入状态。

对于使用假定时器的 Hook,例如内部包含防抖或轮询,应使用测试框架的 fake timers,并把“时间推进”和“Promise 完成”分开控制。普通请求 Promise 则优先使用 waitFor,不要为了异步而一律启用假定时器。

测试异步 Hook 的关键不是把实现细节逐行复刻,而是验证调用者真正依赖的状态和结果:请求开始时可见 loading,成功时拿到 data,失败时拿到 error。

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

目录与阅读设置

阅读设置

17

记录一个想法

测试 Hooks 与异步逻辑

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

登录哪都通