Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用

《基于 vite 创建 vue3 项目》一文中整合了 pinia,有不少伙伴不知道 pinia 是什么,本文简单介绍 pinia。主要包括三方面:

  1. pinia 的基本用法,在《基于 vite 创建 vue3 项目》中 demo 的基础上简单重构。
  2. 如何持久化 pinia 中的数据,保证浏览器刷新时,pinia 中的数据不丢失;
  3. vue-router 路由守卫中如何使用 pinia

文中的 demo 仍然基于 vite

1 pinia 的使用

1.1 pinia 是什么

在 vue 2.x 中,vuex 是官方的状态管理库,并且 vue 3 中也有对应的 vuex 版本。但 vue 作者尤大神看了 pinia 后,强势推荐使用 pinia 作为状态管理库。下图是 vue 官网 “生态系统”,pinia 是 vue 生态之一。
Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图

1.2 pinia 的特点

  1. 支持 vue2 和 vue3,两者都可以使用 pinia
  2. 语法简洁,支持 vue3 中 setup 的写法,不必像 vuex 那样定义 statemutationsactionsgetters 等,可以按照 setup Composition API 的方式返回状态和改变状态的方法,实现代码的扁平化;
  3. 支持 vuex 中 stateactionsgetters 形式的写法,丢弃了 mutations,开发时候不用根据同步异步来决定使用 mutationsactions,pinia 中只有 actions
  4. TypeScript 支持非常友好。

1.3 pinia 的使用

在《基于 vite 创建 vue3 项目》中已经整合了 pinia,现简单回顾并进行一些调整。

  1. 安装 pinia 依赖:
yarn add pinia
  1. 创建 pinia 实例(根存储 root store):

之前咱是在 main.ts 中创建的,现将其抽取到独立的文件中:

src/store/index.ts

import { createPinia } from 'pinia'

const pinia = createPinia()

export default pinia
  1. main.ts 中以插件的方式传递给 App 实例。
...
import pinia from '@/store'
...
app.use(pinia)
...
  1. store/ 目录下创建 modules 目录,存储每个模块的状态,将之前的 demo.ts 移动到 store/modules/ 中。这里使用最新的 Composition API setup 的方式来定义状态。

src/store/modules/demo.ts

import { defineStore } from 'pinia'
import { ref } from 'vue'

const useDemoStore = defineStore('demo', () => {
  const counter = ref(0)

  const increment = () => {
    counter.value++
  }

  return {
    counter,
    increment
  }
})

export default useDemoStore
  1. 在组件 about.vue 中使用 demo 中的状态 counter 和改变状态的函数 increment。代码和之前一样。

先引入 demo.ts 中定义的 useDemoStore 函数,通过该函数创建 demoStore 实例。然后就可以调用 demoStore 的状态 counterincrement 函数了。这里需要注意,无论是 pinia 还是 vuex,通过解构的方式获取状态,会导致状态失去响应性。如:

const { counter } = demoStore

此时的 counter 会丢失响应性,当其值改变时,其他组件不会监听到。所以 pinia 提供了 storeToRefs 函数,使其解构出来的状态仍然具备响应性。

const { counter } = storeToRefs(demoStore)

src/views/about.vue 完整代码如下:





最后在浏览器中访问 about 页面,可以正常运行,点击加号按钮,计数器会加1。
Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图1

2 持久化 pinia 状态

2.1 为什么需要持久化 pinia 状态

在上面的 demo 中,假设计数器加到 5,如果刷新浏览器,counter 的值又会被初始化为 0。这是因为状态是存储在浏览器内存中的,刷新浏览器后,重新加载页面时会重新初始化 vuepinia,而 pinia 中状态的值仅在内存中存在,而刷新导致浏览器存储中的数据没了,所以 counter 的值就被初始化为 0。

在实际开发中,浏览器刷新时,有些数据希望是保存下来的。如用户登录后,用户信息会存储在全局状态中,如果不持久化状态,那么每次刷新用户都需要重新登录了。

要解决这个问题非常简单,在状态改变时将其同步到浏览器的存储中,如 cookielocalStoragesessionStorage 。每次初始化状态时从存储中去获取初始值即可。

说起来思路很简单,可真正实现起来就各种问题了,所以咱们就使用 pinia 的插件 pinia-plugin-persistedstate 来实现。

2.2 pinia-plugin-persistedstate

接下来就使用 pinia-plugin-persistedstate 插件实现 pinia 状态的持久化。

  1. 安装依赖:
yarn add pinia-plugin-persistedstate
  1. 引入该插件,在创建 pinia 实例时传入该插件

src/store/index.ts

import { createPinia } from 'pinia'
import piniaPluginPersistedstate from 'pinia-plugin-persistedstate'

const pinia = createPinia()
pinia.use(piniaPluginPersistedstate)

export default pinia
  1. 在需要持久化状态的模块中设置 persist。咱假设 demo 模块需要对状态需要持久化,defineStore 第一个参数定义唯一的模块名,第二个参数传递 setup,其实还有第三个参数 options,在 options 中便可开启 persist

src/store/modules/demo.ts

...
const useDemoStore = defineStore('demo', () => {
    ...
}, {
  persist: true
})

此时改变 counter 的值后,刷新浏览器,counter 不会被重置为 0,仍然停留在刷新前的状态。

persist 支持多种类型的值,最简单的就是传递 true,此时会将状态缓存在 localStorage 中,该 localStorage 的 key 为模块名(defineStore 的第一个参数),value 为该模块的状态对象,由于该模块只有一个状态 counter,故value为 {"counter":8}。如下图:

Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图2

