5. Vuex Mutation

Vuex Mutation

• 概述

  更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。Vuex 中的 mutation 非常类似于事件：每个 mutation 都有一个字符串的 事件类型 (type) 和 一个 回调函数 (handler)。注意 mutation 必须是同步函数。

• Mutation 的使用

  Mutation 可接受 state 作为第一个参数

  const store = new Vuex.Store({
    state: {
      count: 1
    },
    mutations: {
      increment (state) {
        // 变更状态
        state.count++
      }
    }
  })
  

  你不能直接调用一个 mutation handler。这个选项更像是事件注册：“当触发一个类型为 increment 的 mutation 时，调用此函数。”要唤醒一个 mutation handler，你需要以相应的 type 调用 store.commit 方法：

  this.$store.commit('increment')
  

  提交载荷（Payload）（传递参数）

  你可以向 store.commit 传入额外的参数，即 mutation 的 载荷（payload）：

  // ...
  mutations: {
    increment (state, n) {
      state.count += n
    }
  }
  

  this.$store.commit('increment', 10)
  

  在大多数情况下，载荷应该是一个对象，这样可以包含多个字段并且记录的 mutation 会更易读：

  // ...
  mutations: {
    increment (state, payload) {
      state.count += payload.amount
    }
  }
  

  this.$store.commit('increment', {
    amount: 10
  })
  

  对象风格的提交方式（事件和载荷合并）

  提交 mutation 的另一种方式是直接使用包含 type 属性的对象：

  store.commit({
    type: 'increment',
    amount: 10
  })
  

  当使用对象风格的提交方式，整个对象都作为载荷传给 mutation 函数，因此 handler 保持不变：

  mutations: {
    increment (state, payload) {
      state.count += payload.amount
    }
  }
  

  Mutation 需遵守 Vue 的响应规则

  既然 Vuex 的 store 中的状态是响应式的，那么当我们变更状态时，监视状态的 Vue 组件也会自动更新。这也意味着 Vuex 中的 mutation 也需要与使用 Vue 一样遵守一些注意事项：

  1.最好提前在你的 store 中初始化好所有所需属性。
  2.当需要在对象上添加新属性时，你应该

  • 使用 Vue.set(obj, 'newProp', 123), 或者

  • 以新对象替换老对象。例如，利用对象展开运算符我们可以这样写：

    state.obj = { ...state.obj, newProp: 123 }
    

  用常量替代 Mutation 事件类型

  使用常量替代 mutation 事件类型在各种 Flux 实现中是很常见的模式。这样可以使 linter 之类的工具发挥作用，同时把这些常量放在单独的文件中可以让你的代码合作者对整个 app 包含的 mutation 一目了然：

  // mutation-types.js
  export const SOME_MUTATION = 'SOME_MUTATION'
  // 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
      }
    }
  })
  

  用不用常量取决于你——在需要多人协作的大型项目中，这会很有帮助。但如果你不喜欢，你完全可以不这样做。

  mapMutations 辅助函数的使用

  你可以在组件中使用 this.$store.commit('xxx') 提交 mutation，或者使用 mapMutations 辅助函数将组件中的 methods 映射为 store.commit 调用（需要在根节点注入 store）。

  import { mapMutations } from 'vuex'
  
  export default {
    // ...
    methods: {
      ...mapMutations([
        'increment', // 将 `this.increment()` 映射为 `this.$store.commit('increment')`
  
        // `mapMutations` 也支持载荷：
        'incrementBy' // 将 `this.incrementBy(amount)` 映射为 `this.$store.commit('incrementBy', amount)`
      ]),
      ...mapMutations({
        add: 'increment' // 将 `this.add()` 映射为 `this.$store.commit('increment')`
      })
    }
  }