• 首页
  • vue
  • TypeScript
  • JavaScript
  • scss
  • css3
  • html5
  • php
  • MySQL
  • redis
  • jQuery
  • mutation

    更改 Vuex 的store中的state的唯一方法是提交mutation。在Vuex 中,它非常类似于事件:每个mutation都有一个字符串的事件类型(type)和一个回调函数(handler)。这个回调函数就是我们实际进行状态更改的地方,并且它会接受state作为第一个参数:

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

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

    store.commit('increment')
    


    payload

    你可以向store.commit传入额外的参数,即mutationpayload(载荷):

    // ...
    mutations: {
      increment (state, n) {
        state.count += n
      }
    }
    
    store.commit('increment', 10)
    

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

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


    对象风格的提交方式

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

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

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

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


    使用常量替代 Mutation 事件类型

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

    // mutation-types.js
    export const SOME_MUTATION = 'SOME_MUTATION'
    
    // store.js
    import { createStore } from 'vuex'
    import { SOME_MUTATION } from './mutation-types'
    
    const store = createStore({
      state: { ... },
      mutations: {
        // 我们可以使用 ES2015 风格的计算属性命名功能,来使用一个常量作为函数名
        [SOME_MUTATION] (state) {
          // 修改 state
        }
      }
    })
    

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


    在组件中提交 Mutation

    你可以在组件中使用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')`
        })
      }
    }
    


    Mutation 必须是同步函数

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

    mutations: {
      someMutation (state) {
        api.callAsyncMethod(() => {
          state.count++
        })
      }
    }
    

    现在想象,我们正在 debug 一个 app 并且观察 devtool 中的mutation日志。每一条mutation被记录,devtools 都需要捕捉到前一状态和后一状态的快照。然而,在上面的例子中mutation中的异步函数中的回调让这不可能完成:因为当mutation触发的时候,回调函数还没有被调用,devtools 不知道什么时候回调函数实际上被调用——实质上任何在回调函数中进行的状态的改变都是不可追踪的。


    下一步:Action

    mutation中混合异步调用会导致你的程序很难调试。例如,当你调用了两个包含异步回调的mutation来改变状态,你怎么知道什么时候回调和哪个先回调呢?这就是为什么我们要区分这两个概念。在 Vuex 中,mutation都是同步事务:

    store.commit('increment')
    // 任何由 "increment" 导致的状态变更都应该在此刻完成。
    

    上篇:getter

    下篇:action