Pinia.js狀態管理器上手使用指南

2022-07-07 14:01:47

前言

Pinia.js 是新一代的狀態管理器，由 Vue.js團隊中成員所開發的，因此也被認為是下一代的 Vuex，即 Vuex5.x，在 Vue3.0 的專案中使用也是備受推崇。

Pinia.js 有如下特點：

完整的 typescript 的支援；
足夠輕量，壓縮後的體積只有1.6kb;
去除 mutations，只有 state，getters，actions（這是我最喜歡的一個特點）；
actions 支援同步和非同步；
沒有模組巢狀，只有 store 的概念，store 之間可以自由使用，更好的程式碼分割；
無需手動新增 store，store 一旦建立便會自動新增；

安裝

npm install pinia --save

建立 Store

新建 src/store 目錄並在其下面建立 index.ts，匯出 store

// src/store/index.ts
import { createPinia } from 'pinia'
const store = createPinia()
export default store

在 main.ts 中引入並使用。

// src/main.ts
import { createApp } from 'vue'
import App from './App.vue'
import store from './store'
const app = createApp(App)
app.use(store)

State

定義State

在 src/store 下面建立一個user.ts

//src/store/user.ts
import { defineStore } from 'pinia'
export const useUserStore = defineStore({
  id: 'user', // id必填，且需要唯一
  state: () => {
    return {
      name: '張三'
    }
  }
})

獲取 state

<template>
  <div>{{ userStore.name }}</div>
</template>
<script lang="ts" setup>
import { useUserStore } from '@/store/user'
const userStore = useUserStore()
</script>

也可以結合 computed 獲取。

const name = computed(() => userStore.name)

state 也可以使用解構，但使用解構會使其失去響應式，這時候可以用 pinia 的 storeToRefs。

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

修改 state

可以像下面這樣直接修改 state

userStore.name = '李四'

但一般不建議這麼做，建議通過 actions 去修改 state，action 裡可以直接通過 this 存取。

export const useUserStore = defineStore({
  id: 'user',
  state: () => {
    return {
      name: '張三'
    }
  },
  actions: {
    updateName(name) {
      this.name = name
    }
  }
})

<script lang="ts" setup>
import { useUserStore } from '@/store/user'
const userStore = useUserStore()
userStore.updateName('李四')
</script>

Getters

export const useUserStore = defineStore({
 id: 'user',
 state: () => {
   return {
     name: '張三'
   }
 },
 getters: {
   fullName: (state) => {
     return state.name + '豐'
   }
 }
})

userStore.fullName // 張三丰

Actions

非同步 action

action 可以像寫一個簡單的函數一樣支援 async/await 的語法，讓你愉快的應付非同步處理的場景。

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

action 間相互呼叫

action 間的相互呼叫，直接用 this 存取即可。

 export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(account, pwd) {
      const { data } = await api.login(account, pwd)
      this.setData(data) // 呼叫另一個 action 的方法
      return data
    },
    setData(data) {
      console.log(data)
    }
  }
})

在 action 裡呼叫其他 store 裡的 action 也比較簡單，引入對應的 store 後即可存取其內部的方法了。

// src/store/user.ts
import { useAppStore } from './app'
export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(account, pwd) {
      const { data } = await api.login(account, pwd)
      const appStore = useAppStore()
      appStore.setData(data) // 呼叫 app store 裡的 action 方法
      return data
    }
  }
})

// src/store/app.ts
export const useAppStore = defineStore({
  id: 'app',
  actions: {
    setData(data) {
      console.log(data)
    }
  }
})

資料持久化

外掛 pinia-plugin-persist 可以輔助實現資料持久化功能。

安裝

npm i pinia-plugin-persist --save

使用

// src/store/index.ts
import { createPinia } from 'pinia'
import piniaPluginPersist from 'pinia-plugin-persist'
const store = createPinia()
store.use(piniaPluginPersist)
export default store

接著在對應的 store 裡開啟 persist 即可。

export const useUserStore = defineStore({
  id: 'user',
  state: () => {
    return {
      name: '張三'
    }
  },
  // 開啟資料快取
  persist: {
    enabled: true
  }
})

資料預設存在 sessionStorage 裡，並且會以 store 的 id 作為 key。

自定義 key

你也可以在 strategies 裡自定義 key 值，並將存放位置由 sessionStorage 改為 localStorage。

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

持久化部分 state

預設所有 state 都會進行快取，你可以通過 paths 指定要持久化的欄位，其他的則不會進行持久化。

state: () => {
  return {
    name: '張三',
    age: 18,
    gender: '男'
  }  
},
persist: {
  enabled: true,
  strategies: [
    {
      storage: localStorage,
      paths: ['name', 'age']
    }
  ]
}

上面我們只持久化 name 和 age，並將其改為localStorage, 而 gender 不會被持久化，如果其狀態傳送更改，頁面重新整理時將會丟失，重新回到初始狀態，而 name 和 age 則不會。