React / 系统课时

封装本地存储逻辑

封装本地存储逻辑

组件状态默认只存在于当前页面生命周期中,刷新后会重新初始化。把 useState 与 localStorage 的读取、序列化和写入规则封装成自定义 Hook,可以让组件像使用普通状态一样获得浏览器端持久化能力。

学习目标

  • 能封装一个状态与 localStorage 同步的自定义 Hook
  • 理解初始化读取与状态变化写入的执行时机
  • 能处理 JSON 序列化、存储异常和实现边界

明确同步规则

一个最小可用的 useLocalStorage 需要完成两个方向的处理:组件第一次创建状态时从指定键读取已有值;之后状态发生变化时,再把最新值写回浏览器存储。

因为 localStorage 只能保存字符串,对象、数组、布尔值等数据需要通过 JSON.stringify 写入,并在读取时通过 JSON.parse 恢复。读取和写入都可能因无效数据、存储限制或浏览器安全策略失败,因此不应假设操作必然成功。

实现 useLocalStorage

下面的 Hook 使用 useState 的惰性初始化函数完成首次读取,再使用 useEffect 在状态变化后持久化。示例中的存储键保持固定,这也是该基础实现的使用前提。

jsx
import { useEffect, useState } from 'react';

function readStoredValue(key, initialValue) {
  try {
    const stored = window.localStorage.getItem(key);
    return stored === null ? initialValue : JSON.parse(stored);
  } catch {
    // 存储内容损坏或浏览器拒绝访问时回退到初始值。
    return initialValue;
  }
}

function useLocalStorage(key, initialValue) {
  const [value, setValue] = useState(() => readStoredValue(key, initialValue));

  useEffect(() => {
    try {
      // 状态变化后统一完成序列化和持久化,组件无需直接操作 localStorage。
      window.localStorage.setItem(key, JSON.stringify(value));
    } catch (error) {
      console.error('Failed to save localStorage value:', error);
    }
  }, [key, value]);

  return [value, setValue];
}

export default function App() {
  const [name, setName] = useLocalStorage('profile-name', '');

  return (
    <main>
      <label>
        姓名:
        <input
          value={name}
          onChange={(event) => setName(event.target.value)}
        />
      </label>
      <p>当前姓名:{name || '未填写'}</p>
    </main>
  );
}

预期结果

text
首次访问且没有已保存数据时,页面显示:当前姓名:未填写
输入 <VALUE> 后,页面立即显示:当前姓名:<VALUE>
刷新页面后,输入框和文本仍恢复为之前保存的 <VALUE>

<VALUE> 表示实际输入的姓名,具体内容由用户操作决定。组件只调用 setName,并不知道数据是在何时写入 localStorage,这正是封装后的价值。

处理序列化与异常

如果读取到的字符串不是合法 JSON,JSON.parse 会抛出异常。示例捕获异常并使用 initialValue,避免损坏的浏览器数据直接导致组件渲染失败。写入阶段同样使用 try...catch,因为容量不足或浏览器策略限制都可能令 setItem 失败。

如果传入对象或数组,调用者也应避免原地修改数据。应通过 React 的状态更新方式创建新值,否则即使存储逻辑正确,也可能因为状态引用没有变化而得不到预期的重新渲染。

认识基础实现的边界

这个版本面向浏览器客户端运行,因此读取阶段直接使用了 window.localStorage。在服务端渲染环境中,服务器没有 window 对象,需要把读取推迟到客户端,或者由所使用的框架提供客户端组件边界。

此外,同一网站的另一个浏览器标签页修改相同键时,本 Hook 不会自动更新当前标签页的 React 状态。要实现跨标签实时同步,还需要监听浏览器的 storage 事件。对于普通的“刷新后保留表单偏好”需求,当前实现已经提供了清晰且可复用的最小方案。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

封装本地存储逻辑

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通