React 组件和 hook 如何写单元测试？

站长

2023年08月18日 17:16 · 阅读数 8

当你写完一个 React 组件，如何保证它的功能是正常的呢？

在浏览器里渲染出来，手动测试一遍就好了啊。

那如果这个组件交给别人维护了，他并不知道这个组件的功能应该是什么样的，怎么保证他改动代码之后，组件功能依然正常？

这种情况就需要单元测试了。

单元测试可以测试函数、类的方法等细粒度的代码单元，保证功能正常。

有了单元测试之后，后续代码改动只需要跑一遍单元测试就知道功能是否正常。

但很多同学觉得单元测试没意义，因为代码改动比较频繁，单元测试也跟着需要频繁改动。

确实，如果代码改动特别频繁，就没必要单测了，手动测试就好。

因为如果手动测试一遍需要 5 分钟，写单元测试可能需要一个小时。

但如果代码比较稳定，那单测还是很有必要的，比如组件库里的组件、hooks 库里的 hooks、一些工具函数等。

手动测试 5 分钟，每次都要手动测试，假设 20 次，那就是 100 分钟的成本，而且还不能保证测试是可靠的。

写单测要一个小时，每次直接跑单测自动化测试，跑 100 次也是一个小时的成本，而且还是测试结果很可靠。

综上，单元测试能保证函数、类的方法等代码单元的功能正常，把手动测试变成自动化测试。

但是写单元测试成本还是挺高的，如果代码改动频繁，那手动测试更合适。一些比较稳定的代码，还是有必要写单测的，写一次，自动测试 n 次，收益很大。

那 React 的组件和 hooks 怎么写单测呢？

这篇文章我们一起来写几个单测试试。

用 create-react-app 创建个 react 项目：

npx create-react-app --template=typescript react-unit-test

React 组件和 hook 如何写单元测试？

测试 react 组件和 hooks 可以使用 @testing-library/react 这个包，然后测试用例使用 jest 来组织。

这两个包 cra 都给引入了，我们直接跑下 npm run test 就可以看到单测结果。

React 组件和 hook 如何写单元测试？

App 组件是这样的：

React 组件和 hook 如何写单元测试？

它的单测是这么写的：

React 组件和 hook 如何写单元测试？

通过 @testing-library/react 的 render 函数把组件渲染出来。

通过 screen 来查询 dom，查找文本内容匹配正则 /learn react/ 的 a 标签。

然后断言它在 document 内。

你也可以这么写：

test('renders learn react link 2', () => {
  const { container } = render(<App />);
  const linkElement = container.querySelector('.App-link');

  expect(linkElement?.textContent).toMatch(/learn react/i)
});

render 会返回组件挂载的容器 dom，它是一个 HTMLElement 的对象，有各种 dom 方法。

React 组件和 hook 如何写单元测试？

可以用 querySelector 查找到那个 a 标签，然后判断它的内容是否匹配正则。

这两种写法都可以。

第二种方法更容易理解，就是拿到渲染容器的 dom，再用 dom api 来查找 dom。

第一种方法的 screen 是 @testing-library/react 提供的 api，是从全局查找 dom，可以直接根据文本查（getByText），根据标签名和属性查（getByRole）等。

其实 render 方法返回的对象里也有这些 api：

React 组件和 hook 如何写单元测试？

个人感觉没啥必要用这种 api，直接拿到 container dom 再做 dom 操作的方式就好了。

antd 组件的测试也是用的这种：

React 组件和 hook 如何写单元测试？

那如果有 onClick、onChange 等事件监听器的组件，怎么测试呢？

我们写个组件：

import { useCallback, useState } from 'react';

function Toggle() {

    const [status, setStatus] = useState(false);

    const clickHandler = useCallback(() => {
        setStatus((prevStatus) => !prevStatus);
    }, []);

    return (
        <div>
            <button onClick={clickHandler}>切换</button>
            <p>{status ? 'open' : 'close' }</p>
        </div>
    );
}

export default Toggle;

渲染出来是这样的：

React 组件和 hook 如何写单元测试？

这个组件如何测试呢？

需要用到 firEvent 方法了。

import { render, fireEvent } from '@testing-library/react';
import Toggle from './Toggle';

test('toggle', () => {
  const { container } = render(<Toggle/>);

  expect(container.querySelector('p')?.textContent).toBe('close');

  fireEvent.click(container.querySelector('button')!)
  
  expect(container.querySelector('p')?.textContent).toBe('open');
})