[TOC]

Vuex 核心概念

State

单一状态树

Vuex 使用单一状态树——是的，用一个对象就包含了全部的应用层级状态。至此它便作为一个“唯一数据源 (SSOT (opens new window))”而存在。这也意味着，每个应用将仅仅包含一个 store 实例。单一状态树让我们能够直接地定位任一特定的状态片段，在调试的过程中也能轻易地取得整个当前应用状态的快照。

单状态树和模块化并不冲突——在后面的章节里我们会讨论如何将状态和状态变更事件分布到各个子模块中。

存储在 Vuex 中的数据和 Vue 实例中的 data 遵循相同的规则，例如状态对象必须是纯粹 (plain) 的

在Vue组件中获得Vuex状态

那么我们怎么如何在Vue组件中展示状态呢？由于Vuex的状态存储是响应式的，从store实例中读取状态最简单的方法就是在计算属性中返回某个状态：

// 创建一个 Counter组件
const Counter = {
	template: `<div>{{ count }}</div>`,
	computed: {
		count() {
			return store.state.count
		}
	}
}

每当store.state.count变化的时候，都会重新求取计算属性，并且触发更新相关联的 DOM。
然而，这种模式导致组件依赖全局状态单例。在模块化的构建系统中，在每个需要使用state的组件中需要频繁地导入，并且在测试组件中需要模拟状态。
Vuex通过store选项，提供了一种机制将状态从根组件“注入”到每一个子组件中（需调用Vue.use(Vuex)):

const app = new Vue({
	el: '#app',
	// 把store对象提供给“store”选项，这可以把store的实例注入所有的子组件中
	store,
	componets: {Counter},
	template: `
    <div class="app">
      <counter></counter>
    </div>
  `
})

通过在根实例中注册store选项，该store实例会注入到根组件下的所有子组件中，且子组件能通过this.$store访问到。让我们更新下Counter实现：

const Counter = {
	template: `<div>{{ counter }}</div>`,
	computed: {
		count() {
			return this.$store.state.count
		}
	}
}

mapState辅助函数

当一个组件需要获取多个状态的时候，将这些状态都声明为计算属性会有些重复和冗余。为了解决这个问题，我们可以使用mapState辅助函数帮我们生成计算属性，让你少按几次键：

// 在单独构建的版本中辅助函数为 Vuex.mapState
import { mapState } from 'vuex'

export default {
	// ...
	computed: mapState({
		// 箭头函数可以使代码更简练
		count: state => state.count,

		// 传字符串参数 `count` 等同于 `state => state.count`
		countAlias: 'count',

		// 为了能够使用`this`获取局部状态，必须使用常规函数
		countPlusLocalState (state) {
			return state.count + this.localCount
		}
	})
}

当映射的计算机属性的名称与state的子节点名称相同时，我们也可以给mapState传一个字符串数组

computed: mapState([
	// 映射 this.count 为 store.state.count
	'count'
	])

对象展开运算符

mapState 函数返回的是一个对象。我们如何将它与局部计算属性混合使用呢？通常，我们需要使用一个工具函数将多个对象合并为一个，以使我们可以将最终对象传给 computed 属性。但是自从有了对象展开运算符 (opens new window)，我们可以极大地简化写法：

computed: {
localComputed () { /*...*/},
// 使用对象展开运算符将此对象混入到外部对象中
...mapState({
	//...
})
}

组件仍然保有局部状态

使用Vuex并不意味着你需要将所有的状态放入Vuex。虽然将所有的状态放到Vuex会使状态变化更显式和易调试，但也会使代码变得冗长和不直观。如果有些状态严格属于单个组件，最好还是作为组件的局部状态。你应该根据你的应用开发需要进行权衡和确定。

Getters

有时候我们需要从store中的state派生出一些状态，例如对列表进行过滤并计数

computed: {
	doneTodosCount () {
		return this.$store.state.todos.filter(todo => todo.done).length
	}
}

