Skip to main content

Pinia

官方文档：Introduction | Pinia (vuejs.org)

安装​

npm install pinia

创建 Store​

在 src/store 中创建 index.ts，并导出 store

src/store/index.ts
import { createPinia } from 'pinia'

const store = createPinia()

export default store

在 main.ts 中引入并使用

main.ts
import { createApp } from 'vue'
import App from './App.vue'
import store from './store'

const app = createApp(App)
app.use(store)

创建 modules​

在 src/store 目录下创建 modules 目录，里面存放项目中所需要使用到的状态。演示代码如下

store/modules/user.ts
import { defineStore } from 'pinia'

interface UserState {
  name: string
}

export const useUserStore = defineStore({
  id: 'user',
  state: (): UserState => {
    return {
      name: 'kuizuo',
    }
  },
  getters: {
    getName(): string {
      return this.name
    },
  },
  actions: {
    setName(name: string) {
      this.name = name
    },
  },
})

使用​

获取 state​

<template>
  <div>{{ userStore.name }}</div>
</template>

<script lang="ts" setup>
import { useUserStore } from '/@/store/modules/user'

const userStore = useUserStore()
</script>

不过这样写法不优雅，就可以使用 computed

const name = computed(() => userStore.getName) // 前提定义了getters
const name = computed(() => userStore.name)

state 也可以使用解构，但使用解构会使其失去响应式，这时候可以用 pinia 的 storeToRefs。

import { storeToRefs } from 'pinia'
const { name } = storeToRefs(userStore)

修改 state​

可以直接使用userStore.name = "xxx" 来进行修改，但不建议，而是使用 actions 来修改，在上面已经定义一个 setName 方法用来修改 state

userStore.setName('xxx')

与 vuex 对比​

不难发现，pinia 比 vuex 少了个mutations，也就是变更状态的函数，而 pinia 则是将其与 action 合并在一起。

在 Vuex 中 mutation 是无法异步操作的，而 Action 可以包含任意异步操作。像上面要写异步操作的只需要在 actions 中正常的编写 async await 语法的异步函数即可。如

export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(user) {
      const { data } = await api.login(user)
      return data
    },
  },
})

而 vuex 中写法与调用就不堪入目了 😂

数据持久化​

安装

npm i pinia-plugin-persistedstate

使用

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

const store = createPinia()
store.use(piniaPluginPersist)

export default store

在对应的 store 中开启 persist 即可，默认情况下数据是存放在 sessionStorage(会话存储)，并以 store 中的 id 作为 key

export const useUserStore = defineStore({
  id: 'user',
  state: (): UserState => {
    return {
      name: 'kuizuo',
    }
  },
  persist: {
    enabled: true,
  },
})

persist 还有其他配置，例如自定义 key，存放位置改为 localStorage

persist: {
	enabled: true,
	strategies: [
		{
			key: 'my_user',
			storage: localStorage
		}
	]
}

还可以使用 paths 来指定那些 state 持久化，如下

persist: {
  enabled: true,
  strategies: [
    {
      paths: ['name']
    }
  ]
}
0%