Mutation

1. 前言

本文我們將介紹如何使用 mutation。包括如何定義 mutation、如何觸發(fā) mutation、mapMutations 輔助函數(shù)的使用方式。mutation 是更改 Vuex 中 store 數(shù)據(jù)狀態(tài)的唯一方法。在 vuex 的使用過(guò)程中，我們需要編寫(xiě)大量的 mutation 來(lái)操作 store 中的數(shù)據(jù)。所以，學(xué)好如何使用 mutation 非常重要。mutation 并不是一個(gè)難點(diǎn)，它的使用非常簡(jiǎn)單，接下來(lái)我們就一步步學(xué)習(xí)它的使用。

2. 基礎(chǔ)用法

2.1. 定義 mutation

Vuex 中的 mutation 非常類(lèi)似于事件：每個(gè) mutation 都有一個(gè)字符串的 事件類(lèi)型 (type) 和 一個(gè) 回調(diào)函數(shù) (handler)。這個(gè)回調(diào)函數(shù)就是我們實(shí)際進(jìn)行狀態(tài)更改的地方，并且它會(huì)接受 state 作為第一個(gè)參數(shù)：

const store = new Vuex.Store({
  state: {
    count: 1
  },
  mutations: {
    increment (state) {
      // 變更狀態(tài)
      state.count++
    }
  }
})

2.2. 觸發(fā) mutation

我們不能直接調(diào)用一個(gè) mutation handler。這個(gè)選項(xiàng)更像是事件注冊(cè)：“當(dāng)觸發(fā)一個(gè)類(lèi)型為 increment 的 mutation 時(shí)，調(diào)用此函數(shù)?！?要喚醒一個(gè) mutation handler，你需要以相應(yīng)的 type 調(diào)用 store.commit 方法：

store.commit('increment')

2.3. 提交載荷（Payload）

你可以向 store.commit 傳入額外的參數(shù)，即 mutation 的 載荷（payload）：

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

store.commit('incrementByCount', 10)

在大多數(shù)情況下，載荷應(yīng)該是一個(gè)對(duì)象，我們通常接收的參數(shù)命名為 payload，這樣可以包含多個(gè)字段并且記錄的 mutation 會(huì)更易讀：

// 定義 mutation
mutations: {
  incrementByCount (state, payload) {
    state.count = state.count  + payload.count
  }
}
// 觸發(fā) mutation
store.commit('incrementByCount', {
  count: 10
})

2.3. 對(duì)象風(fēng)格的提交方式

提交 mutation 的另一種方式是直接使用包含 type 屬性的對(duì)象：

store.commit({
  type: 'incrementByCount',
  count: 10
})

當(dāng)使用對(duì)象風(fēng)格的提交方式，整個(gè)對(duì)象都作為載荷傳給 mutation 函數(shù)，因此 handler 保持不變：

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

完整示例：

代碼解釋
JS 代碼第 9-11 行，定義了一個(gè)無(wú)參的 mutation，對(duì) state.count + 1。
JS 代碼第 12-14 行，定義一個(gè)傳入 Number 類(lèi)型參數(shù) count 的 mutation，對(duì) state.count + count。
JS 代碼第 16-18 行，定義一個(gè)傳入 Object 類(lèi)型參數(shù) payload 的 mutation，對(duì) state.count + payload.count。
JS 代碼第 26 行，提交 mutation increment。
JS 代碼第 28 行，提交 mutation incrementByCount 并傳入數(shù)量 10。
JS 代碼第 31-33 行，提交 mutation incrementByObject 并傳入?yún)?shù) {count: 5}。
JS 代碼第 36-39 行，以對(duì)象的形式提交 mutation incrementByObject。

3. mutation 使用注意事項(xiàng)

3.1. Mutation 需遵守 Vue 的響應(yīng)規(guī)則

既然 Vuex 的 store 中的狀態(tài)是響應(yīng)式的，那么當(dāng)我們變更狀態(tài)時(shí)，監(jiān)視狀態(tài)的 Vue 組件也會(huì)自動(dòng)更新。這也意味著 Vuex 中的 mutation 也需要與使用 Vue 一樣遵守以下注意事項(xiàng)：

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

2. 當(dāng)需要在對(duì)象上添加新屬性時(shí)，你應(yīng)該：

   • 使用 Vue.set (obj, ‘newProp’, 123), 或者
   • 以新對(duì)象替換老對(duì)象。例如，利用對(duì)象展開(kāi)運(yùn)算符我們可以這樣寫(xiě)：

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