如果有多个组件需要用到此属性，我们要么复制这个函数，或者抽取到一个共享函数然后在多处导入它————无论哪种方式都不是很理想

Vuex允许我们在store中定义”getter”（可以认为是store的计算属性）。就像就算属性一样，getter的返回值会根据它的依赖关系被缓存起来，且只有当它的依赖值发生改变才会被重新计算。

Getter 接受 state 作为其第一个参数

const store = new Vuex.Store({
	state = {
		todos: [
		{ id: 1, text: '...', done: true},
		{ id: 2, text: '...', done: false}
	]
	},
	getters: {
		doneTodos: state => {
			return state.todos.filter(todo => todo.done)
		}
	}
})

通过属性访问

Getter 会暴露为 store.getters 对象，你可以以属性的形式访问这些值：

store.getters.doneTodos // -> [{ id: 1, text: '...'}]

Getter 也可以接受其他 getter 作为第二个参数:

getters: {
	// ...
	doneTodosCount: (state, getters) => {
		return getters.doneTodos.length
	}
}

store.getters.doneTodosCount // -> -1

我们可以很容易地在任何组件中使用它:

computed: {
	doneTodosCount () {
		return this.$store.getters.doneTodosCount
	}
}

注意，getter 在通过属性访问时是作为Vue地响应式系统的一部分缓存其中的。

通过方法访问

你也可以通过让getter返回一个函数，来实现给getter传参。在你对store里的数组进行查询时非常有用。

getters: {
	// ...
	getTodoById: (state) => (id) => {
		return state.todos.find(todo => todo.id === id)
	}
}

store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }

注意，getter 在通过方法访问时，每次都会去进行调用，而不会缓存结果。

mapGetters辅助函数

mapGetters辅助函数仅仅是将store中的getters映射到局部计算属性

import { mapGetters } from 'vuex'

export default {
    // ...
    computed: {
        // 使用对象展开运算符 getter 混入 computed 对象中
        ...mapGetters([
            'doneTodosCount',
            'anotherGetter',
            // ...
        ])
    }
}

如果你想将一个getter属性另取一个名字，使用对象形式：

...mapGetters({
	// 把`this.doneCount`映射为 `this.$store.getters.doneTodosCount`
	doneCount: 'doneTodosCount'
})

Mutiations

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

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

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

store.commit('increment')

提交载荷(Payload)

你可以向store.commit传入，即mutation的载荷(payload):

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

store.commit('increment', 10)

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

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

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

对象风格的提交方式

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

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

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

mutaions: {
	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 './mutations-types'

const store = new Vuex.Store({
	state: { ... },
	mutations: {
		// 我们可以使用ES2015风格的计算属性命名功能来使用一个常量作为函数名
		[SOME_MUTATION] (state) {
			// mutate state
		}
	}
})

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

Mutation 必须是同步函数

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

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

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

在组件中提交 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')`
		})
	}
}

下一步: Action

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

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

Action

Action 类似于 mutation, 不同在于:

• Action 提交的是mutation, 而不是直接变更状态
• Action 可以包含任意异步操作。

让我们来注册一个简单的action:

const store = new Vuex.Store({
	state: {
		count: 0
	},
	mutations: {
		increment (state) {
			state.count++ 
		}
	},
	actions: {
		increment (context) {
			context.commit('increment')
		}
	}
})

Action 函数接受一个与store实例具有相同方法和属性的context对象，因此你可以调用context.commit提交一个mutation，或者通过context.state和context.getters来获取state和getters。
实践中，我们经常会用到ES2015的参数解构来简化代码（特别是我们需要调用commit很多次的时候):

actions: {
	increment ({commit}) {
		commit('increment');
	}
}

分发Action

Action 通过 store.dispatch方法触发:

store.dispatch('increment')

乍一眼看上去感觉多此一举，我们直接分发mutation岂不是更加方便?实际并非如此，还记得mutation必须同步执行么这个限制么?Action就不受约束！我们可以在action内部执行异步操作:

