Pinia(发音为/piːnjʌ/,如英语中的“peenya”)是最接近piña(西班牙语中的菠萝)的词;
访问官网
有Vuex,为什么还要用Pinia?
和Vuex相比,Pinia有很多的优势:
执行安装命令,二选一
yarn add pinia
npm install pinia
在src/store/路径下,或者src/pinia/路径下,创建index.js文件,写入下方的代码,然后就成功创建一个pinia并可导出使用
import { createPinia } from 'pinia'
const pinia = createPinia()
export default pinia
什么是Store?
Store有三个核心概念:
Store在它被使用之前是不会创建的,可以通过调用use函数来使用Store。
比如下面,counter.js是已经定义好的一个状态管理文件
<template>
<div class="home">
<h2>Home View</h2>
<h2>count: {{ counterStore.count }}</h2>
<h2>count: {{ count }}</h2>
<button @click="incrementCount">count+1</button>
</div>
</template>
<script setup>
import { storeToRefs } from 'pinia'
import useCounter from '@/stores/counter';
const counterStore = useCounter()
const { count } = storeToRefs(counterStore)
function incrementCount() {
counterStore.count++
}
</script>
注意Store获取到后不能被解构,那会失去响应式,为了从 Store 中提取属性同时保持其响应式,需要使用storeToRefs()
state 是 store 的核心部分,因为store是用来帮助管理状态的。 在 Pinia 中,状态被定义为返回初始状态的函数;
比如下面/src/store/user.js的代码
import { defineStore } from 'pinia'
const useUser = defineStore("user", {
state: () => ({
name: "coder",
age: 18,
level: 100
})
})
export default useUser
读取和写入 state, 默认情况下,可以通过 store 实例访问状态来直接读取和写入状态;
import useUser from '@/stores/user';
const userStore = useUser()
userStore.age++
userStore.name = "xixi"
重置 State,可以通过调用 store 上的 $reset() 方法将状态 重置 到其初始值;
const userStore = useUser()
userStore.$reset()
改变State
$patch
方法;const userStore = useUser()
userStore.$patch({
name: "hhh",
age: 25,
leval: 50
})
替换State, 可以通过将其 $state
属性设置为新对象来替换 Store 的整个状态:
userStore.$state({
name: "hehe",
age: 10,
leval: 2
})
Getters相当于Store的计算属性computed:
比如src/store/counter.js
// 定义关于counter的store
import { defineStore } from 'pinia'
import useUser from './user'
const useCounter = defineStore("counter", {
state: () => ({
count: 99,
friends: [
{ id: 111, name: "xixi" },
{ id: 112, name: "kobe" },
{ id: 113, name: "james" },
]
}),
getters: {
// 基本使用
doubleCount(state) {
return state.count * 2
}
})
export default useCounter
访问当前store的Getters
const conterStore = useCouter()
console.log(counterStore.doubleCount)
console.log(counterStore.doubleCountAddOne)
Getters中访问自己的其他Getters, 可以通过this来访问到当前store实例的所有其他属性;
getters: {
// 1.基本使用
doubleCount(state) {
return state.count * 2
},
// 2.一个getter引入另外一个getter
doubleCountAddOne() {
// this是store实例
return this.doubleCount + 1
},
}
访问其他store的Getters
getters: {
// getters中用到其他的store中的数据
showMessage(state) {
// 1.获取user信息
const userStore = useUser()
// 2.获取自己的信息
// 3.拼接信息
return `name:${userStore.name}-count:${state.count}`
}
}
Getters也可以返回一个函数,这样就可以接受参数
getters: {
// getters也支持返回一个函数
getFriendById(state) {
return function(id) {
for (let i = 0; i < state.friends.length; i++) {
const friend = state.friends[i]
if (friend.id === id) {
return friend
}
}
}
}
}
Actions 相当于组件中的 methods,可以使用 defineStore() 中的 actions 属性定义,并且它们非常适合定义业务逻辑;
和getters一样,在action中可以通过this
访问整个store实例的所有操作;
actions: {
increment() {
this.count++
},
incrementNum(num) {
this.count += num
}
}
Actions中是支持异步操作的,且可以编写异步函数,在函数中使用await;
actions: {
increment() {
this.count++
},
incrementNum(num) {
this.count += num
}
}