Vuex 学习5 - 核心概念Action

Action

教程来自 Vuex 官网：https://vuex.vuejs.org/zh/guide/actions.html

在 mutation 中混合异步调用会使的你的程序很难调试。例如，当你调用了两个包含异步回调的 mutation 来改变状态，你怎么知道什么时候回调和哪个先回调呢？这就是为什么我们区分这两个概念。在 Vuex 中， mutation 都是同步事务。任何状态更新都必须在提交 mutation 的那一刻完成。

为了处理异步操作，Vuex 提供了 Action

Action 类似于 mutation，不同在于：

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

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

import Vue from 'vue';
import Vuex from 'vuex';
import MUTATIONS_TYPE from './mutation-types';
Vue.use(Vuex);

const add = MUTATIONS_TYPE.add;
const reduce = MUTATIONS_TYPE.reduce;

const state = {
    count: 1,
};

const mutations = {
    [add](state, n) {
        state.count += n;
    },
    [reduce](state, payload) {
        state.count -= payload.amount;
    }
}

const actions = {
    [reduce](context, payload) {
        context.commit('reduce', payload.amount);
    }
}

export default new Vuex.Store({
    state,
    mutations,
    actions,
})

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

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

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

分发 Action

Action 通过 store.dispatch 方法触发（这一点与 redux 相似）：

store.dispatch('add');

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

actions: {
    addAsync({ commit }) {
        setTimeout(() => {
            commit('add');
        }, 1000)
    }
}

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

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

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

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

action: {
    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, savedCartItems)
        )
    }
}

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

在组件中分发 Action

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

<template>
    <div> 
        <hr />
        <h3>{{ count }}</h3>
        <p><button @click="add(5)">增加</button></p>
        <p><button @click="reduceAsync({amount: 10})">减少</button></p>
        <hr />
    </div>
</template>

<script>
import { mapState, mapGetters, mapMutations, mapActions } from 'vuex';
export default {
    name: 'Count',
    computed: {
        ...mapState({
            count: state => state.count,
        }),
    },
    methods : {
        localMethods() {
            alert('这个本地方法');
        },
        ...mapMutations({
            add: 'add',
            reduce: 'reduce',
        }),
        ...mapActions(['reduceAsync'])
    }
}
</script>

组合 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('getOtherData', await getOtherData())
    }
}

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

一个小例子

// store.js
import Vue from 'vue';
import Vuex from 'vuex';
import MUTATIONS_TYPE from './mutation-types';
Vue.use(Vuex);

const add = MUTATIONS_TYPE.add;
const reduce = MUTATIONS_TYPE.reduce;

const state = {
    count: 1;
};

const mutations = {
    [add](state, n) {
        state.count += n;
    },
    [reduce](state, payload) {
        state.count -= payload.amount;
    }
}

const actions = {
    reduceAsync(context, payload) {
        setTimeout(() => {
            context.commit('reduce', payload);
        }, 1000)
    },
}

export default new Vuex.Store({
    state,
    mutations,
    actions,
})

<template>
    <div> 
        <hr />
        <h3>{{ count }}</h3>
        <p><button @click="add(5)">增加</button></p>
        <p><button @click="reduceAsync({amount: 10})">减少</button></p>
        <hr />
    </div>
</template>

<script>
import { mapState, mapGetters, mapMutations, mapActions } from 'vuex';
export default {
    name: 'Count',
    computed: {
        ...mapState({
            count: state => state.count,
        }),
    },
    methods : {
        localMethods() {
            alert('这个本地方法');
        },
        ...mapMutations({
            add: 'add',
        }),
        ...mapActions(['reduceAsync'])
        // ...mapMutations(['add', 'reduce']),
    }
}
</script>