pinia 默认不持久化状态,需通过 pinia-plugin-persistedstate 插件自动存取 localstorage/sessionstorage;安装后全局注册,再在 store 中配置 persist、paths/omit、storage 等选项控制保存范围与位置,并注意序列化限制与结构变更兼容性。

Pinia 默认不保存状态到本地,刷新页面数据就清空。要让 token、用户信息、主题设置等“留下来”,得靠 pinia-plugin-persistedstate 插件自动存取 localStorage 或 sessionStorage,不用手写 setItem/getItem。
安装并全局注册插件
这是基础准备,只需一次:
- 运行 npm install pinia-plugin-persistedstate(或 pnpm add / yarn add)
- 在创建 Pinia 实例的文件中(通常是 main.ts 或 src/stores/index.ts)引入并注册:
import { createPinia } from 'pinia'
import piniaPluginPersistedstate from 'pinia-plugin-persistedstate'
const pinia = createPinia()
pinia.use(piniaPluginPersistedstate)
export default pinia
注册后,插件已就绪,后续只在需要持久化的 store 中声明即可。
在 Store 中启用并控制保存范围
不是所有状态都该存——临时 UI 状态(如菜单开关、加载中标志)不该落盘,核心数据才值得保留。
- 全量保存(简单场景):设 persist: true,插件会把整个 state 序列化后存进 localStorage,key 默认为 "pinia/你的storeID"
- 按字段保存(推荐):用 paths 明确列出顶层字段,例如 paths: ['token', 'userInfo', 'themeMode'],避免误存函数、undefined 或不可序列化值
- 排除字段:也可用 omit: ['loading', 'error'],效果等同于 paths 白名单
选择存储位置与自定义行为
localStorage 和 sessionStorage 行为不同,选错会影响体验:
- localStorage:适合长期保留的数据,比如登录凭证、用户偏好,关浏览器再开还在
- sessionStorage:适合单标签页生命周期的数据,比如多步骤表单中间态,换标签页即清空
- 可在 persist 中指定:storage: sessionStorage;或使用 strategies 数组实现更灵活策略(如不同字段存不同位置、自定义 key)
- 加 debug: true 可在控制台查看持久化过程是否出错
注意几个关键限制
持久化不是“开了就完事”,容易踩坑:
- paths 只支持顶层字段名,不支持嵌套路径(如 profile.email),需先扁平化 state 或配合 partialize
- 函数、DOM 引用、Promise、undefined 等无法被 JSON.stringify 序列化,会被丢弃,导致恢复后 state 不完整
- 修改 store 结构(如删字段、改类型)后,旧 localStorage 数据可能解析失败,建议用 beforeHydrate 或 afterHydrate 钩子做迁移或清洗
- 敏感信息(如 token)若需防多标签页共享风险,优先考虑 sessionStorage,而非明文存在 localStorage










