React+TS+i18n项目测试react-intl组件报找不到intl对象如何解决?
问题原因
这个报错的核心原因是Title组件内部使用了FormattedMessage组件,依赖react-intl提供的intl上下文对象,但单元测试时直接渲染Title组件,外层没有包裹IntlProvider提供上下文,因此抛出找不到intl对象的错误。
解决方案
下面提供两种常用的修复方案,推荐优先使用第二种,减少重复代码:
方案1:单测试用例手动包裹IntlProvider
直接在测试渲染时给Title组件外层套上IntlProvider,配置必要的locale和messages参数即可:
import { IntlProvider } from 'react-intl'; // 可以导入项目真实的翻译资源,也可以用测试专用的mock翻译 const mockMessages = { date: '日期' // 要包含组件用到的message key }; const titleItem: TitleItem = { title: 'test', date: '2021-01-01' }; test('should be initialized', () => { render( <IntlProvider locale="zh" messages={mockMessages}> <Title data={titleItem} /> </IntlProvider> ); expect(screen.getByText("test")).toBeInTheDocument(); // 还可以额外验证翻译渲染:expect(screen.getByText("日期: 2021-01-01")).toBeInTheDocument() });
方案2:封装带全局Provider的自定义render函数
如果项目中多个组件都用到了国际化,每个测试单独包裹IntlProvider会产生大量重复代码,可按照React Testing Library的最佳实践封装自定义渲染工具:
- 新建测试工具文件
test-utils.tsx:
import { render, RenderOptions } from '@testing-library/react'; import { IntlProvider } from 'react-intl'; // 导入项目全局翻译资源,也可以使用mock资源 import zhMessages from './locales/zh.json'; const AllProviders = ({ children }: { children: React.ReactNode }) => { return ( <IntlProvider locale="zh" messages={zhMessages}> {children} </IntlProvider> ); }; const customRender = (ui: React.ReactElement, options?: Omit<RenderOptions, 'wrapper'>) => render(ui, { wrapper: AllProviders, ...options }); // 重新导出所有React Testing Library的方法 export * from '@testing-library/react'; export { customRender as render };
- 测试用例中引入自定义的
render方法即可,原有测试逻辑不需要改动:
// 把原来从'@testing-library/react'导入render的语句替换成从自定义工具导入 import { render, screen } from './test-utils'; const titleItem: TitleItem = { title: 'test', date: '2021-01-01' }; test('should be initialized', () => { render(<Title data={titleItem} />); expect(screen.getByText("test")).toBeInTheDocument(); });
注意事项
不推荐通过jest mockFormattedMessage组件的方式解决问题,该方式会跳过真实的国际化渲染逻辑,无法验证翻译内容的正确性,测试结果和真实运行场景偏差较大。
内容的提问来源于stack exchange,提问作者wtf512
相关产品推荐
相关产品推荐

