前言
Pinia.js 是新一代的狀態(tài)管理器，由 Vue.js團隊中成員所開發(fā)的无宿，因此也被認為是下一代的 Vuex茵汰，即 Vuex5.x，在 Vue3.0 的項目中使用也是備受推崇孽鸡。
Pinia.js 有如下特點：
- 完整的 typescript 的支持蹂午；
- 足夠輕量栏豺，壓縮后的體積只有1.6kb;
- 去除 mutations，只有 state豆胸，getters奥洼，actions（這是我最喜歡的一個特點）；
- actions 支持同步和異步晚胡；
- 沒有模塊嵌套灵奖，只有 store 的概念，store 之間可以自由使用估盘，更好的代碼分割桑寨；
- 無需手動添加 store，store 一旦創(chuàng)建便會自動添加忿檩；
安裝
npm install pinia --save
創(chuàng)建 Store
新建 src/store 目錄并在其下面創(chuàng)建 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 下面創(chuàng)建一個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>
也可以結(jié)合 computed 獲取沙咏。
const name = computed(() => userStore.name)
state 也可以使用解構(gòu)，但使用解構(gòu)會使其失去響應式班套，這時候可以用 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 可以像寫一個簡單的函數(shù)一樣支持 async/await 的語法，讓你愉快的應付異步處理的場景理盆。
export const useUserStore = defineStore({
id: 'user',
actions: {
async login(account, pwd) {
const { data } = await api.login(account, pwd)
return data
}
}
})
action 間相互調(diào)用
action 間的相互調(diào)用痘煤，直接用 this 訪問即可。
export const useUserStore = defineStore({
id: 'user',
actions: {
async login(account, pwd) {
const { data } = await api.login(account, pwd)
this.setData(data) // 調(diào)用另一個 action 的方法
return data
},
setData(data) {
console.log(data)
}
}
})
在 action 里調(diào)用其他 store 里的 action 也比較簡單猿规，引入對應的 store 后即可訪問其內(nèi)部的方法了衷快。
// 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) // 調(diào)用 app store 里的 action 方法
return data
}
}
})
// src/store/app.ts
export const useAppStore = defineStore({
id: 'app',
actions: {
setData(data) {
console.log(data)
}
}
})
數(shù)據(jù)持久化
插件 pinia-plugin-persist 可以輔助實現(xiàn)數(shù)據(jù)持久化功能。
安裝
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: '張三'
}
},
// 開啟數(shù)據(jù)緩存
persist: {
enabled: true
}
})
數(shù)據(jù)默認存在 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 不會被持久化，如果其狀態(tài)發(fā)送更改先誉，頁面刷新時將會丟失，重新回到初始狀態(tài)的烁，而 name 和 age 則不會褐耳。
最后
以上就是關(guān)于 Pinia.js 用法的一些介紹，Pinia.js 的內(nèi)容還遠不止這些渴庆，更多內(nèi)容及使用有待大家自己探索铃芦。Pinia文檔
作者：小學生study
鏈接：https://juejin.cn/post/7049196967770980389
來源：稀土掘金
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)襟雷，非商業(yè)轉(zhuǎn)載請注明出處刃滓。