Tips：以新對(duì)象替換老對(duì)象替換老對(duì)象的方式只能修改 state 中的某個(gè)屬性，而不能替換整個(gè) state。想要替換整個(gè) state，需要使用 store.replaceState () 的方法:

  state.obj = { ...state.obj, newProp: 123 } // OK
  state = {...state, name: '123'} // Error
  store.replaceState({...state, name: '123'}) // OK

3.2. 使用常量替代 Mutation 事件類(lèi)型

在日常開(kāi)發(fā)中，我們一般會(huì)使用常量替代 mutation 事件類(lèi)型。這樣可以使 linter 之類(lèi)的工具發(fā)揮作用，同時(shí)可以讓你的代碼合作者對(duì)整個(gè) app 包含的 mutation 一目了然：

 const INCREMENT_COUNT = 'INCREMENT_COUNT'
 const store = new Vuex.Store({
   state: {
     count: 0
   },
   mutations: {
     [INCREMENT_COUNT](state) {
       state.count++
     },
   },
 })
 var vm = new Vue({
   el: '#app',
   store,
   methods: {
     add() {
       this.$store.commit('INCREMENT_COUNT')
     },
   }
 })

當(dāng)然，是否使用用常量取決于個(gè)人喜好 —— 在需要多人協(xié)作的大型項(xiàng)目中，這會(huì)很有幫助。但如果你不喜歡，你完全可以不這樣做。

3.3 Mutation 必須是同步函數(shù)

一條重要的原則就是要記住 mutation 必須是同步函數(shù)。為什么？請(qǐng)參考下面的例子：

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

現(xiàn)在想象，我們正在 debug 一個(gè) app 并且觀(guān)察 devtool 中的 mutation 日志。每一條 mutation 被記錄，devtools 都需要捕捉到前一狀態(tài)和后一狀態(tài)的快照。然而，在上面的例子中 mutation 中的異步函數(shù)中的回調(diào)讓這不可能完成：因?yàn)楫?dāng) mutation 觸發(fā)的時(shí)候，回調(diào)函數(shù)還沒(méi)有被調(diào)用，devtools 不知道什么時(shí)候回調(diào)函數(shù)實(shí)際上被調(diào)用 —— 實(shí)質(zhì)上任何在回調(diào)函數(shù)中進(jìn)行的狀態(tài)的改變都是不可追蹤的。

4 mapMutations 輔助函數(shù)

mapMutations 輔助函數(shù)幫助我們簡(jiǎn)化提交 mutation 的寫(xiě)法。

4.1 mapMutations 接收數(shù)組格式的參數(shù)

mapMutations 可以接收一個(gè)事件類(lèi)型 (type) 的數(shù)組：

...mapMutations([
  // 將 `this.increment()` 映射為 `this.$store.commit('increment')`
  'increment'
]),

4.2 mapMutations 接收對(duì)象格式的參數(shù)

在某些情況，我們需要對(duì) Mutation 中的函數(shù)名重命名以避免和組件內(nèi)部的變量沖突，這時(shí)候我們可以使用對(duì)象的方式接收參數(shù)：

...mapMutations({
  [別名]: [Mutation type] 
})
// 例：將 `this.add()` 映射為 `this.$store.commit('increment')`
...mapMutations({
  add: 'increment'
})

示例：

const INCREMENT_COUNT = 'INCREMENT_COUNT'
const store = new Vuex.Store({
  state: {
    count: 0
  },
  mutations: {
    [INCREMENT_COUNT](state) {
      state.count++
    },
  },
})
var vm = new Vue({
  el: '#app',
  store,
  methods: {
    ...Vuex.mapMutations([INCREMENT_COUNT]),
    ...Vuex.mapMutations({
      add: INCREMENT_COUNT
    })
  }
})

5. 小結(jié)

本小節(jié)我們介紹了如何使用 Mutation 提交事件來(lái)修改 state 中的數(shù)據(jù)。主要知識(shí)點(diǎn)有以下幾點(diǎn)：

• 在 store 中定義 Mutation 事件。
• 通過(guò) $store.commit 觸發(fā) Mutation 事件。
• 通過(guò) mapMutations 方法簡(jiǎn)化提交 Mutation 的寫(xiě)法。
  其中，使用 Mutation 需要注意以下幾點(diǎn)：
  1. Mutation 必須是一個(gè)同步函數(shù)。
  2. Mutation 需遵守 Vue 的響應(yīng)規(guī)則：只能通過(guò) Vue.set 添加 state 中的屬性，只能通過(guò) store.replaceState 替換這個(gè) state。