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。当我们在之后介绍到 Modules时,你就知道 context 对象为什么不是 store 实例本身了
实践中,我们会经常用到 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 savedCartItems = [...state.cart.added]
// 发出结账请求,然后乐观地清空购物车
commit(type.CHECKOUT_REQUEST)
// 购物 API 接收一个成功回调和一个失败回调
shop.butProductes(
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'
})
}
}
组合 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 才会执行