actions: {
	incrementAsync ({commit}) {
		setTimeout(() => {
			commit('increment')
		}, 1000)
	}
}

Actions支持同样的载荷方式和对象方式进行分发:

// 以载荷形式分发
store.dispatch('incrementAsync', {
	amount: 10
})

// 以对象形式分发
store.dispatch({
	type: 'incrementAsync',
	amount: 10
})

来看一个更加实际的购物车示例，涉及到调用异步API和分发多重mutation:

actions: {
	checkout ({ commit, state }, products) {
		// 把当前购物车的物品备份起来
		const saveCartItems = [...state.cart.added]

		// 发出结账请求，然后乐观地清空购物车
		commit(types.CHECKOUT_REQUEST)
		// 购物API接受一个成功回调和一个失败回调
		shop.buyProducts(
			products,
			// 成功操作
			() => commit(types.CHECKOUT_SUCCESS),
			// 失败操作
			() => commit(types.CHECKOUT_FAILURE, saveCartItems)
		)
	}
}

注意我们正在进行一系列的异步操作，并且通过提交mutation来记录action产生的副作用（即状态变更）。

在组件中分发Action

你在组件中使用this.$store.dispatch('xxx')分发action，或者使用mapActions辅助函数将组件的methods映射为store.dispatch调用（需要先在根节点注入store):

import { mapActions } from 'vuex'

export default {
	// ... 
	methods: {
		...mapActions([
			'increment', // 将`this.increment()` 映射为 `this.$store.dispatch('increment')`

			// `mapActions` 也支持载荷
			'incrementBy': // 将 `this.incrementBy(amount)`映射为`this.$store.dispatch('incrementBy', amount)`
		]),
		...mapActions({
			add: 'increment' // 将`this.add()` 映射为`this.$store.dispatch('increment')`
		})
	}
}

组合Action

Action通常是异步的，那么如何知道action什么时候执行结束呢？更重要的是，我们如何才能组合多个action，以处理更加复杂的异步流程？

首先，你需要明白store.dispatch可以处理被触发的action的处理函数返回的Promise,并且store.dispatch仍旧返回Promise:

actions: {
	actionA({ commit }) {
		return new Promise((resolve, reject)) => {
			setTimeout(() => {
				commit('someMutation')
				resolve()
			}, 1000)
		}
	}
}

现在你也可以:

store.dispatch('actionA').then(() => {
	// ...
})

在另外一个action中也可以:

actions: {
	// ...
	actionB ({ dispatch, commit }) {
		return dispatch('actionA').then(() => {
			commit('someOtherMutation')
		})
	}
}

最后，如果我们利用async/await，我们可以如下组合action：

// 假设 getData()和 getOtherData() 返回的是Promise
actions: {
	async actionA ({ commit }) {
		commit('gotData', await getData())
	},
	async actionB ({ dispatch, commit}) {
		await dispatch('actionA') //等待 actionA 完成
		commit('gotOtherData', await getOtherData())
	}
}

一个store.dispatch 在不同模块中可以触发多个action函数。在这种情况下，只有当所有触发函数完成后,返回的Promise才会执行。

Modules

由于使用单一状态树，应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时，store对象就有可能变得相当臃肿。

为了解决以上问题，Vuex允许将store分割成模块(module)。每个模块都拥有自己的state、mutation、action、getter，甚至是嵌套子模块————从上至下进行同样方式的分割:

const moduleA = {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

const moduleB = {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... }
}

const store = new Vuex.Store({
  modules: {
    a: moduleA,
    b: moduleB
  }
})

store.state.a // -> moduleA 的状态
store.state.b // -> moduleB 的状态

模块的局部状态

对于模块内部的mutation和getter，接收的第一个参数是模块的局部状态对象。

