pinia數(shù)據(jù)持久化存儲(chǔ)插件 pinia-plugin-persist

方便追蹤與調(diào)試 state,支持 Composition API 定義 store涌献,支持 HMR胚宦,支持 Plugin 擴(kuò)展

其核心的 defineStore API,讓我覺(jué)得它可以摒棄之前 Vuex 的全局集中狀態(tài)管理的思想燕垃,利用 Vue 3 的 Composition 特性枢劝,提供隨處按需定義小型 store 的能力。
這讓我們更加容易編寫和管理很多不同模塊的 store卜壕,提高代碼可讀性您旁,也讓 store 更容易的擴(kuò)展。

如何持久化轴捎?

在某些特定的單頁(yè)面應(yīng)用場(chǎng)景下鹤盒,我們使用常規(guī)的 store 來(lái)存儲(chǔ)數(shù)據(jù),很多時(shí)候面臨著刷新就會(huì)被重置侦副,所以侦锯,我們急需一個(gè)插件功能來(lái)實(shí)現(xiàn)對(duì)某些特定的數(shù)據(jù)進(jìn)行狀態(tài)保持。

這里我們很容易想到可以用 sessionStorage 或者 localStorage 來(lái)進(jìn)行相應(yīng)的處理秦驯,但是要對(duì)不同的 store 中不同的字段進(jìn)行處理
pinia-plugin-persist它提供了簡(jiǎn)便的使用方式以及靈活的配置方式尺碰,下面我就和大家分享一下這款插件的使用方式及實(shí)現(xiàn)原理。

安裝

1、 npm
npm install pinia-plugin-persist
2亲桥、 yarn
yarn add pinia-plugin-persist
3洛心、 pnpm
pnpm add pinia-plugin-persist

配置setup

vue2
import Vue from 'vue'
import vueCompositionApi from '@vue/composition-api'
import { createPinia } from 'pinia'
import piniaPersist from 'pinia-plugin-persist'

const pinia = createPinia()
pinia.use(piniaPersist)

Vue.use(vueCompositionApi)
Vue.use(pinia)
vue3
import { createApp } from 'vue'
import { createPinia } from 'pinia'
import piniaPersist from 'pinia-plugin-persist'

const pinia = createPinia()
pinia.use(piniaPersist)
createApp({})
  .use(pinia)
  .mount('#app')
Typescript definitions

將pinia-plugin-persist類型定義文件添加到您的 tsconfig 文件中。

{
  "compilerOptions": {
    "types": [
      "pinia-plugin-persist"
    ]
  },
}

高級(jí)用法

基本用法忽略
在store文件夾中創(chuàng)建index.ts
paths默認(rèn)情況下题篷,整個(gè)狀態(tài)都會(huì)被持久化词身,但是您可以通過(guò)在每個(gè)策略中設(shè)置鍵來(lái)指定想要持久化的狀態(tài)鍵。
在此示例中番枚,我們將firstName和保存lastName在 sessionStorage 中偿枕,并保存accessToken在 localStorage 中。


1.png
import { defineStore} from 'pinia'
export const useUserStore = defineStore('storeUser', {
  state () {
    return {
      firstName: 'S',
      lastName: 'L',
      accessToken: 'xxxxxxxxxxxxx',
    }
  },
  persist: {
    enabled: true,//開啟存儲(chǔ)
    strategies: [// 指定存儲(chǔ)的位置以及存儲(chǔ)的變量都有哪些户辫,該屬性可以不寫渐夸, // 在不寫的情況下,默認(rèn)存儲(chǔ)到sessionStorage 里面渔欢,默認(rèn)存儲(chǔ)state里面的所有數(shù)據(jù)墓塌。

      { storage: sessionStorage, paths: ['firstName', 'lastName'] },
      { storage: localStorage, paths: ['accessToken'] },
    ],
  },
  actions: {
    //存儲(chǔ)登錄頁(yè)面的用戶和token
     async piniaLogin(params: any) {
        await login(params).then((res: any) => {
            if (res.code == 200) {
                this.token = res.data.token
                this.username = res.data.account
            }else if(res.code == 422){
                ElMessage.error('賬號(hào)或密碼不對(duì),請(qǐng)檢查賬號(hào)密碼')
            }
        });
    }
  }
})

登錄頁(yè)login.vue

// Pinia
import { useUserStore } from "@/store/index";
const store = testStore();
const submitForm = async (formEl: FormInstance | undefined) => {
  if (!formEl) return;
  await formEl.validate((valid) => {
    if (valid) {
      store.piniaLogin(ruleForm.value);
      console.log(ruleForm.value);
  
      setTimeout(() => {
        router.push("/");
        ElMessage({ message: "登陸成功奥额!", type: "success" });
      }, 1000);
      isLoading.value = false;
    }
  });
};
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末苫幢,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子垫挨,更是在濱河造成了極大的恐慌韩肝,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,470評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件九榔,死亡現(xiàn)場(chǎng)離奇詭異哀峻,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)哲泊,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,393評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門剩蟀,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人切威,你說(shuō)我怎么就攤上這事育特。” “怎么了先朦?”我有些...
    開封第一講書人閱讀 162,577評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵缰冤,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我喳魏,道長(zhǎng)棉浸,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,176評(píng)論 1 292
  • 正文 為了忘掉前任截酷,我火速辦了婚禮涮拗,結(jié)果婚禮上乾戏,老公的妹妹穿的比我還像新娘迂苛。我一直安慰自己三热,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,189評(píng)論 6 388
  • 文/花漫 我一把揭開白布三幻。 她就那樣靜靜地躺著就漾,像睡著了一般。 火紅的嫁衣襯著肌膚如雪念搬。 梳的紋絲不亂的頭發(fā)上抑堡,一...
    開封第一講書人閱讀 51,155評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音朗徊,去河邊找鬼首妖。 笑死,一個(gè)胖子當(dāng)著我的面吹牛爷恳,可吹牛的內(nèi)容都是我干的有缆。 我是一名探鬼主播,決...
    沈念sama閱讀 40,041評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼温亲,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼棚壁!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起栈虚,我...
    開封第一講書人閱讀 38,903評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤袖外,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后魂务,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體曼验,經(jīng)...
    沈念sama閱讀 45,319評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,539評(píng)論 2 332
  • 正文 我和宋清朗相戀三年粘姜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蚣驼。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,703評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡相艇,死狀恐怖颖杏,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情坛芽,我是刑警寧澤留储,帶...
    沈念sama閱讀 35,417評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站咙轩,受9級(jí)特大地震影響获讳,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜活喊,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,013評(píng)論 3 325
  • 文/蒙蒙 一丐膝、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦帅矗、人聲如沸偎肃。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,664評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)累颂。三九已至,卻和暖如春凛俱,著一層夾襖步出監(jiān)牢的瞬間紊馏,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,818評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工蒲犬, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留朱监,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,711評(píng)論 2 368
  • 正文 我出身青樓原叮,卻偏偏與公主長(zhǎng)得像赫编,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子篇裁,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,601評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容