Pinia入門學(xué)習(xí)之實(shí)現(xiàn)簡(jiǎn)單的用戶狀態(tài)管理
Store是什么?
全局狀態(tài),用于在所有組件中,同步數(shù)據(jù)。
Store的應(yīng)用場(chǎng)景?
在整個(gè)應(yīng)用程序中訪問(wèn)的數(shù)據(jù)(且不需要被持久化),例如導(dǎo)航欄中顯示的用戶信息,以及需要通過(guò)頁(yè)面保留的數(shù)據(jù),例如一個(gè)非常復(fù)雜的多步驟表格。
pinia是什么?
簡(jiǎn)單一句介紹,vuex的升級(jí)版,拋棄了煩人的Mutation。
其他優(yōu)點(diǎn)
- action支持同步和異步;
- 良好的TypeScript支持;
- 支持用插件擴(kuò)展功能;
- 扁平架構(gòu),沒(méi)有嵌套;
- 服務(wù)端渲染支持。
應(yīng)用示例
下面我們以一個(gè)管理平臺(tái)的員工賬號(hào)信息為例,展示Pinia的使用方式。
本文作者認(rèn)為setup是更好的組織代碼的方式,所以都用setup編寫下面的示例。
安裝和掛載部分,直接看文檔。
定義Store
import { defineStore } from 'pinia'
// 第一個(gè)參數(shù)是應(yīng)用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
// other options...
})使用Store
import { useUserStore } from '@/stores/user'
export default {
setup() {
const userStore = useUserStore()
return {
// 您可以返回整個(gè) store 實(shí)例以在模板中使用它
userStore,
}
},
}(如果習(xí)慣用選項(xiàng)式API,還是可以配合map helpers,聲明各種map來(lái)訪問(wèn)store。)
獲取store的響應(yīng)式數(shù)據(jù)
直接解構(gòu)會(huì)破壞響應(yīng)式,需要用storeToRefs()提取屬性并保持響應(yīng)式。
import { storeToRefs } from 'pinia'
export default defineComponent({
setup() {
const userStore = useUserStore()
// ? 這不起作用,因?yàn)樗鼤?huì)破壞響應(yīng)式
// 這和從 props 解構(gòu)是一樣的
const { userName } = userStore
// 這樣可以保持響應(yīng)式
const { userId } = storeToRefs(userStore)
userName // "lucio"
userId // "001"
return {
// 一直會(huì)是 "lucio"
userName,
// 這將是響應(yīng)式的
userId,
// 這將是響應(yīng)式的
realUserName: computed(() => userStore.userName),
}
},
})State
返回初始狀態(tài)的函數(shù)。
我們補(bǔ)全一下上面的定義Store部分的代碼。
初始化
import { defineStore } from 'pinia'
// 第一個(gè)參數(shù)是應(yīng)用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
state: () => {
return {
// 所有這些屬性都將自動(dòng)推斷其類型
userName: 'lucio',
userId: '001',
}
},
})讀取和寫入state
- 通過(guò)store示例,可讀寫。
const userStore = useUserStore()
userStore.userId = '002'
userStore.$reset()
return { userStore }- 通過(guò)
$patch修改多個(gè)數(shù)據(jù),參數(shù)可以是對(duì)象或者函數(shù)。
// 一次修改多個(gè)數(shù)據(jù)
userStore.$patch({
userId: '002',
userName: 'lucy',
})
// 適合對(duì)數(shù)組進(jìn)行修改
userStore.$patch((state) => {
state.roles.push({ name: 'admin', priority: 1 })
})- 替換整個(gè)state
userStore.$state = { userId: '002', userName: 'lucy'}
// 或者通過(guò)pinia實(shí)例替換整個(gè)應(yīng)用程序的狀態(tài)
pinia.state.value = {}訂閱state變化
可以通過(guò) store 的 $subscribe() 方法查看狀態(tài)及其變化,其只在patch之后觸發(fā)一次。
默認(rèn)情況下,組件卸載后,訂閱會(huì)被刪除。如果想保留,設(shè)置配置項(xiàng)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 // 補(bǔ)丁對(duì)象傳遞給 to userStore.$patch()
// 每當(dāng)它發(fā)生變化時(shí),將整個(gè)狀態(tài)持久化到本地存儲(chǔ)
localStorage.setItem('user', JSON.stringify(state))
},
{ detached: true }, // detached為true,卸載組件后保留訂閱
)Getters
返回狀態(tài)的計(jì)算值。
定義getter
import { defineStore } from 'pinia'
// 第一個(gè)參數(shù)是應(yīng)用程序中 store 的唯一 id
export const useUserStore = defineStore('user', {
state: () => {
return {
// 所有這些屬性都將自動(dòng)推斷其類型
userName: 'lucio',
userId: '001',
}
},
getters: {
// 自動(dòng)推斷返回類型為字符串
userText: (state) => `User: ${state.userName}`,
// 也可以使用其他getter, 用this訪問(wèn)store實(shí)例,必須要定義返回類型
userTextPlus: (): string => `The name of ${this.userText}`,
}
})訪問(wèn)getter
直接用store的實(shí)例訪問(wèn)。
userStore.userText
(getters也可以傳遞參數(shù),不是很常用的場(chǎng)景,這里就不示例了。)
(在A store中,也可以使用B store的getter)
Actions
相當(dāng)于組件中的methods,適合用于定義組件的業(yè)務(wù)邏輯。
定義action
下面我們繼續(xù)補(bǔ)全上面的示例,在userStore中通過(guò)網(wǎng)絡(luò)請(qǐng)求獲取用戶數(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é)果。
下面對(duì)userStore添加一個(gè)訂閱,記錄上面的登陸操作,所用的時(shí)間
const unsubscribe = userStore.$onAction(
({
name, // action 的名字
store, // store 實(shí)例
args, // 調(diào)用這個(gè) action 的參數(shù)
after, // 在這個(gè) action 執(zhí)行完畢之后,執(zhí)行這個(gè)函數(shù)
onError, // 在這個(gè) action 拋出異常的時(shí)候,執(zhí)行這個(gè)函數(shù)
}) => {
// 記錄開始的時(shí)間變量
const startTime = Date.now()
// 這將在 `store` 上的操作執(zhí)行之前觸發(fā)
console.log(`Start "${name}" with params [${args.join(', ')}].`)
// 如果 action 成功并且完全運(yùn)行后,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}.`
)
})
}
)
// 手動(dòng)移除訂閱
unsubscribe()和訂閱state一樣,組件卸載時(shí),訂閱將被刪除,可以添加設(shè)置第二個(gè)參數(shù)detach為true,在卸載組件后仍然保留訂閱。
export default {
setup() {
const someStore = useSomeStore()
// 此訂閱將在組件卸載后保留
someStore.$onAction(callback, true)
// ...
},
}總結(jié)
到此這篇關(guān)于Pinia入門學(xué)習(xí)之實(shí)現(xiàn)簡(jiǎn)單的用戶狀態(tài)管理的文章就介紹到這了,更多相關(guān)Pinia用戶狀態(tài)管理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
關(guān)于Element-ui中el-table出現(xiàn)的表格錯(cuò)位問(wèn)題解決
使用ElementUI的el-table后,偶然發(fā)現(xiàn)出現(xiàn)行列錯(cuò)位、對(duì)不齊問(wèn)題,下面這篇文章主要給大家介紹了關(guān)于Element-ui中el-table出現(xiàn)的表格錯(cuò)位問(wèn)題解決的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-07-07
Vue2項(xiàng)目升級(jí)到Vue3的詳細(xì)教程
看到好多開源項(xiàng)目都升級(jí)了vue3,下面這篇文章主要給大家介紹了關(guān)于Vue2項(xiàng)目升級(jí)到Vue3的相關(guān)資料,文中通過(guò)實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-01-01
vue實(shí)現(xiàn)圖片轉(zhuǎn)pdf的示例代碼
這篇文章主要為大家詳細(xì)介紹了vue實(shí)現(xiàn)圖片轉(zhuǎn)pdf的相關(guān)知識(shí),文中的示例代碼講解詳細(xì),具有一定的借鑒價(jià)值,需要的小伙伴可以跟隨小編一起了解一下2023-08-08
intellij?idea+vue前端調(diào)試配置圖文教程
在Vue項(xiàng)目開發(fā)過(guò)程中,當(dāng)遇到應(yīng)用邏輯出現(xiàn)錯(cuò)誤,但又無(wú)法準(zhǔn)確定位的時(shí)候,知曉Vue項(xiàng)目調(diào)試技巧至關(guān)重要,debug是必備技能,這篇文章主要給大家介紹了關(guān)于intellij?idea+vue前端調(diào)試配置的相關(guān)資料,需要的朋友可以參考下2024-09-09
一文解決vue2 element el-table自適應(yīng)高度問(wèn)題
在寫公司后臺(tái)項(xiàng)目的時(shí)候遇到一個(gè)需求,要求表格頁(yè)面不能有滾動(dòng)條,所以必須封裝一個(gè)公共方法來(lái)實(shí)現(xiàn)表格自適應(yīng)高度,本問(wèn)小編給大家介紹了如何解決vue2 element el-table自適應(yīng)高度問(wèn)題,需要的朋友可以參考下2023-11-11

