pinia 入門及使用

2022-07-24 18:01:47

自上月從上海結束工作回來 在家閒來無事 想寫點東西打發時間 也順便學習學習新的技術。偶然發現了 pinia 據說比vuex好用些 所以便搭了個demo嘗試著用了下 感覺確實不錯,於是便有了這篇隨筆。

那麼廢話不多說 直接開始吧。(附pinia官網地址:https://pinia.web3doc.top/)

1.安裝

yarn add pinia
# 或者使用 npm
npm install pinia

2.專案中引入

  vue2引入方法(直接複製官網的)

import { createPinia, PiniaVuePlugin } from 'pinia'

Vue.use(PiniaVuePlugin)
const pinia = createPinia()

new Vue({
  el: '#app',
  // 其他選項...
  // ...
  // 注意同一個 `pinia` 範例可以在多個 Vue 應用程式中使用
  // 同一個頁面
  pinia,
})

  vue3引入方法 (引入createPinia函數後範例化下 然後直接掛載到vue的use函數即可)

import { createPinia } from 'pinia'
const pinia = createPinia()
createApp(App).use(pinia).mount('#app')

3.定義一個 Store

  在src目錄下新建 store 目錄 然後新建一個js或者ts檔案 然後匯入pinia的 defineStore 函數  函數的第一個引數是當前store的 id 相當於key 第二個是一個物件 裡面就是我們存放資料的地方了  

 export default 預設匯出是為了方便我們其他頁面參照這個store 這樣 一個store就定義好了
export default defineStore('defaultStore',{
    state:()=>{
        return {
            count:1
        }
    },
    getters:{

    },
    actions:{
        setCount(){
            this.count++
        }
    }

})

4.使用store

定義好了之後 那就是怎麼使用我們的store了

<template>
  <div class="root-box">
    count == {{store.count}} //3.然後就可以直接使用了
  </div>
</template>

<script setup lang="ts">
import defaultStore from "./../../store"; //1.引入我們剛剛定義的store
import {onMounted} from 'vue' const store = defaultStore()//2.範例化一下
onMounted(()=>{
  store.count++ //修改store的值
})
</script>

可能有人想問 能不能不用store.count呢 可不可以直接解構賦值。答案是可以的

但是不能直接解構賦值 不然會失去資料的響應性的 我們應該使用pinia提供的 storeToRefs 函數來進行解構

<script setup lang="ts">
import defaultStore from "./../../store";
import { storeToRefs } from "pinia";
const store = defaultStore()
const { count } = storeToRefs(store) 
</script>

5.getters&actions

 和vuex一樣 pinia裡 getters是用於獲取store的資料的 actions是用來操作store的資料的

  

getters:{
        getCount(state){
            return state.count
        }
    },
    actions:{
        setCount(){
            this.count++
        }
    }

與上文中直接 store.count 不同。使用getters獲取資料時 你可以在獲取到資料前對資料進行一些操作。 例:一個陣列或一個物件 你想在獲取前剔除掉某些不符合要求的資料之類的。

actions同理。

使用過vuex的朋友一定看出了 pinia 其實很多地方和vuex很相似。有使用過vuex經驗的人能夠非常輕鬆的上手這個全新的vue儲存庫,並且寫法上比vuex更加簡便快捷 更加的容易理解

6.使用上的拓展

  除了上述的 store.count的直接修改 和 actions以外 官方還提供了其他幾種修改資料的方法

//通過$patch 傳入物件 可以一次性修改多個資料
store.$patch({ count: store.count
+ 1, })
// 傳入函數 這個可以讓你在修改資料前進行一些其他的操作 類似於一個單獨的actions
store.$patch((state) => {
  store.count = store.count + 1
})
// 也可以直接替換掉整個store
store.$state = { name: 'pinia' }