Vuex概念
Vuex是在Vue中实现集中式状态(数据)管理的一个Vue插件,对Vue应用中多个组件的共享状态进行集中式的管理(读/写),可以实现组件间通信,适用于任意组件间通信。
当多个组件依赖同一状态、不同组件行为需要变更同一状态的时候,需要使用Vuex,也就是用Vuex来管理公共的变量或者数据。
案例
首先引出一个案例,这个案例是单组件,不使用Vuex来完成的。
有一个Count.vue组件,组件中有几个按钮和一个显示当前数据的区域,通过按钮修改当前值并重新显示。
在App.vue中引入Count.vue组件,在Count.vue中写主要的功能逻辑,这里没有什么新的知识点。
<template>
<div>
<h1>当前求和为:{{sum}}</h1>
<select v-model.number="n">
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
</select>
<button @click="increment">+</button>
<button @click="decrement">-</button>
<button @click="incrementOdd">当前求和为奇数再加</button>
<button @click="incrementWait">等一等再加</button>
</div>
</template>
<script>
export default {
name:'Count',
data() {
return {
n:1,// 用户选择的数字
sum:0// 当前的和
}
},
methods: {
increment(){
this.sum += this.n;
},
decrement(){
this.sum -= this.n;
},
incrementOdd(){
if(this.sum % 2){
this.sum += this.n;
}
},
incrementWait(){
setTimeout(()=>{
this.sum += this.n;
},500);
},
},
}
</script>
<style lang="css">
button{
margin-left: 5px;
}
</style>
搭建Vuex环境
使用命令npm i vuex
安装Vuex。
和前面的文件结构略有变化,在src下需要新建一个store文件夹,文件夹里放index.js文件,在main.js里需要引入store文件夹中暴露的内容。
main.js
// 引入Vue
import Vue from 'vue'
// 引入App
import App from './App.vue'
// 引入store,Vue实例和VueComponent实例上就有$store了
import store from './store'
//关闭Vue的生产提示
Vue.config.productionTip = false;
new Vue({
el:'#app',
render: h => h(App),
store,
beforeCreate() {
Vue.prototype.$bus = this;
}
});
编写index.js,在index.js里,需要介绍的就是Vuex中的三个对象:Actions、Mutations、State,在这3个对象中需要写一些业务方法。最后通过Vuex将Store暴露出去。
// 该文件用于创建Vuex中最为核心的store
import Vue from 'vue'
// 引入Vuex
import Vuex from 'vuex'
// 应用Vuex插件
Vue.use(Vuex);
// 准备actions——用于响应组件中的动作
const actions = {
// 如果action里的业务复杂,action里可以反复dispatch
fun1(context, value) {
console.log("fun1处理业务");
context.dispatch(fun2, value);
},
fun2(context, value) {
console.log("fun2处理业务");
context.dispatch(fun3, value);
},
fun3(context, value) {
console.log("fun3处理业务");
context.commit('xxx', value);
},
/* jia(context,value){
console.log('actions中的jia被调用了');
context.commit('JIA',value);
},
jian(context,value){
console.log('actions中的jian被调用了');
context.commit('JIAN',value);
}, */
jiaOdd(context,value){
console.log('actions中的jiaOdd被调用了');
if(context.state.sum % 2){
context.commit('JIA',value);
}
},
jiaWait(context,value){
console.log('actions中的jiaWait被调用了');
setTimeout(()=>{
context.commit('JIA',value);
},500);
}
};
// 准备mutations——用于操作数据(state)
const mutations = {
JIA(state,value){
console.log('mutations中的JIA被调用了');
state.sum += value;
},
JIAN(state,value){
console.log('mutations中的JIAN被调用了');
state.sum -= value;
}
};
// 准备state——用于存储数据
const state = {
sum:0// 当前的和
};
//准备getters——用于将state中的数据进行加工
const getters = {
bigSum(state){
return state.sum*10
}
}
// 创建并暴露store
export default new Vuex.Store({
actions,
mutations,
state,
getters
});
说一下这里的actions、mutations、state,getters。
actions中放一些接收dispatch()
请求的方法,方法体里做一些业务处理,将value通过context的commit()
方法传给mutations中的方法,在mutations中,可以拿到state中的值,并对实际的state里的值进行修改,state中存储的是一些数据信息,getters有点类似组件中的计算属性,通过一些方法,对state中的数据进行加工,通过方法返回值的方式进行返回。
再来看Count.vue组件。
Count.vue
<template>
<div>
<h1>当前求和为:{{$store.state.sum}}</h1>
<h3>当前求和放大10倍为:{{$store.getters.bigSum}}</h3>
<select v-model.number="n">
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
</select>
<button @click="increment">+</button>
<button @click="decrement">-</button>
<button @click="incrementOdd">当前求和为奇数再加</button>
<button @click="incrementWait">等一等再加</button>
</div>
</template>
<script>
export default {
name:'Count',
data() {
return {
n:1// 用户选择的数字
}
},
methods: {
// 如果业务简单,可以不经过dispatch,直接调用commit
// 这里尽可能写的简单,把业务扔到Vuex.Store.action里
increment(){
this.$store.commit('JIA',this.n)
},
decrement(){
this.$store.commit('JIAN',this.n)
},
incrementOdd(){
this.$store.dispatch('jiaOdd',this.n)
},
incrementWait(){
this.$store.dispatch('jiaWait',this.n)
},
},
mounted() {
console.log('Count',this)
}
}
</script>
<style lang="css">
button{
margin-left: 5px;
}
</style>
组件中需要修改state的值的时候,调用this.$store.dispatch('actions中的方法名', value)
方法或者this.$store.commit('mutations中的方法名', value)
方法即可。此时来到index.js的对应方法里,会拿到传过来的value,通过state获取到数据,和value做运算。在组件中读取state中值的时候,使用$store.state.sum
的方式,读取getters中方法的值使用$store.getters.bigSum
。
在actions中可以写异步代码,在mutations中不能写异步代码。
四个map方法的使用
这4个方法,都是写在组件里面的。
mapState方法
帮助我们映射state中数据为计算属性。
mapGetters方法
帮助我们映射getters中数据为计算属性
mapActions方法
帮助我们生成与actions对话的方法,即$store.dispatcher()
调用的函数
mapMutations方法
帮助我们生成与mutations对话的方法,即$store.commit()
调用的函数
index.js
//该文件用于创建Vuex中最为核心的store
import Vue from 'vue'
//引入Vuex
import Vuex from 'vuex'
//应用Vuex插件
Vue.use(Vuex)
//准备actions——用于响应组件中的动作
const actions = {
/* jia(context,value){
console.log('actions中的jia被调用了')
context.commit('JIA',value)
},
jian(context,value){
console.log('actions中的jian被调用了')
context.commit('JIAN',value)
}, */
jiaOdd(context,value){
console.log('actions中的jiaOdd被调用了');
if(context.state.sum % 2){
context.commit('JIA',value);
}
},
jiaWait(context,value){
console.log('actions中的jiaWait被调用了');
setTimeout(()=>{
context.commit('JIA',value);
},500);
}
}
//准备mutations——用于操作数据(state)
const mutations = {
JIA(state,value){
console.log('mutations中的JIA被调用了');
state.sum += value;
},
JIAN(state,value){
console.log('mutations中的JIAN被调用了');
state.sum -= value;
}
}
//准备state——用于存储数据
const state = {
sum:0,
school:'尚硅谷',
subject:'前端'
}
//准备getters——用于将state中的数据进行加工
const getters = {
bigSum(state){
return state.sum * 10;
}
}
// 创建并暴露store
export default new Vuex.Store({
actions,
mutations,
state,
getters
});
Count.vue
<template>
<div>
<h1>当前求和为:{{sum}}</h1>
<h3>当前求和放大10倍为:{{bigSum}}</h3>
<h3>我在{{school}},学习{{subject}}</h3>
<select v-model.number="n">
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
</select>
<button @click="increment(n)">+</button>
<button @click="decrement(n)">-</button>
<button @click="incrementOdd(n)">当前求和为奇数再加</button>
<button @click="incrementWait(n)">等一等再加</button>
</div>
</template>
<script>
import {mapState,mapGetters,mapMutations,mapActions} from 'vuex'
export default {
name:'Count',
data() {
return {
n:1// 用户选择的数字
}
},
computed:{
// 靠程序员自己亲自去写计算属性
/* sum(){
return this.$store.state.sum
},
school(){
return this.$store.state.school
},
subject(){
return this.$store.state.subject
}, */
// 借助mapState生成计算属性,从state中读取数据:对象写法
// key,value分别代表方法名和store.state里的变量
// key一定是字符串,所以引号可以省略,value是state里的变量,通过字符串去查找具体的变量,引号不能省略
...mapState({sum:'sum',school:'school',subject:'subject'}),
// 借助mapState生成计算属性,从state中读取数据:数组写法
...mapState(['sum','school','subject']),
// 靠程序员自己写计算属性
/* bigSum(){
return this.$store.getters.bigSum
}, */
// 借助mapGetters生成计算属性,从getters中读取数据:对象写法
// key,value分别代表方法名和store.getters里的方法
...mapGetters({bigSum:'bigSum'}),
// 借助mapGetters生成计算属性,从getters中读取数据:数组写法
...mapGetters(['bigSum']),
},
methods: {
// 程序员亲自写方法
/* incrementOdd(){
this.$store.dispatch('jiaOdd',this.n)
},
incrementWait(){
this.$store.dispatch('jiaWait',this.n)
}, */
// 借助mapActions生成对应的方法,方法中会调用dispatch去联系actions:对象写法
// key,value分别代表方法名和store.actions里的方法
...mapActions({incrementOdd:'jiaOdd',incrementWait:'jiaWait'}),
// 借助mapActions生成对应的方法,方法中会调用dispatch去联系actions(数组写法)
...mapActions(['jiaOdd','jiaWait']),
// 程序员亲自写方法
/* increment(){
this.$store.commit('JIA',this.n)
},
decrement(){
this.$store.commit('JIAN',this.n)
}, */
// 借助mapMutations生成对应的方法,方法中会调用commit去联系mutations:对象写法
// key,value分别代表方法名和store.mutations里的方法
...mapMutations({increment:'JIA',decrement:'JIAN'}),
// 借助mapMutations生成对应的方法,方法中会调用commit去联系mutations:数组写法
...mapMutations(['JIA','JIAN'])
},
mounted() {
const x = mapState({sum:'sum',school:'school',subject:'subject'});
console.log(x);
}
}
</script>
<style lang="css">
button{
margin-left: 5px;
}
</style>
多组件共享数据
除了Count.vue组件,还引入了一个Person.vue组件。把数据都写在index.js里,跨组件获取数据的时候,实际上都是去index.js的state里获取数据了,从而实现跨组件共享数据的功能。
Vuex模块化编码
store中引入count.js和person.js文件,并采用默认暴露,在index.js中通过Vuex.Store引入count.js和person.js到modules中,再将Vuex.Store对外默认暴露。在modules中,可以给引入的module起名字,这里起countAbout和personAbout作为名字。现在对外暴露的实际是Vuex.Store.countAbout和Vuex.Store.personAbout。此时Count.vue和Person.vue里的代码也要响应修改。
count.js
// 求和相关的配置
export default {
// 开启命名空间,否则在*.vue组件里,需要写countAbout.属性的写法
namespaced:true,
actions:{
jiaOdd(context,value){
console.log('actions中的jiaOdd被调用了');
if(context.state.sum % 2){
context.commit('JIA',value);
}
},
jiaWait(context,value){
console.log('actions中的jiaWait被调用了');
setTimeout(()=>{
context.commit('JIA',value);
},500);
}
},
mutations:{
JIA(state,value){
console.log('mutations中的JIA被调用了');
state.sum += value;
},
JIAN(state,value){
console.log('mutations中的JIAN被调用了');
state.sum -= value;
},
},
state:{
sum:0,
school:'尚硅谷',
subject:'前端',
},
getters:{
bigSum(state){
return state.sum * 10;
}
}
}
person.js
// 人员管理相关的配置
import axios from 'axios'
import { nanoid } from 'nanoid'
export default {
// 开启命名空间,否则在*.vue组件里,需要写personAbout.属性的写法
namespaced:true,
actions:{
addPersonWang(context,value){
if(value.name.indexOf('王') === 0){
context.commit('ADD_PERSON',value);
}else{
alert('添加的人必须姓王!');
}
},
addPersonServer(context){
// 在actions里可以调用异步的方法获取数据
// 这也是原理图actions中和Backend API交互的部分
axios.get('https://api.uixsj.cn/hitokoto/get?type=social').then(
response => {
context.commit('ADD_PERSON',{id:nanoid(),name:response.data});
},
error => {
alert(error.message);
}
);
}
},
mutations:{
ADD_PERSON(state,value){
console.log('mutations中的ADD_PERSON被调用了');
state.personList.unshift(value);
}
},
state:{
personList:[
{id:'001',name:'张三'}
]
},
getters:{
firstPersonName(state){
return state.personList[0].name;
}
}
}
index.js
//该文件用于创建Vuex中最为核心的store
import Vue from 'vue'
//引入Vuex
import Vuex from 'vuex'
import countOptions from './count'
import personOptions from './person'
//应用Vuex插件
Vue.use(Vuex)
//创建并暴露store
export default new Vuex.Store({
modules:{
countAbout:countOptions,
personAbout:personOptions
}
});
Count.vue,对map方法简写进行修改
<template>
<div>
<h1>当前求和为:{{sum}}</h1>
<h3>当前求和放大10倍为:{{bigSum}}</h3>
<h3>我在{{school}},学习{{subject}}</h3>
<h3 style="color:red">Person组件的总人数是:{{personList.length}}</h3>
<select v-model.number="n">
<option value="1">1</option>
<option value="2">2</option>
<option value="3">3</option>
</select>
<button @click="increment(n)">+</button>
<button @click="decrement(n)">-</button>
<button @click="incrementOdd(n)">当前求和为奇数再加</button>
<button @click="incrementWait(n)">等一等再加</button>
</div>
</template>
<script>
import {mapState,mapGetters,mapMutations,mapActions} from 'vuex'
export default {
name:'Count',
data() {
return {
n:1// 用户选择的数字
}
},
computed:{
// 第一个参数是module的名称
...mapState('countAbout',['sum','school','subject']),
...mapState('personAbout',['personList']),
...mapGetters('countAbout',['bigSum'])
},
methods: {
// 第一个参数是module的名称
...mapMutations('countAbout',{increment:'JIA',decrement:'JIAN'}),
...mapActions('countAbout',{incrementOdd:'jiaOdd',incrementWait:'jiaWait'})
},
mounted() {
console.log(this.$store);
}
}
</script>
<style lang="css">
button{
margin-left: 5px;
}
</style>
Person.vue,对未使用map方法简写进行修改
<template>
<div>
<h1>人员列表</h1>
<h3 style="color:red">Count组件求和为:{{sum}}</h3>
<h3>列表中第一个人的名字是:{{firstPersonName}}</h3>
<input type="text" placeholder="请输入名字" v-model="name">
<button @click="add">添加</button>
<button @click="addWang">添加一个姓王的人</button>
<button @click="addPersonServer">添加一个人,名字随机</button>
<ul>
<li v-for="p in personList" :key="p.id">{{p.name}}</li>
</ul>
</div>
</template>
<script>
import {nanoid} from 'nanoid'
export default {
name:'Person',
data() {
return {
name:''
}
},
computed:{
personList(){
return this.$store.state.personAbout.personList;
},
sum(){
return this.$store.state.countAbout.sum;
},
// 注意这里的写法,需要使用"/"来访问
firstPersonName(){
return this.$store.getters['personAbout/firstPersonName'];
}
},
methods: {
add(){
const personObj = {id:nanoid(),name:this.name};
// 注意这里的写法,需要使用"/"来访问
this.$store.commit('personAbout/ADD_PERSON',personObj);
this.name = '';
},
addWang(){
const personObj = {id:nanoid(),name:this.name};
// 注意这里的写法,需要使用"/"来访问
this.$store.dispatch('personAbout/addPersonWang',personObj);
this.name = '';
},
addPersonServer(){
this.$store.dispatch('personAbout/addPersonServer');
}
}
}
</script>
Devtools监视的是mutations的变化,可以通过Devtools中的Vuex查看详细数据和调试。