Vuex基础概念之Mutations
在 Vuex 中 store
数据改变的唯一方法就是提交 mutations
。mutations
里面装着一些改变数据方法的集合,这是Vuex 设计很重要的一点,就是把处理数据逻辑方法全部放在 mutations
里面,使得数据和视图分离。
怎么用mutations
?
mutation
结构:每一个mutation
都有一个字符串类型的事件类型(type
)和回调函数(handler
),也可以理解为{type:handler()}
,这和订阅发布有点类似。先注册事件,当触发响应类型的时候调用handker()
,调用type
的时候需要用到store.commit
方法。
const store = new Vuex.Store({
state: {
count: 1,
},
mutations: {
increment(state) {
//注册事件,type:increment,handler第一个参数是state;
// 变更状态
state.count++;
},
},
});
store.commit("increment"); //调用type,触发handler(state)
载荷(payload)
:简单的理解就是往handler(stage)
中传参handler(stage,pryload)
;一般是个对象。
mutation-types
:将常量放在单独的文件中,方便协作开发。
commit
:提交可以在组件中使用 this.$store.commit('xxx')
提交 mutation
,或者使用 mapMutations
辅助函数将组件中的 methods
映射为 store.commit
调用(需要在根节点注入 store
)。
提交载荷(Payload)
载荷简单的理解就是往 handler(state)
中传参 handler(state, payload)
。
示例:
大多数情况下,载荷是一个对象:
mutations: {
// 提交荷载
increment (state, payload) {
state.count += payload.amount
}
}
提交荷载有两种方式:
// 把载荷和type分开提交
store.commit('increment', {
amount: 10
})
// 整个对象都作为载荷传给mutation函数
store.commit({
type: 'increment',
amount: 10
})
commit
可以在组件中使用 this.$store.commit('xxx')
提交 mutations
。
示例:
<template>
<div>
<h4>测试1:Count is {{count}}</h4>
<button @click="increment">+</button>
<button @click="decrement">-</button>
</div>
</template>
<script>
export default {
computed:{
count(){
return this.$store.state.count
}
},
methods:{
increment(){
//通过 store.commit 方法触发状态变更(mutations的方法)
this.$store.commit('increment');
},
decrement(){
this.$store.commit('decrement');
}
}
}
</script>
或者可以使用 mapMutations
辅助函数将组件中的 methods
映射为 store.commit
调用(需要在根节点注入 store)。
示例:
在使用mapMutations
辅助函数之前同样需要先引入:
<script>
import { mapMutations } from 'vuex'
export default {
computed:{
count(){
return this.$store.state.count
}
},
methods:{
...mapMutations([
'increment',
'decrement'
])
}
}
</script>
Mutations 需遵守 Vue 的响应规则
Vuex 的 store 中的状态是响应式的,所以当我们变更状态时,监视状态的 Vue 组件也会自动更新。
这也意味着 Vuex 中的 mutations 也需要与使用 Vue 一样遵守一些注意事项,如下所示:
- 最好提前在 store 中初始化好所有所需属性。
- 当需要在对象上添加新属性时,应该使用
Vue.set(obj, 'newProp', 123)
,或者以新对象替换老对象。例如利用对象展开运算符可以写成:state.obj = {...state.obj, newProp: 123 }
。
使用常量替代 Mutations 事件类型
使用常量替代 mutations 事件类型在各种 Flux 实现中是很常见的模式。这样可以使 linter 之类的工具发挥作用,同时把这些常量放在单独的文件中可以让你的代码合作者对整个 app 包含的 mutations 一目了然:
// mutation-types.js
export const SOME_MUTATION = 'SOME_MUTATION'
store.js
文件内容如下所示:
// store.js
import Vuex from 'vuex'
import { SOME_MUTATION } from './mutation-types'
const store = new Vuex.Store({
state: { ... },
mutations: {
// 使用 ES2015 风格的计算属性命名功能来使用一个常量作为函数名
[SOME_MUTATION] (state) {
// mutate state
}
}
})
我们知道mutation
是通过store.commit('increment')
的方式调用的,其中increment
方法是以字符串的形式代入。如果项目小,一个人开发的话倒还好,但是项目大了,编写代码的人多了,那就麻烦了,因为需要 commit
的方法一多,就会显得特别混乱,而且以字符串形式代入的话,一旦出了错,很难排查。
所以,在需要多人协作的大型项目中,最好还是用常量的形式来处理 mutation
。
必须是同步函数
要记住的是,Mutation 必须是同步函数。
因为我们之所以要通过提交 mutation 的方式来改变状态数据,是因为我们想要更明确地追踪到状态的变化。如果是类似下面这样异步的话:
mutations: {
someMutation (state) {
api.callAsyncMethod(() => {
state.count++
})
}
}
就不知道什么时候状态会发生改变,所以也就无法追踪了,这与 Mutation 的设计初心相悖,所以强制规定它必须是同步函数。