Vue-Pinia简记

简介

Pinia是Vuex的升级版,使用比Vuex更加简单方便,同时支持Vue2.x和Vue3.x。Pinia是Vue的专属状态管理库,它允许你跨组件和页面共享状态。简单理解就是如果你有需要全组件都要共享访问和操作的数据,那么就用Pinia。

使用入门

安装包

npm install pinia

配置

import { createApp } from 'vue'
import { createPinia } from 'pinia'
import App from './App.vue'

const pinia = createPinia()
const app = createApp(App)

app.use(pinia)
app.mount('#app')

以上是适用于Vue3的,如果是Vue2还需要安装一个插件,并在应用的根部注入创建的pinia

import {defineStore} from 'pinia'

/**
 * 定义并到处容器
 * 参数1:容器的ID,必须唯一,将来Pinia会把所有的容器挂载到根容器
 * 参数2:选项对象
 * 返回值:一个函数,调用得到容器实例
 */
export const useCounterStore = defineStore('counter',{
    /**
     * 类似于组件的data,用来存储全局状态的
     * 1、必须是函数:这样是为了服务端渲染的时候避免交叉请求导致数据状态的污染
     * 2、必须是箭头函数,为了更好的TS类型推导
     */
    state:() => {
        return {
            count:0
        }
    },

    /**
     * 类似于组件的computed,用来封装计算属性,有缓存的功能
     */
    getters:{
        double:(state) => state.count * 2
    },

    /**
     * 类似于组件的methods,封装业务逻辑,修改state
     */
    actions:{
        increment(){
            this.count++
        }
    }
})

以上是展示的Option Store方式创建Store,还有一种就和setup函数类似的Setup Store创建方式:

坑点

  • 不要直接解构state,因为state原理就是使用reactive进行封装,所以reactive有的缺点它也有(比如解构后失去响应性)。如果先使用解构方式访问,Pinia提供了storeToRefs()
  • 不能在 actions中定义箭头函数,this的指向会混乱。
  • getterscomputed类似,对数据会有缓存,没有改变时多次调用都会调用缓存的数据。

使用

  • state的基本使用
<script setup>
import { useCounterStore } from "../../store/index";

const mainstore = useCounterStore()


const handleChangeState = () => {
    //方式一,最简单的方式
    mainstore.count++
    //方式二,需要修改多个数据,建议使用$patch 批量更新(内部有性能优化)
    mainstore.$patch({
        count: mainstore.count + 1,
        message:'changed info',
        arr:[...mainstore.arr,66]
    })
    //方式三:$patch一个函数,更好的批量更新方式
    mainstore.$patch(state => {
        state.count++
        state.message = 'info3'
        state.arr.push(99)
    })
}
</script>

以上方法都可以放到actions中做处理,同样可以通过this.$patch的方式批量操作状态

  • getters的使用
  • actions的使用

类似getters,不同的是,action可以是异步的,可以在里面await调用任何API,以及其他的action。

访问其他store上的action

  • 订阅Action(store.$onAction()

可以通过store.$Action()来监听action和它们的结果。传递给它的回调函数会在action本身之前执行。
after表示在promise解决之后,允许你在action解决后执行一个回调函数。
onError允许你在action抛出错误或reject时执行一个回调函数。
这些函数对于追踪运行时错误非常有用。

const unsubscribe = someStore.$onAction(
  ({
    name, // action 名称
    store, // store 实例,类似 `someStore`
    args, // 传递给 action 的参数数组
    after, // 在 action 返回或解决后的钩子
    onError, // action 抛出或拒绝的钩子
  }) => {
    // 为这个特定的 action 调用提供一个共享变量
    const startTime = Date.now()
    // 这将在执行 "store "的 action 之前触发。
    console.log(`Start "${name}" with params [${args.join(', ')}].`)

    // 这将在 action 成功并完全运行后触发。
    // 它等待着任何返回的 promise
    after((result) => {
      console.log(
        `Finished "${name}" after ${
          Date.now() - startTime
        }ms.\nResult: ${result}.`
      )
    })

    // 如果 action 抛出或返回一个拒绝的 promise,这将触发
    onError((error) => {
      console.warn(
        `Failed "${name}" after ${Date.now() - startTime}ms.\nError: ${error}.`
      )
    })
  }
)

// 手动删除监听器
unsubscribe()

默认情况下,action订阅器会被绑定到添加它们的组件上(如果store在组件的setup()内)。这意味着,当组件被卸载时,它们将被自动删除。如果你想在组件卸载时依旧保留它们,就将true作为第二个参数传递给action订阅器,以便将其从当前组件中分离:

<script setup>
const someStore = useSomeStore()
// 此订阅器即便在组件卸载之后仍会被保留
someStore.$onAction(callback, true)
</script>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容