
本教程详细讲解了在 react router v6 中如何实现认证保护的私有路由和重定向。文章阐明了 `usenavigate` 钩子和 `navigate` 组件的正确用法,并提供了一个 `privateroute` 组件的实现范例,以解决常见的 `usenavigate() may be used only in the context of a
在现代单页应用(SPA)中,基于用户认证状态控制页面访问权限是一个常见需求。例如,只有登录用户才能访问某些特定页面,未登录用户则应被重定向到登录页。React Router v6 引入了新的 API 和概念,使得实现这类功能更加直观和强大。本文将深入探讨如何在 React Router v6 中构建私有路由(Private Routes)并实现条件重定向,同时解决在使用 useNavigate() 钩子时可能遇到的上下文错误。
理解 React Router v6 中的重定向
在 React Router v6 中,旧版(如 v5)中的 Redirect 组件已被移除。现在,实现重定向主要有两种方式:
- useNavigate 钩子 (Hook):用于在函数组件内部进行程序化(命令式)导航。
- Navigate 组件 (Component):用于在 JSX 中声明式地进行导航。
这两种方式都必须在
构建认证上下文
为了管理用户的登录状态,我们通常会使用 React 的 Context API。这使得登录状态可以在整个应用中轻松共享,而无需通过 props 层层传递。
首先,定义一个认证上下文:
// src/context/AuthContext.js
import React, { createContext, useState, useEffect, useCallback } from 'react';
export const AuthContext = createContext({
isLoggedIn: false,
token: null,
login: () => {},
logout: () => {}
});
let logoutTimer;
export const AuthProvider = (props) => {
const [token, setToken] = useState(null);
const [isLoggedIn, setIsLoggedIn] = useState(false);
// 可以添加更多状态,例如用户信息、token过期时间等
const login = useCallback((uid, token, expirationDate) => {
setToken(token);
setIsLoggedIn(true);
// 存储 token 和过期时间到 localStorage
const tokenExpirationDate = expirationDate || new Date(new Date().getTime() + 1000 * 60 * 60); // 1小时
localStorage.setItem(
'userData',
JSON.stringify({
userId: uid,
token: token,
expiration: tokenExpirationDate.toISOString()
})
);
}, []);
const logout = useCallback(() => {
setToken(null);
setIsLoggedIn(false);
clearTimeout(logoutTimer);
localStorage.removeItem('userData');
}, []);
useEffect(() => {
if (token) {
const storedData = JSON.parse(localStorage.getItem('userData'));
if (storedData && storedData.token && new Date(storedData.expiration) > new Date()) {
const remainingTime = new Date(storedData.expiration).getTime() - new Date().getTime();
logoutTimer = setTimeout(logout, remainingTime);
}
}
}, [token, logout]);
useEffect(() => {
const storedData = JSON.parse(localStorage.getItem('userData'));
if (storedData && storedData.token && new Date(storedData.expiration) > new Date()) {
login(storedData.userId, storedData.token, new Date(storedData.expiration));
}
}, [login]);
return (
{props.children}
);
};实现私有路由组件 PrivateRoute
PrivateRoute 组件的核心逻辑是检查用户的认证状态。如果用户已登录,则渲染其子组件(即受保护的页面);如果未登录,则使用 Navigate 组件将用户重定向到登录页面。
// src/components/PrivateRoute.js
import React, { useContext } from 'react';
import { Navigate } from 'react-router-dom';
import { AuthContext } from '../context/AuthContext'; // 引入认证上下文
const PrivateRoute = ({ children }) => {
const auth = useContext(AuthContext);
if (!auth.isLoggedIn) {
// 如果用户未登录,则重定向到 /login 页面
// replace 属性确保重定向后,用户无法通过浏览器回退按钮返回到受保护页面
return ;
}
// 如果用户已登录,则渲染子组件(即受保护的页面)
return children;
};
export default PrivateRoute;注意事项:
- Navigate 组件:这是 React Router v6 中实现声明式重定向的关键。它在渲染时会触发导航。
- replace 属性:当 replace 设为 true 时,新的导航会替换掉历史堆栈中的当前条目,而不是添加一个新的条目。这对于重定向场景非常有用,可以防止用户在未登录状态下通过回退按钮访问受保护页面。
- AuthContext:通过 useContext 钩子获取认证状态,这是实现条件渲染和重定向的基础。
在应用中配置路由
现在,我们可以在主应用组件中配置路由,并使用 PrivateRoute 来保护需要认证的页面。
// src/App.js
import React, { useState, useCallback } from 'react';
import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';
import { AuthProvider, AuthContext } from './context/AuthContext';
import PrivateRoute from './components/PrivateRoute';
// 假设这些是你的页面组件
import HomePage from './pages/HomePage';
import LoginPage from './pages/LoginPage';
import DashboardPage from './pages/DashboardPage';
import ProfilePage from './pages/ProfilePage';
import NotFoundPage from './pages/NotFoundPage'; // 404 页面
const App = () => {
return (
// AuthProvider 应该包裹在 Router 外部,以便所有路由和组件都能访问认证上下文
{/* 这里可以放置全局导航栏或其他布局组件 */}
{/* 公共路由,无需认证即可访问 */}
} />
} />
{/* 私有路由,需要认证才能访问 */}
}
/>
}
/>
{/* 匹配所有未定义路由的 404 页面 */}
} />
);
};
export default App;关键点:
-
:作为整个路由系统的根组件,所有使用 useNavigate 或 Navigate 的组件都必须在其内部。 -
:为了确保所有路由组件都能访问到认证上下文,AuthProvider 应该包裹在 的外面。 -
和 :用来包裹所有的 定义,它会选择第一个匹配的路由进行渲染。 -
element 属性:在 React Router v6 中,
不再使用 component 或 render 属性,而是使用 element 属性来接收一个 JSX 元素。 - 嵌套 PrivateRoute:将需要保护的页面组件作为 PrivateRoute 的子组件传递。
总结
通过上述方法,我们成功地在 React Router v6 中实现了强大的认证保护私有路由和重定向机制。这种模式不仅解决了 useNavigate() may be used only in the context of a
核心要点回顾:
-
BrowserRouter 包裹一切:确保所有路由相关的钩子和组件都在
的上下文内。 - useContext 获取认证状态:利用 React Context API 集中管理并共享用户的登录状态。
- PrivateRoute 组件封装逻辑:创建一个可复用的 PrivateRoute 组件,根据认证状态决定是渲染受保护内容还是执行重定向。
- Navigate 组件进行声明式重定向:在 PrivateRoute 内部使用 Navigate 组件来执行重定向,特别是配合 replace 属性以优化用户体验和历史记录管理。
遵循这些实践,您将能够构建出更加健壮、安全且用户友好的 React 应用。