如果需要将其存储在 sessionStorage 中,就需要设置 persist 的值为一个对象:

...
const useDemoStore = defineStore('demo', () => {
    ...
}, {
  persist: {
    key: 'aaa',
    storage: sessionStorage
  }
})

此时状态就会同步缓存到 sessionStorage 中,并且key 为咱们指定的 key

Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图3

persist 对象类型为 PersistedStateOptions,上面演示了 keystorage 属性,该对象的其他属性如下:

}
interface PersistedStateOptions {
    /**
     * Storage key to use.
     * @default $store.id
     */
    key?: string;
    /**
     * Where to store persisted state.
     * @default localStorage
     */
    storage?: StorageLike;
    /**
     * Dot-notation paths to partially save state. Saves everything if undefined.
     * @default undefined
     */
    paths?: Array;
    /**
     * Customer serializer to serialize/deserialize state.
     */
    serializer?: Serializer;
    /**
     * Hook called before state is hydrated from storage.
     * @default null
     */
    beforeRestore?: (context: PiniaPluginContext) => void;
    /**
     * Hook called after state is hydrated from storage.
     * @default undefined
     */
    afterRestore?: (context: PiniaPluginContext) => void;
}

3 在路由守卫中使用状态

前面演示了在组件中使用 pinia,在组件外如何使用呢?这里演示在全局路由守卫中获取状态值。咱们创建一个路由守卫,在路由守卫中使用 nprogress 显示页面加载进度条。

3.1 创建全局路由守卫

  1. 安装 nprogress
yarn add nprogress
yarn add @types/nprogress -D 
  1. 创建全局路由守卫

src/router/guard/index.ts

import router from '@/router'
import nProgress from 'nprogress'
import 'nprogress/nprogress.css'

nProgress.configure({
  showSpinner: false
})

// 全局前置守卫
router.beforeEach((to, from) => {
  nProgress.start()
  return true
})

// 全局后置钩子
router.afterEach(() => {
  nProgress.done(true)
})
  1. main.ts 中引入全局路由守卫:
...
import '@/router/guard/index'
...

此时路由切换时,页面顶部会出现加载进度条,路由切换完成时该进度条消失。如果效果不明显,可在前置守卫中 setTimeout 查看效果(个人觉得没这必要,画蛇添足):

// 全局前置守卫
router.beforeEach((to, from) => {
  nProgress.start()
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(true)
    }, 1000)
  })
})

3.2 全局守卫中使用全局状态

实际开发中,路由切换时,可能需要从全局状态中获取 token 等信息,判断是否能进入下一个页面。这里演示路由切换时获取 demo 中的 counter 的值。

首先试试在钩子函数外面使用全局状态:

...
import useDemoStore from '@/store/modules/demo'
import { storeToRefs } from 'pinia'
...

const demoStore = useDemoStore()
const { counter } = storeToRefs(demoStore)

// 全局前置守卫
router.beforeEach((to, from) => {
  nProgress.start()
  // 从 store 中获取其他值,再决定返回值
  // 这里演示获取 store 中 counter 的值
  console.log(counter:${counter})
  return true
})
...

此时浏览器控制台会报如下错误,这是因为 pinia 还没有挂载到 app 上。

Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图4

网上有些解决方案是直接实例化一个 pinia 实例,传递给 useDemoStore() 函数,如下:

...
import useDemoStore from '@/store/modules/demo'
import { storeToRefs } from 'pinia'
import pinia from '@/store'
...

const demoStore = useDemoStore(pinia)
const { counter } = storeToRefs(demoStore)

...

这样做,浏览器控制台不报错了,页面也可以正常加载,路由切换时,控制台会输出当前 counter 的值。

但是如果刷新浏览器,counter 的值又被初始化为 0,貌似前面设置的持久化插件 pinia-plugin-persistedstate 失效了。那应该怎么处理呢?

3.3 正确的处理方式

上面这种传递 pinia 对象给 useDemoStore() 函数只是一种野路子,pinia 官网已经清楚写明组件外应该如何使用 pinia:
Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用插图5
在钩子函数外,pinia 还没有被挂载,但是在前置守卫函数中,pinia 已经被挂载了,所以获取全局状态,需要在钩子函数中进行,正确的实现如下:

import router from '@/router'
import nProgress from 'nprogress'
import 'nprogress/nprogress.css'
import useDemoStore from '@/store/modules/demo'
import { storeToRefs } from 'pinia'

nProgress.configure({
  showSpinner: false
})

// 全局前置守卫
router.beforeEach((to, from) => {
  nProgress.start()

  const demoStore = useDemoStore()
  const { counter } = storeToRefs(demoStore)
  // 从 store 中获取其他值,再决定返回值
  // 这里演示获取 store 中 counter 的值
  console.log(counter:${counter.value})
  return true
})

// 全局后置钩子
router.afterEach(() => {
  nProgress.done(true)
})

文中 demo 在 github 上搜索 vue3-vite-archetypemain 分支可以直接 yarn dev 启动运行; template 分支是 yyg-cli 执行 yyg create 创建项目时拉取的模板。你也可以先执行 npm install -g yyg-cli 安装 yyg-cli 脚手架工具,然后通过 yyg create xxx 创建项目,创建后的项目包含了 vue3 vite 的全部demo。

文章来源于互联网:Vue3 Vite3 状态管理 pinia 基本使用、持久化、在路由守卫中的使用

THE END
分享
二维码