vuex5中的Pinia插件機制

更新時間：2022年07月21日 11:41:32 作者：神奇大叔

這篇文章主要介紹了vuex5中的Pinia插件機制，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

vuex5 Pinia插件機制

通過插件擴展

.給每個store添加公共屬性
.給stores添加新的配置
.給stores添加新的方法
.包裹重用已有方法
.改變或者取消actions
.應用額外的副作用像localstorage
.應用給指定的store

1、使用

import { createPinia } from 'pinia'
const pinia = createPinia()

(1)定義插件

function SecretPiniaPlugin(context) {
context.pinia; ?pina實例`createPinia()`
context.app; ?vue實例`createApp()`
context.store; ? 正在配置的store
context.options; ?store的配置`defineStore()`

(1)設置響應式數(shù)據(jù)

每個store都是reactive包裹的對象，所以使用起來可直接解套ref

context.store.hello = ref('secret');
context.store.hello;

(2)state添加數(shù)據(jù)

const globalSecret = ref('secret')

可直接添加

store.secret = globalSecret

通過$state,可獲得devtools追蹤、ssr中進行序列化

store.$state.secret = globalSecret

添加第三方數(shù)據(jù)，不要求響應式時，需要使用markRow進行轉(zhuǎn)換

store.router = markRaw(router)

(3)添加監(jiān)聽器

? store.$subscribe(() => {
? store改變時觸發(fā)
? })
? store.$onAction(() => {
? ? ?action觸發(fā)時觸發(fā)
? })
...
}

(2)應用插件

pinia.use(SecretPiniaPlugin)

(3)devTools能追蹤修改

方式一：返回修改的操作

pinia.use(({ store }) => ({
? store.hello = 'world'
}))

方式二：顯示添加

pinia.use(({ store }) => {
? store.hello = 'world'
? if (process.env.NODE_ENV === 'development') {
? ? store._customProperties.add('hello')
? }
})

2、應用

(1)給每個store添加公共state

function SecretPiniaPlugin() {
? return { secret: 'the cake is a lie' }
}
pinia.use(SecretPiniaPlugin)

(2)改寫store中的action

.此例為改寫成防抖action

defineStore('search', {
? actions: {
? ? searchContacts() {
? ? },
? },
? debounce: {
? ? searchContacts: 300,
? },
})

對于函數(shù)寫法的store，自定義選項放入第三個參數(shù)中

defineStore(
? 'search',
? () => {
? ? ...
? },
? {
? ? // this will be read by a plugin later on
? ? debounce: {
? ? ? // debounce the action searchContacts by 300ms
? ? ? searchContacts: 300,
? ? },
? }
)

插件中：

import debounce from 'lodash/debunce'
pinia.use(({ options, store }) => {
? if (options.debounce) {
??
? ? 將設置了debounce的store中的原action改寫成具有防抖功能的action
? ??
? ? return Object.keys(options.debounce).reduce((debouncedActions, action) => {
? ? ? debouncedActions[action] = debounce(
? ? ? ? store[action],
? ? ? ? options.debounce[action]
? ? ? )
? ? ? return debouncedActions
? ? }, {})
? }
})