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....? ?
? ? ? ? ? ? 研究中。。。。.