在 Vue 的单页面应用中使用,须要使用Vue.use(Vuex)
调用插件。
使用很是简单,只须要将其注入到Vue根实例中。javascript
import Vuex from 'vuex' Vue.use(Vuex) const store = new Vuex.Store({ state: { count: 0 }, getter: { doneTodos: (state, getters) => { return state.todos.filter(todo => todo.done) } }, mutations: { increment (state, payload) { state.count++ } }, actions: { addCount(context) { // 能够包含异步操做 // context 是一个与 store 实例具备相同方法和属性的 context 对象 } } }) // 注入到根实例 new Vue({ el: '#app', store, template: '<App/>', components: { App } })
而后改变状态:vue
this.$store.commit('increment')
Vuex 主要有四部分:java
store
中存储的各个状态。store
中状态的执行者。Vuex 使用 state
来存储应用中须要共享的状态。为了能让 Vue 组件在 state
更改后也随着更改,须要基于state
建立计算属性。vuex
const Counter = { template: `<div>{{ count }}</div>`, computed: { count () { return this.$store.state.count // count 为某个状态 } } }
相似于 Vue 中的 计算属性,能够在因此来的其余 state
或者 getter
改变后自动改变。
每一个getter
方法接受 state
和其余getters
做为前两个参数。数组
getters: { doneTodos: (state, getters) => { return state.todos.filter(todo => todo.done) } }
前面两个都是状态值自己,mutations
才是改变状态的执行者。mutations
用于同步地更改状态promise
// ... mutations: { increment (state, n) { state.count += n } }
其中,第一个参数是state
,后面的其余参数是发起mutation
时传入的参数。app
this.$store.commit('increment', 10)
commit
方法的第一个参数是要发起的mutation
名称,后面的参数均当作额外数据传入mutation
定义的方法中。
规范的发起mutation
的方式以下:异步
store.commit({ type: 'increment', amount: 10 //这是额外的参数 })
额外的参数会封装进一个对象,做为第二个参数传入mutation
定义的方法中。async
mutations: { increment (state, payload) { state.count += payload.amount } }
想要异步地更改状态,须要使用action
。action
并不直接改变state
,而是发起mutation
。函数
actions: { incrementAsync ({ commit }) { setTimeout(() => { commit('increment') }, 1000) } }
发起action
的方法形式和发起mutation
同样,只是换了个名字dispatch
。
// 以对象形式分发 store.dispatch({ type: 'incrementAsync', amount: 10 })
想要使用action
处理异步工做很简单,只须要将异步操做放到action
中执行(如上面代码中的setTimeout
)。
要想在异步操做完成后继续进行相应的流程操做,有两种方式:
action
返回一个 promise
。dispatch
方法的本质也就是返回相应的action
的执行结果。因此dispatch
也返回一个promise
。
store.dispatch('actionA').then(() => { // ... })
2. 利用async/await
。代码更加简洁。
// 假设 getData() 和 getOtherData() 返回的是 Promise actions: { async actionA ({ commit }) { commit('gotData', await getData()) }, async actionB ({ dispatch, commit }) { await dispatch('actionA') // 等待 actionA 完成 commit('gotOtherData', await getOtherData()) } }
将state
和getter
结合进组件须要使用计算属性:
computed: { count () { return this.$store.state.count // 或者 return this.$store.getter.count2 } }
将mutation
和action
结合进组件,须要在methods
中调用this.$store.commit()
或者this.$store.commit()
:
methods: { changeDate () { this.$store.commit('change'); }, changeDateAsync () { this.$store.commit('changeAsync'); } }
为了简便起见,Vuex 提供了四个方法用来方便的将这些功能结合进组件。
mapState
mapGetters
mapMutations
mapActions
示例代码:
import { mapState, mapGetters, mapMutations, mapActions } from 'vuex' // .... computed: { localComputed () { /* ... */ }, ...mapState({ // 为了可以使用 `this` 获取局部状态,必须使用常规函数 count(state) { return state.count + this.localCount } }), ...mapGetters({ getterCount(state, getters) { return state.count + this.localCount } }) } methods: { ...mapMutations({ add: 'increment' // 将 `this.add()` 映射为`this.$store.commit('increment')` }), ...mapActions({ add: 'increment' // 将 `this.add()` 映射为 `this.$store.dispatch('increment')` }) }
若是结合进组件以后不想改变名字,能够直接使用数组的方式。
methods: { ...mapActions([ 'increment', // 将 `this.increment()` 映射为 `this.$store.dispatch('increment')` // `mapActions` 也支持载荷: 'incrementBy' // 将 `this.incrementBy(amount)` 映射为 `this.$store.dispatch('incrementBy', amount)` ]), }
store
分割为模块。能够将应用的store
分割为小模块,每一个模块也都拥有全部的东西:state
, getters
, mutations
, actions
。
首先建立子模块的文件:
// initial state const state = { added: [], checkoutStatus: null } // getters const getters = { checkoutStatus: state => state.checkoutStatus } // actions const actions = { checkout ({ commit, state }, products) { } } // mutations const mutations = { mutation1 (state, { id }) { } } export default { state, getters, actions, mutations }
而后在总模块中引入:
import Vuex from 'vuex' import products from './modules/products' //引入子模块 Vue.use(Vuex) export default new Vuex.Store({ modules: { products // 添加进模块中 } })
其实还存在命名空间的概念,大型应用会使用。须要时查看文档便可。Vuex的基本使用大体如此。