Vuex中的Mutation使用详解

一、Mutation的作用

更改 Vuex 的store 中的状态的唯一方法是提交 mutation。 Vuex 中的 mutation 非常类似于事件：

• 每个 mutation 都有一个字符串的 事件类型 (type) 和 一个 回调函数 (handler)。
• 这个回调函数就是我们实际进行状态更改的函数，并且它会接受 state 作为第一个参数：

const store = new Vuex.Store({
  state: {
    count: 1
  },
  mutations: {
  	// 第一个参数为 state
    add(state) {
      // 变更状态，即变更值
      state.count++
    }
  }
})

• 你不能直接调用一个 mutation handler。

这个选项更像是事件注册：

“当触发一个类型为 add 的 mutation 时，调用此函数。”要唤醒一个 mutation handler，你需要以相应的 type 调用 store.commit 方法：

store.commit('increment')

二、提交载荷（Payload）

即当我们想修改状态值，想传入的值进而进行修改时，你可以向 store.commit 传入额外的参数，即 mutation 的 载荷（payload）：

// 定义
mutations: {
  // n被称为载荷， 即为我们传入的值
  add(state, n) {
    state.count += n
  }
}

// 调用
store.commit('increment', 10)

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

// 定义
mutations: {
  add(state, payload) {
    state.count += payload.amount
  }
}

// 调用
store.commit('increment', {
  amount: 10
})

三、对象风格的提交方式

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

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

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

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

四、Mutation 需遵守 Vue 的响应规则

最好提前在你的 store 中初始化好所有所需属性。

若需要在对象上添加新属性时，你应该：

1. 使用 Vue.set(obj, 'newProp', 123)
2. 以新对象替换老对象。例如，利用对象展开运算符我们可以这样写：

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

五、Mutation 必须是同步函数 ！！！

一条重要的原则就是要记住 mutation 必须是同步函数。为什么？请参考下面的例子：

mutations: {
  someMutation (state) {
     // 一秒后count++
    setTimeout(() => {
      state.count++
    }, 1000)
  }
}

现在想象，我们正在 debug 一个 app 并且观察 devtool 中的 mutation 日志。每一条mutation 被记录，devtools 都需要捕捉到前一状态和后一状态的快照。然而，在上面的例子中 mutation 中的异步函数中的回调让这不可能完成：因为当 mutation 触发的时候，回调函数还没有被调用，devtools 不知道什么时候回调函数实际上被调用——实质上任何在回调函数中进行的状态的改变都是不可追踪的。 即虽然1秒后我们可以实现 state.count++ ，但是 devtools 是无法监测state.count 的改变的。 假设调用通过 someMutation count 的值为0， 打开 devtools工具，然后我们调用 someMutation ,观察 devtools 的记录，我肯可以看到 devtools 监听到的 count 的值还是为0， 因为时异步函数，所以 someMutation 的 state.count++ 操作还没有执行。 大家可以尝试在自己的浏览器使用 devtools 工具试试看。

六、在组件中提交 Mutation

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

// main.js
// 根节点引入store
new Vue({
  el: '#app',
  store
})

// 组件
// 引入辅助函数 mapMutations 
import { mapMutations } from 'vuex'
export default {
  methods: {
    // 将 `this.add()` 映射为 `this.$store.commit('add')`
    // `mapMutations` 也支持载荷：
    // 将 `this.addBy(amount)` 映射为 this.$store.commit('addBy', amount)`
    ...mapMutations(['add', 'addBy']),
    // 将 `this.increment()` 映射为 `this.$store.commit('add')`
    ...mapMutations({
      increment: 'add' 
    })
  }
}

到此这篇关于Vuex中的Mutation使用详解的文章就介绍到这了,更多相关Vuex中的Mutation内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

最新评论