React 应用中认证状态刷新丢失的解决方案

React 应用中认证状态刷新丢失的解决方案

在React应用中,页面刷新会导致组件状态(包括认证信息)丢失,因为useState会重新初始化。本文将深入探讨这一常见问题,解释其根本原因,并提供一个基于localStorage的有效解决方案。通过在useState初始化时直接读取localStorage,并利用useEffect监听状态变化以同步更新localStorage,可以确保用户认证信息在页面刷新后依然持久化,从而提供更流畅的用户体验。

理解React状态的生命周期与持久化挑战

在React中,组件的状态(通过useState或usereducer管理)是与组件实例绑定的。当用户进行页面刷新(F5或地址栏回车)时,整个React应用会被重新加载,所有组件实例都会被销毁并重新创建。这意味着,所有通过useState定义的状态都会被重置为其初始值。

以提供的认证上下文(AuthContext)为例:

// AuthProvider 简化版 export const AuthProvider = ({ children }) => {   const [auth, setAuth] = useState({}); // 问题所在:每次刷新都会重置为 {}   const [loading, setLoading] = useState(true);    useEffect(() => {     const storedToken = localStorage.getItem("AccessToken");     const storedRoles = localStorage.getItem("roles");     const storedId = localStorage.getItem("userId");      if (storedToken && storedRoles && storedId) {       const token = json.parse(storedToken);       const roles = JSON.parse(storedRoles);       const id = JSON.parse(storedId);       setAuth({ token: token, roles: roles, id: id });     }     setLoading(false);   }, []); // 此 useEffect 在组件首次渲染后运行    return (     <AuthContext.Provider value={{ auth, setAuth, loading }}>       {children}     </AuthContext.Provider>   ); };

上述代码的问题在于,const [auth, setAuth] = useState({}); 这一行会在每次 AuthProvider 组件挂载时(即页面刷新后)将 auth 状态初始化为一个空对象 {}。尽管 useEffect 会在组件首次渲染后尝试从 localStorage 中加载数据并更新 auth,但在 useEffect 执行完成之前,auth 仍然是初始的空对象。如果其他组件(如 Exercises)在此时尝试访问 auth.id,它将得到 undefinedNULL,导致逻辑错误。

例如,在 Exercises 组件中:

// Exercises 组件片段 function Exercises() {   const { auth, loading } = useAuth(); // auth 此时可能为 {}   // ...   useEffect(() => {     // ...     // 如果 auth.id 此时为 undefined,getUserExercises(undefined) 将失败     api.getUserExercises(auth.id).then((response) => {       setRequests(response.data);     });   }, [id, auth.id]); // 依赖 auth.id   // ...   const onSubmit = (e) => {     e.preventDefault();     console.log("User id" + auth.id); // auth.id 此时可能为 undefined     const updatedExerciseData = {       ...exerciseData,       userId: auth.id, // userId 可能为 undefined       date: new Date(),     };     // ...   }; }

解决方案:使用 localStorage 持久化认证状态

要解决页面刷新导致的状态丢失问题,我们需要将认证信息存储在浏览器客户端的持久化存储中,并在组件初始化时从该存储中读取。localStorage 是一个常见的选择。关键在于,useState 的初始值应该直接从 localStorage 中获取,而不是在 useEffect 中异步设置。

以下是改进后的 AuthProvider 代码:

