VUE最新状态管理工具

大家好，我是程序视点的小二哥!

前言

在VUE项目开发中，一些数据常常被多个组件频繁使用，为了管理和维护这些数据，就出现了状态管理模式。

今天小二哥要给大家推荐的不是VueX，而是称为新一代的状态管理工具的Pinia.js。

关于`Pinia.js`

Pinia.js 由 Vue.js团队成员所开发的，是新一代的 Vuex，即 Vuex5.x，在 Vue3.0 项目的使用中备受推崇。

它已经加入官方团队了哦！

`Pinia.js` 定位和特点：

完整的 typescript 的支持；
极其轻量，压缩后的体积只有1.6kb;
去除 mutations，只有 state，getters，actions（这是我最喜欢的一个特点）；
actions 支持同步和异步；
没有模块嵌套，只有 store 的概念，能够构建多个 store，store 之间可以*使用，更好的代码分割；
关联 Vue Devtools 钩子，提供更好地开发体验；

使用

安装脚手架vite

首先确保使用的脚手架是vite

// 安装vite
 npm init vite@latest

安装依赖

npm install pinia --save

以上安装完成之后，可以在项目根目录的package.json文件内找到相关的信息(部分片段)：

 {
  "dependencies": {
   "pinia": "^2.0.11",
   "vue": "^3.2.25"
  },
  "devDependencies": {
   "@vitejs/plugin-vue": "^2.2.0",
   "vite": "^2.8.0"
  }
 }

优化改造

因为需要在整个项目使用状态管理，因此需要在main.js文件里配置，以使它应用到整个应用(app)：

 // main.js
 import { createApp } from 'vue'
 import App from './App.vue'
 // 导入构造函数
 import { createPinia } from 'pinia'
 // 实例化 Pinia
 const pinia = createPinia()
 // 创建Vue应用实例app
 const app = createApp(App)
 // 应用以插件形式挂载Pinia实例
 app.use(pinia)
 app.mount('#app')

定义状态仓库

 // src/store/index.js
 // 引入仓库定义函数
 import { defineStore } from 'pinia'
 // 传入2个参数，定义仓库并导出
 // 第一个参数唯一不可重复，字符串类型，作为仓库ID以区分仓库
 // 第二个参数，以对象形式配置仓库的state,getters,actions
 // 配置 state getters actions
 export const mainStore = defineStore('main', {
   // state 类似组件的data选项，函数形式返回对象
   state: () => {
     return {
       msg: '程序视点',
       counter: 0
     }
   },
   getters: {},
   actions: {}
 })

类似vuex，单独一个文件定义状态仓库并导出读取仓库内状态并改变在需要使用状态的组件内需要先导入状态仓库：

 import { mainStore } from "../store/index.js";

再实例化仓库函数：

 const store = mainStore();

即可使用。举个栗子：

 <template>
   <button @click="handleClick">修改状态数据</button>
    <!-- 模板内不需要加.value -->
     <p>{{store.counter}}</p>
     <!-- 或者使用解构之后的 -->
     <p>{{counter}}</p>
 </template>
 
 <script setup>
 // 导入状态仓库
 import { mainStore } from "../store/index.js";
 // 使普通数据变响应式的函数  
 import { storeToRefs } from "pinia";
 // 实例化仓库
 const store = mainStore();
 // 解构并使数据具有响应式
 const { counter } = storeToRefs(store);
 
 // 点击 + 1;
 function handleClick() {
   // ref数据这里需要加.value访问
   counter.value++;
 }
 </script>

可以像下面这样直接修改 state,但一般不建议这么做。

store.counter += 1;

其他改变方式

通过 `actions` 去修改 `state`

action 里可以直接通过 this 访问。

export const mainStore = defineStore('main', {
   // state 类似组件的data选项，函数形式返回对象
   state: () => {
     return {
       msg: '程序视点',
       counter: 0
     }
   },
   getters: {},
   actions: {
     updateCount(){
       this.counter += 1;
     }
   }
 })

<script lang="ts" setup>
import { mainStore } from "../store/index.js";
const store = mainStore();

userStore.updateCount();
</script>

$patch

前面介绍的是少量数据的变更，如果涉及数据比较多，则推荐使用仓库实例的$patch方法，批量修改，虽然看起来和前面的几乎没有区别，但是会加快修改速度，对程序的性能有很大的好处。$patch传入一个对象，对象的属性就是各种状态。

<template> <button @click="handleClick">修改状态数据</button> <p>{{msg}}</p>  <p>{{counter}}</p> </template> <script setup> // 导入状态仓库 import { mainStore } from "../store/index.js"; // 使普通数据变响应式的函数
import { storeToRefs } from "pinia"; // 实例化仓库 const store = mainStore(); // 解构并使数据具有响应式 const { msg,counter } = storeToRefs(store); // 点击 + 1;修改字符串 function handleClick() { store.$patch({ msg: "pinia good!", counter: counter.value + 1, }); } </script> 函数形式上面例子中的$patch也可以传入一个函数，函数参数为state状态：

<template> <button @click="handleClick">修改状态数据</button> <p>{{msg}}</p>  <p>{{counter}}</p> </template>

创建 `Store`

新建 src/store 目录并在其下面创建 index.ts，引入Pinia，创建并导出 store。

// src/store/index.ts

import { createPinia } from 'pinia'

const store = createPinia()

export default store

在 main.ts 中引入并使用。

// src/main.ts

import { createApp } from 'vue'
import App from './App.vue'
import store from './store'

const app = createApp(App)
app.use(store)

`State`定义和使用

定义`State`

在 src/store 下面创建一个user.ts

//src/store/user.ts

import { defineStore } from 'pinia'

export const useUserStore = defineStore({
  id: 'user', // id必填，且需要唯一
  state: () => {
    return {
      name: '张三'
    }
  }
})

