Vue3中pinia的使用

5,376 阅读4分钟

1. 什么是Pinia呢?

  1. Pinia(发音为/piːnjʌ/,如英语中的“peenya” )是最接近piña(西班牙语中的菠萝)的词;
  • Pinia开始于大概2019年,最初是作为一个实验为Vue重新设计状态管理,让它用起来像组合式API(Composition API) 。
  • 从那时到现在,最初的设计原则依然是相同的,并且目前同时兼容Vue2、 Vue3,也并不要求你使用Composition API;
  • Pinia本质上依然是一个状态管理的库,用于跨组件、页面进行状态共享(这点和Vuex、 Redux一样);

2. Pinia和Vuex的区别

  1. 那么我们不是已经有Vuex了吗?为什么还要用Pinia呢?
  • Pinia 最初是为了探索 Vuex 的下一次迭代会是什么样子,结合了 Vuex 5 核心团队讨论中的许多想法;
  • 最终,团队意识到Pinia已经实现了Vuex5中大部分内容,所以最终决定用Pinia来替代Vuex
  • 与 Vuex 相比, Pinia 提供了一个更简单的 API,具有更少的仪式,提供了 Composition-API 风格的 API
  • 最重要的是,在与 TypeScript 一起使用时具有可靠的类型推断支持
  1. 和Vuex相比, Pinia有很多的优势:
  • 比如mutations 不再存在:
    • 他们经常被认为是 非常 冗长;
    • 他们最初带来了 devtools 集成,但这不再是问题;
  • 更友好的TypeScript支持, Vuex之前对TS的支持很不友好;
  • 不再有modules的嵌套结构:
    • 你可以灵活使用每一个store,它们是通过扁平化的方式来相互使用的;
  • 也不再有命名空间的概念,不需要记住它们的复杂关系; image.png

3. 如何使用pinia

  1. 安装pinia
npm install pinia
  1. 创建一个pinia并且将其传递给应用程序:
  • store下的index.js
import { createPinia } from 'pinia'
// 创建pinia
const pinia = createPinia();
export default pinia;
  • main.js中使用

image.png

  1. 在stores下创建counter.js,定义需要使用的数据
//定义的文件单独使用,不和index.js产生任何关系。
//定义属于counter的store
import { defineStore } from "pinia";//表示要定义store
//通过defineStore定义store,内部会自动管理store
const userCounter = defineStore("counter", {
    state: () => ({
        count: 99,
    }),
})
// 调用userCounter
export default userCounter;
  1. 直接使用

image.png

3.1 认识Store

  1. 什么是Store?
  • 一个 Store (如 Pinia)是一个实体,它会持有为绑定到你组件树的状态和业务逻辑,也就是保存了全局的状态;
  • 它有点像始终存在,并且每个人都可以读取和写入的组件;
  • 你可以在你的应用程序中定义任意数量的Store来管理你的状态;
  1. Store有三个核心概念:
  • state、 getters、 actions;
  • 等同于组件的data、 computed、 methods;
  • 一旦 store 被实例化,你就可以直接在 store 上访问 state、 getters 和 actions 中定义的任何属性;

3.2 定义一个Store

  1. 定义一个Store:
  • 我们需要知道 Store 是使用 defineStore() 定义的,
  • 并且它需要一个唯一名称,作为第一个参数传递; image.png
  1. 这个 name,也称为 id,是必要的, Pinia 使用它来将 store 连接到 devtools。
  2. 返回的函数统一使用useX作为命名方案,这是约定的规范;
  3. 使用定义的Store
  • 注意Store获取到后不能被解构,那么会失去响应式:
  • 为了从 Store 中提取属性同时保持其响应式,您需要使用storeToRefs()。 image.png

4. State的操作

4.1 方法一

  1. 读取和写入 state:
  2. 默认情况下,您可以通过 store 实例访问状态来直接读取和写入状态;

image.png

函数形式修改

image.png 3. 重置 State:

  • 你可以通过调用 store 上的 $reset() 方法将状态 重置 到其初始值;
function resetState() {
    // 重置state里面的数据
    userStore.$reset()
}

4.1 方法二

  1. 改变State:
  • 除了直接用 store.counter++ 修改 store,你还可以调用 $patch 方法;
  • 它允许您使用部分“state”对象同时应用多个更改;
function changeState() {
    //  2. 一次性修改多个
    userStore.$patch({
        name: 'kkk',
        age: 800,
    })
}
  1. 替换State:
  • 您可以通过将其 $state 属性设置为新对象来替换 Store 的整个状态:
function changeState() {
    // 3. 替换state
    userStore.$state = {
        name: 'curry',
        level: 2000,
    }
}

5. Getters的定义使用

5.1. Getters相当于Store的计算属性:

  • 它们可以用 defineStore() 中的 getters 属性定义;
  • getters中可以定义接受一个state作为参数的函数;

5.3. getters的使用

    1. 基本使用:访问当前store的Getters: image.png
    1. 一个getter使用另一个getter:我们可以通过this来访问到当前store实例的所有其他属性; image.png
  • 3.getters返回一个函数

image.png

  • 4.getters中用到别的store中的数据

image.png

6.认识和定义actions

6.1. Actions 相当于组件中的 methods。

  • 可以使用 defineStore() 中的 actions 属性定义,并且它们非常适合定义业务逻辑; image.png
  • 和getters一样,在action中可以通过this访问整个store实例的所有操作;

6.2.Actions执行异步操作

image.png