import { createContext, useState, useEffect } from "react";  const AuthContext = createContext({});  // 辅助函数:从 localStorage 获取初始认证数据 const getInitialAuth = () => {   try {     const storedToken = localStorage.getItem("accessToken");     const storedRoles = localStorage.getItem("roles");     const storedId = localStorage.getItem("userId");      if (storedToken && storedRoles && storedId) {       // 确保所有必要的数据都存在       const token = JSON.parse(storedToken);       const roles = JSON.parse(storedRoles);       const id = JSON.parse(storedId);       return { token, roles, id };     }   } catch (error) {     console.error("Failed to parse auth data from localStorage", error);     // 如果解析失败,可能是数据损坏,清除 localStorage     localStorage.removeItem("accessToken");     localStorage.removeItem("roles");     localStorage.removeItem("userId");   }   return {}; // 如果没有有效数据,返回空对象 };  export const AuthProvider = ({ children }) => {   // 1. useState 的初始值设置为一个函数,该函数在组件首次渲染时执行一次,从 localStorage 获取数据   const [auth, setAuth] = useState(getInitialAuth);   // 2. loading 状态可以根据同步的 localStorage 读取结果来初始化   const [loading, setLoading] = useState(false); // 因为 getInitialAuth 是同步的    // 3. 使用 useEffect 监听 auth 状态的变化,并将其持久化到 localStorage   useEffect(() => {     if (auth.token && auth.roles && auth.id) {       // 当 auth 状态更新时(例如登录成功),将其保存到 localStorage       localStorage.setItem("accessToken", JSON.stringify(auth.token));       localStorage.setItem("roles", JSON.stringify(auth.roles));       localStorage.setItem("userId", JSON.stringify(auth.id));     } else {       // 如果 auth 状态变为空(例如用户登出),清除 localStorage       localStorage.removeItem("accessToken");       localStorage.removeItem("roles");       localStorage.removeItem("userId");     }   }, [auth]); // 依赖 auth 对象,当 auth 发生变化时触发    // 登出函数,用于清除认证状态和 localStorage   const logout = () => {     setAuth({});     localStorage.removeItem("accessToken");     localStorage.removeItem("roles");     localStorage.removeItem("userId");   };    return (     <AuthContext.Provider value={{ auth, setAuth, loading, logout }}>       {children}     </AuthContext.Provider>   ); };  export default AuthContext;

关键改进点解释:

  1. useState(getInitialAuth):
    • useState 接受一个函数作为初始值,这个函数只会在组件的第一次渲染时执行。
    • getInitialAuth 函数同步地从 localStorage 读取数据并返回。
    • 这样,当 AuthProvider 首次挂载时,auth 状态会立即被初始化为 localStorage 中的数据(如果存在),而不是一个空对象。这避免了 auth 短暂为 {} 的情况。
  2. useEffect([auth]):
    • 这个 useEffect 的作用是将当前的 auth 状态同步到 localStorage
    • 每当 auth 状态通过 setAuth 更新时(例如用户登录、登出),这个 useEffect 就会触发。
    • 它确保了 localStorage 中的数据始终与当前的 auth 状态保持一致。

消费者组件的调整与注意事项

在 Exercises 或其他消费 useAuth 的组件中,由于 auth 状态在组件挂载时就已从 localStorage 初始化,因此 auth.id 在大多数情况下会立即可用(如果用户已登录)。