const moduleA = {
	state: () => ({
		count: 0
	}),
	mutations: {
		increment (state) {
			// 这里的`state`对象是模块的局部状态
			state.count++
		}
	},
	getters: {
		doubleCount (state) {
			return state.count * 2
		}
	}

同样，对于模块内部的action，局部状态通过context.state暴露出来，根节点状态则为context.rootState:

const moduleA = {
	// ...
	actions: {
		incrementIfOddOnRootSum ({ state, commit, rootState }) {
			if ((state.count + rootState.count) % 2 === 1) {
				commit('increment')
			}
		}
	}
}

对于模块内部的getter，根节点状态会作为第三个参数暴露出来：

const moduleA = {
	// ...
	getters: {
		sumWithRootCount (state, getters, rootState) {
			return state.count + rootState.count
		}
	}
}

命名空间

默认情况下，模块内部的action、mutation和getter是注册在全局命名空间的————这样使得多个模块能够对同一mutation或action做出响应。

如果希望你的模块具有更高的封装度和复用性，你可以通过添加 namespaced: true 的方式使其成为带命名空间的模块。当模块被注册后，它的所有 getter、action 及 mutation 都会自动根据模块注册的路径调整命名。例如：

const store = new Vuex.Store({
  modules: {
    account: {
      namespaced: true,

      // 模块内容（module assets）
      state: () => ({ ... }), // 模块内的状态已经是嵌套的了，使用 `namespaced` 属性不会对其产生影响
      getters: {
        isAdmin () { ... } // -> getters['account/isAdmin']
      },
      actions: {
        login () { ... } // -> dispatch('account/login')
      },
      mutations: {
        login () { ... } // -> commit('account/login')
      },

      // 嵌套模块
      modules: {
        // 继承父模块的命名空间
        myPage: {
          state: () => ({ ... }),
          getters: {
            profile () { ... } // -> getters['account/profile']
          }
        },

        // 进一步嵌套命名空间
        posts: {
          namespaced: true,

          state: () => ({ ... }),
          getters: {
            popular () { ... } // -> getters['account/posts/popular']
          }
        }
      }
    }
  }
})

启用了命名空间的getter和action会收到局部化的getter，dispatch和commit。换言之，你再使用模块内容(module assets)时不需要在同一模块内额外添加空间名前缀。更改namespaced属性后不需要修改模块内的代码。

在带命名空间的模块内访问全局内容(Global Assets)

如果你希望使用全局state和getter, rootState和rootGetters会作为第三和第四参数传入getter，也会通过context对象的属性传入action.

若需要在全局命名空间内分发action或提交mutation，将{ root : true} 作为第三个参数传给dispatch或commit即可。

modules: {
	foo: {
		namespaced: true,

		getters: {
     // 在这个模块的 getter 中，`getters` 被局部化了
     // 你可以使用 getter 的第四个参数来调用 `rootGetters`
     someGetter (state, getters, rootState, rootGetters) {
       getters.someOtherGetter // -> 'foo/someOtherGetter'
       rootGetters.someOtherGetter // -> 'someOtherGetter'
     },
     someOtherGetter: state => { ... }
   },

   actions: {
     // 在这个模块中， dispatch 和 commit 也被局部化了
     // 他们可以接受 `root` 属性以访问根 dispatch 或 commit
     someAction ({ dispatch, commit, getters, rootGetters }) {
       getters.someGetter // -> 'foo/someGetter'
       rootGetters.someGetter // -> 'someGetter'

       dispatch('someOtherAction') // -> 'foo/someOtherAction'
       dispatch('someOtherAction', null, { root: true }) // -> 'someOtherAction'

       commit('someMutation') // -> 'foo/someMutation'
       commit('someMutation', null, { root: true }) // -> 'someMutation'
     },
     someOtherAction (ctx, payload) { ... }
   }
	}
}

在带命名空间的模块注册全局action

若需要在带命名空间的模块注册全局action，你可以添加root:true,并将这个action的定义放在函数handler中。例如：

{
	actions: {
		someOtherAction ({dispatch}) {
			dispatch('someAction')
		}
	},
	modules: {
		foo: {
			namespaced: true,

			actions: {
				someAction: {
					root: true,
					handler (namespacedContext, payload) { ... }	// -> 'someAction'
				}
			}
		}
	}
}

带命名空间的绑定函数

当使用mapState,mapGetters,mapActions和mapMutations这些函数来绑定带命名空间的模块时，写起来可能比较繁琐:

computed: {
  ...mapState({
    a: state => state.some.nested.module.a,
    b: state => state.some.nested.module.b
  })
},
methods: {
  ...mapActions([
    'some/nested/module/foo', // -> this['some/nested/module/foo']()
    'some/nested/module/bar' // -> this['some/nested/module/bar']()
  ])
}

对于这种情况，你可以将模块的空间名称字符串作为第一个参数传递给上述函数，这样所有绑定都会自动将该模块作为上下文。于是上面的例子可以简化为:

computed: {
  ...mapState('some/nested/module', {
    a: state => state.a,
    b: state => state.b
  })
},
methods: {
  ...mapActions('some/nested/module', [
    'foo', // -> this.foo()
    'bar' // -> this.bar()
  ])
}

而且，你可以通过使用createNamespacedHelpers创建基于某个命名空间辅助函数。它返回一个对象，对象里有新的绑定在给定命名空间值上的组件绑定辅助函数:

import { createNamespacedHelpers } from 'vuex'

const { mapState, mapActions } = createNamespacedHelpers('some/nested/module')

export default {
  computed: {
    // 在 `some/nested/module` 中查找
    ...mapState({
      a: state => state.a,
      b: state => state.b
    })
  },
  methods: {
    // 在 `some/nested/module` 中查找
    ...mapActions([
      'foo',
      'bar'
    ])
  }
}

模块动态注册

在store创建之后，你可以使用store.registerModule方法注册模块

	import Vuex from 'vuex'

const store = new Vuex.Store({/*选项*/})

// 注册模块 `myModule`
store.registerModule('myModule', {
	// ...
})

// 注册嵌套模块 `nested/myModule`
store.registerModule(['nested', 'myModule'],{
	// ... 
})

之后就可以通过 store.state.myModule 和 store.state.nested.myModule 访问模块的状态。

模块动态注册功能使得其他 Vue 插件可以通过在 store 中附加新模块的方式来使用 Vuex 管理状态。例如，vuex-router-sync (opens new window)插件就是通过动态注册模块将 vue-router 和 vuex 结合在一起，实现应用的路由状态管理。

你也可以使用 store.unregisterModule(moduleName) 来动态卸载模块。注意，你不能使用此方法卸载静态模块（即创建 store 时声明的模块）。

注意，你可以通过 store.hasModule(moduleName) 方法检查该模块是否已经被注册到 store。

保留state

在注册一个新 module 时，你很有可能想保留过去的 state，例如从一个服务端渲染的应用保留 state。你可以通过 preserveState 选项将其归档：store.registerModule(‘a’, module, { preserveState: true })。

当你设置 preserveState: true 时，该模块会被注册，action、mutation 和 getter 会被添加到 store 中，但是 state 不会。这里假设 store 的 state 已经包含了这个 module 的 state 并且你不希望将其覆写。

模块重用

有时我们可能需要创建一个模块的多个实例，例如:

• 创建多个store,他们公用同一个模块（例如当runInNewContext 选项是false或once时，为了在服务端渲染中避免有状态的单例）
• 在一个store中多次注册同一模块

如果我们使用一个纯对象来声明模块的状态，那么这个状态对象会通过引用被共享，导致状态对象被修改时store或模块间数据互相污染的问题。

实际上这和Vue组件内的data是同样的问题。因此解决办法也是相同的————使用一个函数来声明模块状态:

const MyReusableModule = {
	state: () => ({
		foo: 'bar'
	})
	// mutation,action和getter等等...
}