使用 Vitest 测试 React 应用程序：综合指南

测试是现代软件开发的一个关键方面，可确保您的代码按预期工作并防止随着应用程序的发展而出现回归。在 React 生态系统中，像 Vitest 这样的工具提供了一个快速、强大且易于使用的测试框架，可以与现代 React 应用程序无缝集成。在这篇文章中，我们将探讨如何设置和使用 Vitest 来有效地测试您的 React 组件、挂钩和实用程序。

---

1. 维测简介

Vitest 是一个速度极快的测试框架，专为现代 JavaScript 和 TypeScript 项目构建，特别是那些使用 Vite 作为构建工具的项目。 Vitest 的灵感来自 Jest，Jest 是 React 社区中最受欢迎的测试框架之一，但它针对速度和简单性进行了优化，使其成为 Vite 支持的 React 项目的绝佳选择。

主要特点：

• 快速执行： Vitest 并行运行测试并利用 Vite 的快速构建功能。
• 原生 ESM 支持： Vitest 专为现代 JavaScript 设计，为 ES 模块提供开箱即用的支持。
• 与 Jest 的兼容性：如果您熟悉 Jest，您会发现 Vitest 的 API 很熟悉，从而使过渡顺利。
• 内置 TypeScript 支持： Vitest 原生支持 TypeScript，为您的测试提供类型安全。

---

2. 在 React 项目中设置 Vitest

让我们从在 React 项目中设置 Vitest 开始。我们假设您有一个使用 Vite 创建的 React 应用程序。如果没有，您可以使用以下命令快速创建一个：

npm create vite@latest my-react-app -- --template react
cd my-react-app

步骤一：安装Vitest及相关依赖

安装 Vitest 以及 React 测试库和其他必要的依赖项：

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

• vitest：测试框架。
• @testing-library/react：提供测试 React 组件的实用程序。
• @testing-library/jest-dom：为 DOM 节点断言添加自定义匹配器到 Jest 和 Vitest。
• @testing-library/user-event：模拟用户与 DOM 的交互。

第2步：配置Vitest

接下来，通过在项目根目录中创建或修改 vitest.config.ts 文件来配置 Vitest：

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

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

• 环境：'jsdom'：模拟浏览器环境进行测试。
• globals: true: 允许使用全局变量，如describe、it、expect，而不导入它们。
• setupFiles：用于设置测试配置的文件，类似于 Jest 的 setupFilesAfterEnv。

第 3 步：创建安装文件

在 src 目录中创建 setupTests.ts 文件来配置@testing-library/jest-dom：

import '@testing-library/jest-dom';

此设置将自动在您的测试中包含 jest-dom 提供的自定义匹配器。

---

3. 为 React 组件编写测试

设置好 Vitest 后，让我们为一个简单的 React 组件编写一些测试。考虑以下 Button 组件：

// src/components/Button.tsx
import React from 'react';

type ButtonProps = {
  label: string;
  onClick: () => void;
};

const Button: React.FC<ButtonProps> = ({ label, onClick }) => {
  return <button onClick={onClick}>{label}</button>;
};

export default Button;

现在，让我们为这个组件编写测试：

// src/components/Button.test.tsx
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import Button from './Button';

describe('Button Component', () => {
  it('renders the button with the correct label', () => {
    render(<Button label="Click Me" onClick={() => {}} />);
    expect(screen.getByText('Click Me')).toBeInTheDocument();
  });

  it('calls the onClick handler when clicked', async () => {
    const handleClick = vi.fn();
    render(<Button label="Click Me" onClick={handleClick} />);
    await userEvent.click(screen.getByText('Click Me'));
    expect(handleClick).toHaveBeenCalledTimes(1);
  });
});

说明：

• render：渲染组件以进行测试。
• screen：查询渲染的 DOM。
• userEvent.click：模拟按钮上的点击事件。
• vi.fn()：模拟一个函数来跟踪其调用。

---

4. 运行测试

您可以使用以下命令运行测试：

npx vitest

默认情况下，这将执行遵循 *.test.tsx 或 *.spec.tsx 模式的所有测试文件。您还可以使用以下命令在监视模式下运行测试：

npx vitest --watch

Vitest 将提供详细的输出，向您显示每个测试的状态以及发生的任何错误。

---

5. 测试钩子和自定义实用程序

Vitest 还可以用于测试自定义 React 挂钩和实用程序。假设您有一个自定义挂钩 useCounter:

// src/hooks/useCounter.ts
import { useState } from 'react';

export function useCounter(initialValue = 0) {
  const [count, setCount] = useState(initialValue);

  const increment = () => setCount((prev) => prev + 1);
  const decrement = () => setCount((prev) => prev - 1);

  return { count, increment, decrement };
}

您可以按如下方式为此钩子编写测试：

// src/hooks/useCounter.test.ts
import { renderHook, act } from '@testing-library/react-hooks';
import { useCounter } from './useCounter';

describe('useCounter Hook', () => {
  it('initializes with the correct value', () => {
    const { result } = renderHook(() => useCounter(10));
    expect(result.current.count).toBe(10);
  });

  it('increments the counter', () => {
    const { result } = renderHook(() => useCounter());
    act(() => {
      result.current.increment();
    });
    expect(result.current.count).toBe(1);
  });

  it('decrements the counter', () => {
    const { result } = renderHook(() => useCounter(10));
    act(() => {
      result.current.decrement();
    });
    expect(result.current.count).toBe(9);
  });
});

说明：

• renderHook：在测试环境中渲染一个 React hook。
• act：确保在做出断言之前处理对状态或效果的任何更新。

---

六、结论

Vitest 提供了一种强大而高效的方法来测试 React 应用程序，特别是与 Vite 等现代工具结合使用时。它的简单性、速度以及与现有 Jest 实践的兼容性使其成为小型和大型 React 项目的绝佳选择。

By integrating Vitest into your workflow, you can ensure that your React components, hooks, and utilities are thoroughly tested, leading to more robust and reliable applications. Whether you’re testing simple components or complex hooks, Vitest offers the tools you need to write effective tests quickly.

For more information, visit the Vitest documentation.

Feel free to explore more advanced features of Vitest, such as mocking, snapshot testing, and parallel test execution, to further enhance your testing capabilities.

Happy Coding ?‍?

以上是使用 Vitest 测试 React 应用程序：综合指南的详细内容。更多信息请关注PHP中文网其他相关文章！