Action

Action 类似于 mutation，不同在于：

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

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

import { createStore } from 'redux-sam';
import { Component } from 'react';
import createLogger from 'redux-sam/logger';

const { store, sam } = createStore({
  state: {
    count: 0
  },
  mutations: {
    increment (state) {
      state.count++
    }
  },
  actions: {
    increment (context) {
      context.commit('increment')
    }
  },
  plugins: [process.env.NODE_ENV !== 'production' && createLogger()]
}, Component);

export { store, sam };

Action 函数接受一个与 sam 实例具有相同方法和属性的 context 对象，因此你可以调用 context.dispatch 提交一个 mutation，或者通过 context.state 来获取 state。当我们在之后介绍到 Modules 时，你就知道 context 对象为什么不是 sam 实例本身了。

实践中，我们会经常用到 ES2015 的 参数解构 来简化代码（特别是我们需要调用 dispatch 很多次的时候）：

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

分发 Action

Action 通过 sam.dispatch 方法触发：

sam.dispatch('increment')

或者

store.dispatch('increment', null, { async: true })

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

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

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

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

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

或者

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

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

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

actions: {
  checkout ({ commit, state }, products) {
    // 把当前购物车的物品备份起来
    const savedCartItems = [...state.cart.added]
    // 发出结账请求，然后乐观地清空购物车
    commit(types.CHECKOUT_REQUEST)
    // 购物 API 接受一个成功回调和一个失败回调
    shop.buyProducts(
      products,
      // 成功操作
      () => commit(types.CHECKOUT_SUCCESS),
      // 失败操作
      () => commit(types.CHECKOUT_FAILURE, savedCartItems)
    )
  }
}

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

在组件中分发 Action

你可以在组件中使用 this.props.dispatch('xxx', any, { async: true }) 或者this.$sam.dispatch('xxx') 分发 action，

import React, { Component } from 'react';
import { mapActions } from './store';

export default class Counter extends Component {
  constructor(props) {
    super(props);

    mapActions(this, [
      'increment', // 将 `this.increment()` 映射为 `this.$sam.dispatch('increment')`

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

或者

import React, { Component } from 'react';

export default class Counter extends Component {
  constructor(props) {
    super(props);

    this.$mapActions([
      'increment', // 将 `this.increment()` 映射为 `this.$sam.dispatch('increment')`

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

组合 Action

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

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

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

现在你可以：

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

或者

store.dispatch('actionA', null, { async: true }).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', null, { async: true }) // 等待 actionA 完成
    commit('gotOtherData', await getOtherData())
  }
}

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

Mutation
Module