State
单一状态树
Vuex 使用单一状态树——是的,用一个对象就包含了全部的应用层级状态。至此它便作为一个“唯一数据源 (SSOT)”而存在。这也意味着,每个应用将仅仅包含一个 store 实例。单一状态树让我们能够直接地定位任一特定的状态片段,在调试的过程中也能轻易地取得整个当前应用状态的快照。
单状态树和模块化并不冲突——在后面的章节里我们会讨论如何将状态和状态变更事件分布到各个子模块中。
在 Vue 组件中获得 Vuex 状态
那么我们如何在 Vue 组件中展示状态呢?由于 Vuex 的状态存储是响应式的,从 store 实例中读取状态最简单的方法就是在计算属性中返回某个状态:
// 创建一个 Counter 组件constCounter={template:`
{{ count }}
`,computed:{count(){returnstore.state.count}}}
每当store.state.count变化的时候, 都会重新求取计算属性,并且触发更新相关联的 DOM。
然而,这种模式导致组件依赖全局状态单例。在模块化的构建系统中,在每个需要使用 state 的组件中需要频繁地导入,并且在测试组件时需要模拟状态。
Vuex 通过store选项,提供了一种机制将状态从根组件“注入”到每一个子组件中(需调用Vue.use(Vuex)):
constapp=newVue({el:'#app',// 把 store 对象提供给 “store” 选项,这可以把 store 的实例注入所有的子组件store,components:{Counter},template:`
`})
通过在根实例中注册store选项,该 store 实例会注入到根组件下的所有子组件中,且子组件能通过this.$store访问到。让我们更新下Counter的实现:
constCounter={template:`
{{ count }}
`,computed:{count(){returnthis.$store.state.count}}}
mapState辅助函数
当一个组件需要获取多个状态时候,将这些状态都声明为计算属性会有些重复和冗余。为了解决这个问题,我们可以使用mapState辅助函数帮助我们生成计算属性,让你少按几次键:
// 在单独构建的版本中辅助函数为 Vuex.mapStateimport{mapState}from'vuex'exportdefault{// ...computed:mapState({// 箭头函数可使代码更简练count:state=>state.count,// 传字符串参数 'count' 等同于 `state => state.count`countAlias:'count',// 为了能够使用 `this` 获取局部状态,必须使用常规函数countPlusLocalState(state){returnstate.count+this.localCount}})}
当映射的计算属性的名称与 state 的子节点名称相同时,我们也可以给mapState传一个字符串数组。
computed:mapState([// 映射 this.count 为 store.state.count'count'])
对象展开运算符
mapState函数返回的是一个对象。我们如何将它与局部计算属性混合使用呢?通常,我们需要使用一个工具函数将多个对象合并为一个,以使我们可以将最终对象传给computed属性。但是自从有了对象展开运算符(现处于 ECMASCript 提案 stage-3 阶段),我们可以极大地简化写法:
computed:{localComputed(){/* ... */},// 使用对象展开运算符将此对象混入到外部对象中...mapState({// ...})}
组件仍然保有局部状态
使用 Vuex 并不意味着你需要将所有的状态放入 Vuex。虽然将所有的状态放到 Vuex 会使状态变化更显式和易调试,但也会使代码变得冗长和不直观。如果有些状态严格属于单个组件,最好还是作为组件的局部状态。你应该根据你的应用开发需要进行权衡和确定。
Getter
有时候我们需要从 store 中的 state 中派生出一些状态,例如对列表进行过滤并计数:
computed:{doneTodosCount(){returnthis.$store.state.todos.filter(todo=>todo.done).length}}
如果有多个组件需要用到此属性,我们要么复制这个函数,或者抽取到一个共享函数然后在多处导入它——无论哪种方式都不是很理想。
Vuex 允许我们在 store 中定义“getter”(可以认为是 store 的计算属性)。就像计算属性一样,getter 的返回值会根据它的依赖被缓存起来,且只有当它的依赖值发生了改变才会被重新计算。
Getter 接受 state 作为其第一个参数:
conststore=newVuex.Store({state:{todos:[{id:1,text:'...',done:true},{id:2,text:'...',done:false}]},getters:{doneTodos:state=>{returnstate.todos.filter(todo=>todo.done)}}})
Getter 会暴露为store.getters对象:
store.getters.doneTodos// -> [{ id: 1, text: '...', done: true }]
Getter 也可以接受其他 getter 作为第二个参数:
getters:{// ...doneTodosCount:(state,getters)=>{returngetters.doneTodos.length}}
store.getters.doneTodosCount// -> 1
我们可以很容易地在任何组件中使用它:
computed:{doneTodosCount(){returnthis.$store.getters.doneTodosCount}}
你也可以通过让 getter 返回一个函数,来实现给 getter 传参。在你对 store 里的数组进行查询时非常有用。
getters:{// ...getTodoById:(state)=>(id)=>{returnstate.todos.find(todo=>todo.id===id)}}
store.getters.getTodoById(2)// -> { id: 2, text: '...', done: false }
mapGetters辅助函数
mapGetters辅助函数仅仅是将 store 中的 getter 映射到局部计算属性:
import{mapGetters}from'vuex'exportdefault{// ...computed:{// 使用对象展开运算符将 getter 混入 computed 对象中...mapGetters(['doneTodosCount','anotherGetter',// ...])}}
如果你想将一个 getter 属性另取一个名字,使用对象形式:
mapGetters({// 映射 `this.doneCount` 为 `store.getters.doneTodosCount`doneCount:'doneTodosCount'})
Mutation
更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。Vuex 中的 mutation 非常类似于事件:每个 mutation 都有一个字符串的事件类型 (type)和 一个回调函数 (handler)。这个回调函数就是我们实际进行状态更改的地方,并且它会接受 state 作为第一个参数:
conststore=newVuex.Store({state:{count:1},mutations:{increment(state){// 变更状态state.count++}}})
你不能直接调用一个 mutation handler。这个选项更像是事件注册:“当触发一个类型为increment的 mutation 时,调用此函数。”要唤醒一个 mutation handler,你需要以相应的 type 调用store.commit方法:
store.commit('increment')
提交载荷(Payload)
你可以向store.commit传入额外的参数,即 mutation 的载荷(payload):
// ...mutations:{increment(state,n){state.count+=n}}
store.commit('increment',10)
在大多数情况下,载荷应该是一个对象,这样可以包含多个字段并且记录的 mutation 会更易读:
// ...mutations:{increment(state,payload){state.count+=payload.amount}}
store.commit('increment',{amount:10})
对象风格的提交方式
提交 mutation 的另一种方式是直接使用包含type属性的对象:
store.commit({type:'increment',amount:10})
当使用对象风格的提交方式,整个对象都作为载荷传给 mutation 函数,因此 handler 保持不变:
mutations:{increment(state,payload){state.count+=payload.amount}}
Mutation 需遵守 Vue 的响应规则
既然 Vuex 的 store 中的状态是响应式的,那么当我们变更状态时,监视状态的 Vue 组件也会自动更新。这也意味着 Vuex 中的 mutation 也需要与使用 Vue 一样遵守一些注意事项:
最好提前在你的 store 中初始化好所有所需属性。
当需要在对象上添加新属性时,你应该
使用Vue.set(obj, 'newProp', 123), 或者
以新对象替换老对象。例如,利用 stage-3 的对象展开运算符我们可以这样写:
state.obj={...state.obj,newProp:123}
使用常量替代 Mutation 事件类型
使用常量替代 mutation 事件类型在各种 Flux 实现中是很常见的模式。这样可以使 linter 之类的工具发挥作用,同时把这些常量放在单独的文件中可以让你的代码合作者对整个 app 包含的 mutation 一目了然:
// mutation-types.jsexportconstSOME_MUTATION='SOME_MUTATION'
// store.jsimportVuexfrom'vuex'import{SOME_MUTATION}from'./mutation-types'conststore=newVuex.Store({state:{...},mutations:{// 我们可以使用 ES2015 风格的计算属性命名功能来使用一个常量作为函数名[SOME_MUTATION](state){// mutate state}}})
用不用常量取决于你——在需要多人协作的大型项目中,这会很有帮助。但如果你不喜欢,你完全可以不这样做。
Mutation 必须是同步函数
一条重要的原则就是要记住mutation 必须是同步函数。为什么?请参考下面的例子:
mutations:{someMutation(state){api.callAsyncMethod(()=>{state.count++})}}
现在想象,我们正在 debug 一个 app 并且观察 devtool 中的 mutation 日志。每一条 mutation 被记录,devtools 都需要捕捉到前一状态和后一状态的快照。然而,在上面的例子中 mutation 中的异步函数中的回调让这不可能完成:因为当 mutation 触发的时候,回调函数还没有被调用,devtools 不知道什么时候回调函数实际上被调用——实质上任何在回调函数中进行的的状态的改变都是不可追踪的。
在组件中提交 Mutation
你可以在组件中使用this.$store.commit('xxx')提交 mutation,或者使用mapMutations辅助函数将组件中的 methods 映射为store.commit调用(需要在根节点注入store)。
import{mapMutations}from'vuex'exportdefault{// ...methods:{...mapMutations(['increment',// 将 `this.increment()` 映射为 `this.$store.commit('increment')`// `mapMutations` 也支持载荷:'incrementBy'// 将 `this.incrementBy(amount)` 映射为 `this.$store.commit('incrementBy', amount)`]),...mapMutations({add:'increment'// 将 `this.add()` 映射为 `this.$store.commit('increment')`})}}
下一步:Action
在 mutation 中混合异步调用会导致你的程序很难调试。例如,当你能调用了两个包含异步回调的 mutation 来改变状态,你怎么知道什么时候回调和哪个先回调呢?这就是为什么我们要区分这两个概念。在 Vuex 中,mutation 都是同步事务:
store.commit('increment')// 任何由 "increment" 导致的状态变更都应该在此刻完成。。
actions
Action
Action 类似于 mutation,不同在于:
Action 提交的是 mutation,而不是直接变更状态。
Action 可以包含任意异步操作。
让我们来注册一个简单的 action:
conststore=newVuex.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){// 把当前购物车的物品备份起来constsavedCartItems=[...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,或者使用mapActions辅助函数将组件的 methods 映射为store.dispatch调用(需要先在根节点注入store):
import{mapActions}from'vuex'exportdefault{// ...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')`})}}
实现 action 内部执行异步操作
actions 支持载荷方式
对象方式进行分发
组合action....
研究中。。。。.