5-vuex Action | 宋宇的文档笔记

Action

Action 类似于 mutation，不同在于：

Action 提交的是 mutation，而不是直接变更状态。
Action 可以包含任意异步操作。【注意】：dispatch 调用 actions 专用，commit 调用 mutations 专用

const store = new Vuex.Store({
  state: {
    count: 0,
  },
  mutations: {
    increment(state) {
      state.count++;
    },
  },
  actions: {
    increment(context) {
      // increment是mutations里的，在vuex里commit专门为mutations设立
      context.commit("increment");
    },
  },
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Action 函数接受一个与 store 实例具有相同方法和属性的 context 对象【不是 store 实例本身】，因此你可以调用 context.commit 提交一个 mutation，或者通过 context.state 和 context.getters 来获取 state 和 getters。

解构写法

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

1
2
3
4
5

分发【触发】 Action

Action 通过 store.dispatch 方法触发：

store.dispatch("increment");

action 内部执行异步操作

actions: {
  incrementAsync ({ commit }) {
    setTimeout(() => {
      commit('increment')
    }, 1000)
  }
}
// or 载荷方式和对象方式进行分发
// 以载荷形式分发
store.dispatch('incrementAsync', {
  amount: 10
})

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

第二个参数为入参

actions: {
  checkout ({ commit, state }, products) {
    // 。。。
  }
}

1
2
3
4
5

在组件中分发 Action

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

mapActions 辅助函数

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')`
    }),
  },
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

组合 Action【不常用】

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

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

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

1
2
3
4
5
6
7
8
9
10

现在你可以：

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

1
2
3

在另外一个 action 中也可以：

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

1
2
3
4
5
6
7
8

最后，如果我们利用 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())
  }
}

1
2
3
4
5
6
7
8
9
10
11

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

# Action

# 解构写法

# 分发【触发】 Action

# action 内部执行异步操作

# 第二个参数为入参

# 在组件中分发 Action

# mapActions 辅助函数

# 组合 Action【不常用】