三分鐘開發一個 Vuex-Persistedstate，你學會了嗎？
Hello，大家好，我是 Sunday。
vuex-persistedstate 是一個 基于 vuex 的 狀態緩存工具 ，它可以讓我們 刷新頁面時持久化 state 中的狀態。
不過，這個庫在 3年前 已經 停止維護了，當它配合 Vue3 + Vuex4 進行使用時會出現一些奇怪的錯誤。
因此，在兩年前我簡單實現了一個 vuex-plugin-persistedstate 用于解決 Vue3 + Vuex4 的狀態持久化問題。實現了之后，就一直沒有管它。
讓我沒想到的是，昨天登錄 npm 發現竟然還有 200 多的下載量：
圖片
這證明大家對于 vuex-persistedstate 的需求存在的。
因此，今天就借助這個庫的代碼，講解下 vuex-persistedstate 的原理，讓大家也可以花 3 分鐘的時間 實現一個 vuex-persistedstate。
persistedstate 的原理
persistedstate 的原理其實非常簡單，核心是兩個點：
- 如何把 state 中的數據進行持久化
- 如何把持久化的數據賦值給 state
1.1 如何把 state 中的數據進行持久化
想要把 state 中的數據進行持久化，說白了就是：監聽 mutation 事件，在每次 mutation 修改數據后，同步數據到 localStorage 中
那么如何監聽 mutation 事件 呢？
根據 vuex 文檔描述，我們可以直接通過 store.subscribe 方法監聽 mutation 提交后的操作：
圖片
1.2 如何把持久化的數據賦值給 state
從 localStorage 中獲取數據非常簡單，問題在于 如何保證在刷新頁面后，從 localStorage 中獲取數據呢？
因為 vuex 本質上是一個單例的對象，該對象保存在內存中。即：只有頁面刷新時，vuex 才會重新執行初始化操作。
所以，根據這個概念，我們可知：只要執行了初始化操作，那么就以為著內存緩存消失，就需要從從 localStorage 中獲取數據了。
因此，我們只需要在 plugin 觸發時，讀取數據即可。
代碼實現
首先，創建一個基于 ts 的項目，大致結構如下（核心關注 src 中的代碼結構）：
圖片
根據結構可知，整體的代碼非常簡單（src 中的代碼）一共只有 4 個文件。
2.1 入口文件 index.ts
在 index.ts 中，我們需要按照 vuex-plugin 的要求，構建一個基本的函數。
根據原理中描述，我們需要再這里做兩件事情：
- 只要該函數執行，就從緩存中讀取數據
- 利用 store.subscribe 監聽 mutation 行為
import { Options, defaultOptions } from './core/options'
import { MutationPayload, Store } from 'vuex'
import { matchPaths } from './core/persistedstate'
let catchData: object = {}
export default function VuexPersistedstate<State>({
key = defaultOptions.key,
paths = defaultOptions.paths,
storage = defaultOptions.storage,
fetchBeforeUse = defaultOptions.fetchBeforeUse,
fetchBeforeUseFn = defaultOptions.fetchBeforeUseFn
}: Options<State> = defaultOptions) {
// 讀取緩存文件
if (fetchBeforeUse) {
catchData = fetchBeforeUseFn(key, storage)
}
return (store: Store<State>) => {
// 存儲緩存數據
for (const key in catchData) {
if (Object.prototype.hasOwnProperty.call(catchData, key)) {
const value = catchData[key]
store.commit(key, value)
}
}
// 每次 mutation 后接收通知
// { type, payload }
store.subscribe((mutation: MutationPayload, state: State) => {
if (matchPaths(paths, mutation)) {
catchData[mutation.type] = mutation.payload
storage.setItem(key, catchData)
}
})
}
}在這里，我們會用到 core 中的一些依賴庫。
2.2：options 可配置參數
core/options 中的代碼主要提供了 可配置參數，所以核心由 接口 + 默認配置對象 組成
import storage, { Storage } from './storage'
export interface Options<State> {
/**
* localStorage 保存的 key
*/
key: string
/**
* 緩存模塊名稱
* 不通過意味著緩存所有
* 僅傳遞指定的緩存
*/
paths: string[]
/**
* storage
*/
storage: Storage
/**
* 是否預取數據
*/
fetchBeforeUse: boolean
/**
* 預取數據的默認方法
*/
fetchBeforeUseFn: (key: string, storage: Storage) => any
}
export const defaultOptions: Options<object> = {
key: 'VUEX-PERSISTEDSTATE',
paths: [],
fetchBeforeUse: true,
fetchBeforeUseFn(key: string, storage: Storage) {
return storage.getItem(key)
},
storage
}2.3：storage 持久化邏輯
core/storage 中的代碼主要提供了 持久化邏輯，所以核心由 幾個溝通 localStorage 的方法 組成
export interface Storage {
getItem: (key: string) => object
setItem: (key: string, value: any) => void
removeItem: (key: string) => void
}
export const getItem = (key: string): object => {
const val = JSON.parse(window.localStorage.getItem(key) as string)
if (!val) {
return {}
}
return val.value || {}
}
export const setItem = (key: string, value: any) => {
let val: object = {
value
}
let valStr = JSON.stringify(val)
window.localStorage.setItem(key, valStr)
}
export const removeItem = (key: string) => {
window.localStorage.removeItem(key)
}
const storage: Storage = {
getItem,
setItem,
removeItem
}
export default storage2.4：persistedstate 匹配邏輯
因為 vuex 中提供了 module 的概念，所以在觸發 mutations 時可能會存在 路徑 的概念。
因此，需要在 core/persistedstate 中的進行路徑解析
import { MutationPayload } from 'vuex'
/**
* 確定當前匹配是否基于路徑的狀態
*/
export function matchPaths(
paths: string[],
mutation: MutationPayload
): boolean {
if (paths.length === 0) {
return true
}
const moduleName = mutation.type.split('/')[0]
if (!moduleName) {
return false
}
return paths.includes(moduleName)
}總結
那么到這里，一個極簡的 vuex-plugin-persistedstate 就實現完成了。足以滿足，大多數情況下的 vuex 持久化存儲邏輯。是不是非常簡單呢？