// Exercises 组件改进 import React, { useState, useEffect } from "react"; import { useParams, useNavigate } from "react-router-dom"; import styles from "./ExercisePage.module.css"; import api from "../../apis/requestService"; import useAuth from "../../hooks/useAuth";  function Exercises() {   const { setAuth, auth, loading } = useAuth(); // auth.id 此时应已正确初始化   const { id } = useParams();   const navigate = useNavigate();   const [requests, setRequests] = useState([]);   const [exerciseData, setExerciseData] = useState({     weight: "",     reps: "",     exerciseId: id,     date: null,   });   const [err, setErr] = useState("");   const [popupStyle, showPopup] = useState("hide");    const { weight, reps } = exerciseData;    useEffect(() => {     setExerciseData((prevData) => ({       ...prevData,       exerciseId: id,       date: new Date(),     }));      // 确保 auth.id 存在且有效才进行 API 调用     if (auth.id) {       api.getUserExercises(auth.id).then((response) => {         setRequests(response.data);       }).catch(error => {         console.error("Error fetching user exercises:", error);         // 处理错误,例如导航到登录页       });     } else if (!loading) { // 如果 auth.id 不存在且认证加载已完成,可能需要重定向       console.warn("Auth ID not available, user might not be logged in.");       // navigate('/login'); // 示例:如果需要强制登录     }   }, [id, auth.id, loading]); // 依赖 auth.id 和 loading 状态    const onInputChange = (e) => {     setExerciseData({ ...exerciseData, [e.target.name]: e.target.value });   };    const onSubmit = (e) => {     e.preventDefault();     if (!auth.id) {       setErr("User not authenticated. Please log in.");       popup();       return;     }     console.log("User id: " + auth.id);     const updatedExerciseData = {       ...exerciseData,       userId: auth.id,       date: new Date(),     };      api       .createRequest(updatedExerciseData)       .then((response) => {         if (response.data.id) {           // 再次确保 auth.id 存在           return api.getUserExercises(auth.id);         } else {           throw new Error("An error occurred while creating the request.");         }       })       .then((response) => {         setRequests(response.data);         setExerciseData({ ...updatedExerciseData, weight: "", reps: "" });       })       .catch((error) => {         console.error(error);         setErr("An error occurred while creating the request.");         popup();       });   };    const popup = () => {     showPopup("exercise-popup");     setTimeout(() => showPopup("hide"), 3000);   };    // 如果数据仍在加载,可以显示加载指示器   if (loading) {     return <div>Loading authentication data...</div>;   }    // 渲染逻辑...   return (     <div className={styles.wrapper}>       {/* ... (原有渲染代码) ... */}       <div className={styles.content}>         {requests.length > 0 ? (           requests.map((request, index) => (             <div key={index} className={styles.requestBox}>               <div className={styles.requestDetails}>                 <h2>{request.exercise.name}</h2>                 <p>{request.exercise.description}</p>               </div>               @@##@@               <div className={styles.requestInfo}>                 <p>Weight: {request.weight} kg</p>                 <p>Reps: {request.reps}</p>                 <p>Date: {new Date(request.date).toLocaleDateString()}</p>               </div>             </div>           ))         ) : (           <p>No exercises assigned yet.</p>         )}       </div>       <form onSubmit={(e) => onSubmit(e)} className={styles.exerciseForm}>         <h1 className={styles.h1Text}>           Set <br /> Exercise         </h1>         <div className={styles.inputContainer}>           <label htmlFor="weight" className={styles.inputLabel}>             Enter weight           </label>           <input             id="weight"             name="weight"             type="number"             value={weight}             min="0"             onChange={onInputChange}             className={styles.inputBox}           />         </div>         <div className={styles.inputContainer}>           <label htmlFor="reps" className={styles.inputLabel}>             Enter reps           </label>           <input             id="reps"             name="reps"             type="number"             value={reps}             min="0"             onChange={onInputChange}             className={styles.inputBox}           />         </div>         <button className={styles.exerciseBtn} type="submit">           +         </button>         <div className={popupStyle}>           <h3>{err}</h3>         </div>       </form>     </div>   ); }  export default Exercises;

重要注意事项:

  • 数据类型转换: localStorage 只能存储字符串。因此,在存储对象(如 token、roles、id)时,需要使用 JSON.stringify() 将其转换为字符串;在读取时,需要使用 JSON.parse() 将其转换回 JavaScript 对象。
  • 错误处理: 在 getInitialAuth 函数中添加 try-catch 块来处理 JSON.parse 可能抛出的错误,以防 localStorage 中的数据损坏。
  • 安全性: localStorage 并非安全存储敏感信息的理想场所,因为它容易受到跨站脚本(xss)攻击。对于认证令牌(如 JWT),更推荐使用 HttpOnly 属性的 Cookie。然而,对于用户ID和角色等非敏感信息,localStorage 是一个可接受的选项。
  • loading 状态: 尽管 localStorage 的读取是同步的,但如果 AuthProvider 内部有其他异步操作(例如,从服务器验证令牌),loading 状态仍然很有用,可以用来在认证信息完全加载前显示加载指示器或阻止某些操作。
  • 其他持久化方案:
    • sessionstorage: 类似 localStorage,但数据仅在当前浏览器会话中有效,关闭浏览器标签页或窗口后数据会丢失。
    • Redux Persist: 如果项目使用 Redux 进行状态管理,Redux Persist 是一个流行的库,可以自动将 Redux store 的部分或全部状态持久化到 localStorage 或 sessionStorage。
    • 服务器端会话/Cookie: 对于更高级别的安全性需求,可以将认证状态完全存储在服务器端,并通过 HttpOnly Cookie 维护会话ID。

总结

通过在 useState 初始化时直接读取 localStorage,并在 useEffect 中监听状态变化以同步更新 localStorage,我们可以有效地解决 React 应用中认证状态在页面刷新后丢失的问题。这种模式确保了用户体验的连贯性,并为需要持久化状态的场景提供了可靠的解决方案。在实际应用中,请根据项目的具体安全需求和复杂度,选择最合适的持久化策略。

React 应用中认证状态刷新丢失的解决方案

© 版权声明
THE END
喜欢就支持一下吧
点赞7 分享