Pinia入門學習之實現(xiàn)簡單的用戶狀態(tài)管理
Store是什么?
全局狀態(tài),用于在所有組件中,同步數(shù)據(jù)。
Store的應用場景?
在整個應用程序中訪問的數(shù)據(jù)(且不需要被持久化),例如導航欄中顯示的用戶信息,以及需要通過頁面保留的數(shù)據(jù),例如一個非常復雜的多步驟表格。
pinia是什么?
簡單一句介紹,vuex的升級版,拋棄了煩人的Mutation。
其他優(yōu)點
- action支持同步和異步;
- 良好的TypeScript支持;
- 支持用插件擴展功能;
- 扁平架構(gòu),沒有嵌套;
- 服務(wù)端渲染支持。
應用示例
下面我們以一個管理平臺的員工賬號信息為例,展示Pinia的使用方式。
本文作者認為setup是更好的組織代碼的方式,所以都用setup編寫下面的示例。
安裝和掛載部分,直接看文檔。
定義Store
import { defineStore } from 'pinia'
// 第一個參數(shù)是應用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
// other options...
})使用Store
import { useUserStore } from '@/stores/user'
export default {
setup() {
const userStore = useUserStore()
return {
// 您可以返回整個 store 實例以在模板中使用它
userStore,
}
},
}(如果習慣用選項式API,還是可以配合map helpers,聲明各種map來訪問store。)
獲取store的響應式數(shù)據(jù)
直接解構(gòu)會破壞響應式,需要用storeToRefs()提取屬性并保持響應式。
import { storeToRefs } from 'pinia'
export default defineComponent({
setup() {
const userStore = useUserStore()
// ? 這不起作用,因為它會破壞響應式
// 這和從 props 解構(gòu)是一樣的
const { userName } = userStore
// 這樣可以保持響應式
const { userId } = storeToRefs(userStore)
userName // "lucio"
userId // "001"
return {
// 一直會是 "lucio"
userName,
// 這將是響應式的
userId,
// 這將是響應式的
realUserName: computed(() => userStore.userName),
}
},
})State
返回初始狀態(tài)的函數(shù)。
我們補全一下上面的定義Store部分的代碼。
初始化
import { defineStore } from 'pinia'
// 第一個參數(shù)是應用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
state: () => {
return {
// 所有這些屬性都將自動推斷其類型
userName: 'lucio',
userId: '001',
}
},
})讀取和寫入state
- 通過store示例,可讀寫。
const userStore = useUserStore()
userStore.userId = '002'
userStore.$reset()
return { userStore }- 通過
$patch修改多個數(shù)據(jù),參數(shù)可以是對象或者函數(shù)。
// 一次修改多個數(shù)據(jù)
userStore.$patch({
userId: '002',
userName: 'lucy',
})
// 適合對數(shù)組進行修改
userStore.$patch((state) => {
state.roles.push({ name: 'admin', priority: 1 })
})- 替換整個state
userStore.$state = { userId: '002', userName: 'lucy'}
// 或者通過pinia實例替換整個應用程序的狀態(tài)
pinia.state.value = {}訂閱state變化
可以通過 store 的 $subscribe() 方法查看狀態(tài)及其變化,其只在patch之后觸發(fā)一次。
默認情況下,組件卸載后,訂閱會被刪除。如果想保留,設(shè)置配置項detached為true。
userStore.$subscribe((mutation, state) => {
// import { MutationType } from 'pinia'
mutation.type // 'direct' | 'patch object' | 'patch function'
// 與 userStore.$id 相同
mutation.storeId // 'user'
// 僅適用于 mutation.type === 'patch object'
mutation.payload // 補丁對象傳遞給 to userStore.$patch()
// 每當它發(fā)生變化時,將整個狀態(tài)持久化到本地存儲
localStorage.setItem('user', JSON.stringify(state))
},
{ detached: true }, // detached為true,卸載組件后保留訂閱
)Getters
返回狀態(tài)的計算值。
定義getter
import { defineStore } from 'pinia'
// 第一個參數(shù)是應用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
state: () => {
return {
// 所有這些屬性都將自動推斷其類型
userName: 'lucio',
userId: '001',
}
},
getters: {
// 自動推斷返回類型為字符串
userText: (state) => `User: ${state.userName}`,
// 也可以使用其他getter, 用this訪問store實例,必須要定義返回類型
userTextPlus: (): string => `The name of ${this.userText}`,
}
})訪問getter
直接用store的實例訪問。
userStore.userText
(getters也可以傳遞參數(shù),不是很常用的場景,這里就不示例了。)
(在A store中,也可以使用B store的getter)
Actions
相當于組件中的methods,適合用于定義組件的業(yè)務(wù)邏輯。
定義action
下面我們繼續(xù)補全上面的示例,在userStore中通過網(wǎng)絡(luò)請求獲取用戶數(shù)據(jù)。
import { defineStore } from 'pinia'
export const useUserStore = defineStore('user', {
state: () => {
return {
userName: 'lucio',
userId: '001',
userData: null,
}
},
getters: {
// ...
},
actions: {
async loginAndGetUserInfo(password) {
try {
this.userData = await api.login({password});
showToast('Login success');
} catch(error) {
showToast(error);
return error;
}
}
}
})訂閱action
可以使用 store.$onAction() 訂閱 action 及其結(jié)果。
下面對userStore添加一個訂閱,記錄上面的登陸操作,所用的時間
const unsubscribe = userStore.$onAction(
({
name, // action 的名字
store, // store 實例
args, // 調(diào)用這個 action 的參數(shù)
after, // 在這個 action 執(zhí)行完畢之后,執(zhí)行這個函數(shù)
onError, // 在這個 action 拋出異常的時候,執(zhí)行這個函數(shù)
}) => {
// 記錄開始的時間變量
const startTime = Date.now()
// 這將在 `store` 上的操作執(zhí)行之前觸發(fā)
console.log(`Start "${name}" with params [${args.join(', ')}].`)
// 如果 action 成功并且完全運行后,after 將觸發(fā)。
// 它將等待任何返回的 promise
after((result) => {
console.log(
`Finished "${name}" after ${
Date.now() - startTime
}ms.\nResult: ${result}.`
)
})
// 如果 action 拋出或返回 Promise.reject ,onError 將觸發(fā)
onError((error) => {
console.warn(
`Failed "${name}" after ${Date.now() - startTime}ms.\nError: ${error}.`
)
})
}
)
// 手動移除訂閱
unsubscribe()和訂閱state一樣,組件卸載時,訂閱將被刪除,可以添加設(shè)置第二個參數(shù)detach為true,在卸載組件后仍然保留訂閱。
export default {
setup() {
const someStore = useSomeStore()
// 此訂閱將在組件卸載后保留
someStore.$onAction(callback, true)
// ...
},
}總結(jié)
到此這篇關(guān)于Pinia入門學習之實現(xiàn)簡單的用戶狀態(tài)管理的文章就介紹到這了,更多相關(guān)Pinia用戶狀態(tài)管理內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Vue使用provide各種傳值后inject獲取undefined的問題及解決
這篇文章主要介紹了Vue使用provide各種傳值后inject獲取undefined的問題及解決,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-08-08
使用vue-antDesign menu頁面方式(添加面包屑跳轉(zhuǎn))
這篇文章主要介紹了使用vue-antDesign menu頁面方式(添加面包屑跳轉(zhuǎn)),具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-01-01

