React Router v7 测试环境下 useNavigate 的正确使用方式

问题背景

在 React Router v7.0.1 版本中，开发者在使用 React Testing Library 进行单元测试时遇到了一个常见问题：当组件中使用了 useNavigate 钩子时，测试会抛出错误提示"useNavigate() may be used only in the context of a component"。这个问题在 v6.28.0 版本中并不存在，但在升级到 v7.0.1 后开始出现。

问题分析

这个问题的根源在于 React Router v7 对路由提供者(RouterProvider)的导入路径做了调整。在 v7 版本中，React Router 团队将核心路由逻辑与 DOM 特定的实现进行了更清晰的分离。

测试失败的原因主要有两个：

1. 测试环境中没有正确设置路由上下文
2. 错误地从 react-router-dom 导入 RouterProvider，而不是从 react-router 核心包导入

解决方案

正确的解决方法是修改 RouterProvider 的导入路径：

// 错误的方式（从 react-router-dom 导入）
import { RouterProvider } from 'react-router-dom';

// 正确的方式（从 react-router 导入）
import { RouterProvider } from 'react-router';

这一变化反映了 React Router v7 的架构调整，将核心路由功能与 DOM 特定实现分离，使得核心路由逻辑可以更灵活地应用于不同环境（如测试环境、原生应用等）。

注意事项

1. 生产环境与测试环境的差异：这个问题通常只在测试环境中出现，因为生产环境通常会使用 BrowserRouter 或 HashRouter，它们已经包含了正确的路由上下文。

2. flushSync 的特殊情况：如果需要使用 flushSync 选项进行导航，则必须从 react-router-dom 导入 RouterProvider，因为 flushSync 是 DOM 特定的功能。这种情况下，测试环境需要特殊处理。

3. 升级指南：官方升级文档建议的步骤是：

   • 先安装 react-router-dom v7
   • 然后将代码中的导入从 react-router-dom 改为 react-router
   • 最后可以卸载 react-router-dom（如果不需要 DOM 特定功能）

最佳实践

对于大多数项目，建议：

1. 在测试文件中，始终从 react-router 导入 RouterProvider
2. 在生产代码中，根据需要使用 react-router-dom 或 react-router
3. 为测试组件提供完整的路由上下文，可以使用 MemoryRouter 或正确配置的 RouterProvider

// 测试示例
import { render } from '@testing-library/react';
import { RouterProvider } from 'react-router';
import { createMemoryRouter } from 'react-router-dom';

test('should render with navigation', () => {
  const router = createMemoryRouter(routes);
  render(<RouterProvider router={router} />);
  // 测试断言...
});

通过遵循这些实践，可以确保 React Router v7 在测试和生产环境中都能正常工作，同时保持代码的清晰和可维护性。