Action

Action 类似于 mutation,不同在于:

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

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

  1. import {createStore} from '@mpxjs/core'
  2. const store = createStore({
  3. state: {
  4. count: 0
  5. },
  6. mutations: {
  7. increment (state) {
  8. state.count++
  9. }
  10. },
  11. actions: {
  12. increment (context) {
  13. context.commit('increment')
  14. },
  15. increment2({rootState, state, getters, dispatch, commit}) {
  16. }
  17. }
  18. })

Action 函数接受一个 context 对象,因此你可以调用 context.commit 提交一个 mutation,或者通过 context.rootStatecontext.statecontext.getters 来获取全局state、局部state 和 全局 getters。

实践中,我们会经常用到 ES2015 的 参数解构 来简化代码(特别是我们需要调用 commit 很多次的时候):

  1. actions: {
  2. increment ({ commit }) {
  3. commit('increment')
  4. }
  5. }

分发 Action

Action 通过 store.dispatch 方法触发:

  1. store.dispatch('increment')

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

  1. actions: {
  2. incrementAsync ({ commit }) {
  3. setTimeout(() => {
  4. commit('increment')
  5. }, 1000)
  6. }
  7. }

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

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

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

  1. actions: {
  2. checkout ({ commit, state }, products) {
  3. // 把当前购物车的物品备份起来
  4. const savedCartItems = [...state.cart.added]
  5. // 发出结账请求,然后乐观地清空购物车
  6. commit(types.CHECKOUT_REQUEST)
  7. // 购物 API 接受一个成功回调和一个失败回调
  8. shop.buyProducts(
  9. products,
  10. // 成功操作
  11. () => commit(types.CHECKOUT_SUCCESS),
  12. // 失败操作
  13. () => commit(types.CHECKOUT_FAILURE, savedCartItems)
  14. )
  15. }
  16. }

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

在组件中分发 Action

你在组件中使用 store.dispatch('xxx') 分发 action,或者使用 store.mapActions 辅助函数将组件的 methods 映射为 store.dispatch 调用:

  1. import { createComponent } from '@mpxjs/core'
  2. import store from '../store'
  3. createComponent({
  4. // ...
  5. methods: {
  6. ...store.mapActions([
  7. 'increment', // 将 `this.increment()` 映射为 `store.dispatch('increment')`
  8. // `mapActions` 也支持载荷:
  9. 'incrementBy' // 将 `this.incrementBy(amount)` 映射为 `store.dispatch('incrementBy', amount)`
  10. ]),
  11. ...store.mapActions({
  12. add: 'increment' // 将 `this.add()` 映射为 `store.dispatch('increment')`
  13. })
  14. }
  15. })

组合 Action

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

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

  1. actions: {
  2. actionA ({ commit }) {
  3. return new Promise((resolve, reject) => {
  4. setTimeout(() => {
  5. commit('someMutation')
  6. resolve()
  7. }, 1000)
  8. })
  9. }
  10. }

现在你可以:

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

在另外一个 action 中也可以:

  1. actions: {
  2. // ...
  3. actionB ({ dispatch, commit }) {
  4. return dispatch('actionA').then(() => {
  5. commit('someOtherMutation')
  6. })
  7. }
  8. }

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

  1. // 假设 getData() 和 getOtherData() 返回的是 Promise
  2. actions: {
  3. async actionA ({ commit }) {
  4. commit('gotData', await getData())
  5. },
  6. async actionB ({ dispatch, commit }) {
  7. await dispatch('actionA') // 等待 actionA 完成
  8. commit('gotOtherData', await getOtherData())
  9. }
  10. }