获取`state`

<template>
  <div>{{ userStore.name }}</div>
</template>

<script lang="ts" setup>
import { useUserStore } from '@/store/user'

const userStore = useUserStore()
</script>

也可以结合 computed 获取。

const name = computed(() => userStore.name)

state 也可以使用解构，但使用解构会使其失去响应式，这时候可以用 pinia 的 storeToRefs，它会对解构的数据处理起到响应式的效果。

import { storeToRefs } from 'pinia'
const { name } = storeToRefs(userStore)

修改 `state`

可以像下面这样直接修改 state,但一般不建议这么做。

userStore.name = '李四'

建议通过 actions 去修改 state，action 里可以直接通过 this 访问。

export const useUserStore = defineStore({
  id: 'user',
  state: () => {
    return {
      name: '张三'
    }
  },
  actions: {
    updateName(name) {
      this.name = name
    }
  }
})

<script lang="ts" setup>
import { useUserStore } from '@/store/user'

const userStore = useUserStore()
userStore.updateName('李四')
</script>

`Getters`

类似vuex的计算属性，获取状态机中的数据，且可以加工后返回。

export const useUserStore = defineStore({
 id: 'user',
 state: () => {
   return {
     name: '张三'
   }
 },
 getters: {
   fullName: (state) => {
     return state.name + '丰'
   }
 }
})

userStore.fullName // 张三丰

`Actions`

异步 `action`

action 可以像写一个简单的函数一样支持 async/await 的语法，让你愉快的应付异步处理的场景。

export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(account, pwd) {
      const { data } = await api.login(account, pwd)
      return data
    }
  }
})

`action` 间相互调用

action 间的相互调用，直接用 this 访问即可。

 export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(account, pwd) {
      const { data } = await api.login(account, pwd)
      this.setData(data) // 调用另一个 action 的方法
      return data
    },
    setData(data) {
      console.log(data)
    }
  }
})

在 action 里调用其他 store 里的 action 也比较简单，引入对应的 store 后即可访问其内部的方法了。

// src/store/user.ts

import { useAppStore } from './app'
export const useUserStore = defineStore({
  id: 'user',
  actions: {
    async login(account, pwd) {
      const { data } = await api.login(account, pwd)
      const appStore = useAppStore()
      appStore.setData(data) // 调用 app store 里的 action 方法
      return data
    }
  }
})

// src/store/app.ts

export const useAppStore = defineStore({
  id: 'app',
  actions: {
    setData(data) {
      console.log(data)
    }
  }
})

数据持久化

插件 pinia-plugin-persist 可以辅助实现数据持久化功能。

安装

npm i pinia-plugin-persist --save

使用

// src/store/index.ts

import { createPinia } from 'pinia'
import piniaPluginPersist from 'pinia-plugin-persist'

const store = createPinia()
store.use(piniaPluginPersist)

export default store

接着在对应的 store 里开启 persist 即可。

export const useUserStore = defineStore({
  id: 'user',

  state: () => {
    return {
      name: '张三'
    }
  },
  
  // 开启数据缓存
  persist: {
    enabled: true
  }
})

数据默认存在 sessionStorage 里，并且会以 store 的 id 作为 key。

自定义 `key`

你也可以在 strategies 里自定义 key 值，并将存放位置由 sessionStorage 改为 localStorage。

persist: {
  enabled: true,
  strategies: [
    {
      key: 'my_user',
      storage: localStorage,
    }
  ]
}

持久化部分 `state`

默认所有 state 都会进行缓存，你可以通过 paths 指定要持久化的字段，其他的则不会进行持久化。

state: () => {
  return {
    name: '张三',
    age: 18,
    gender: '男'
  }  
},

persist: {
  enabled: true,
  strategies: [
    {
      storage: localStorage,
      paths: ['name', 'age']
    }
  ]
}

上面我们只持久化 name 和 age，并将其改为localStorage, 而 gender 不会被持久化，如果其状态发送更改，页面刷新时将会丢失，重新回到初始状态，而 name 和 age 则不会。

以上就是关于 Pinia.js 用法的一些介绍，Pinia.js 的内容还远不止这些，更多内容及使用有待大家自己探索。

Pinia官方文档
https://pinia.vuejs.org/

写在最后

【程序视点】助力打工人减负，从来不是说说而已！

后续小二哥会继续详细分享更多实用的工具和功能。持续关注，这样就不会错过之后的精彩内容啦！~

如果这篇文章对你有帮助的话，别忘了【一键三连】支持下哦~

秒客网

VUE最新状态管理工具

前言

关于`Pinia.js`

`Pinia.js` 定位和特点：

使用

安装脚手架vite

安装依赖

优化改造

其他改变方式

通过 `actions` 去修改 `state`

$patch

创建 `Store`

`State`定义和使用

定义`State`

获取`state`

修改 `state`

`Getters`

`Actions`

异步 `action`

`action` 间相互调用

数据持久化

安装

使用

自定义 `key`

持久化部分 `state`

写在最后

相关文章

VUE最新状态管理工具

前言

关于Pinia.js

Pinia.js 定位和特点：

使用

安装脚手架vite

安装依赖

优化改造

其他改变方式

通过 actions 去修改 state

$patch

创建 Store

State定义和使用

定义State

获取state

修改 state

Getters

Actions

异步 action

action 间相互调用

数据持久化

安装

使用

自定义 key

持久化部分 state

写在最后

相关文章

关于`Pinia.js`

`Pinia.js` 定位和特点：

通过 `actions` 去修改 `state`

创建 `Store`

`State`定义和使用

定义`State`

获取`state`

修改 `state`

`Getters`

`Actions`

异步 `action`

`action` 间相互调用

自定义 `key`

持久化部分 `state`