一、什么是vuex?
官方解释:
Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。
个人理解:
类似一个全局变量,其中包含了多个组件共享的状态,它是单例的,当其中一个组件变更共享的状态时,其他的组件能够得到最新的状态。
既然是状态管理,我们就要先弄清楚到底什么是状态。
状态其实就是数据,数据变更了,我们就说它的状态变更了,一个状态管理的应用包括以下三个部分:
- state:真正的数据(状态)
- view:将数据展示到页面上方式(视图)
- actions:函数、方法,可以理解为改变数据的方式
new Vue({
// state
data () {
return {
count: 0
}
},
// view
template: `
<div>{{ count }}</div>
`,
// actions
methods: {
increment () {
this.count++
}
}
})
他们三者之间的关系是这样的,用户根据页面上数据的展示(view),可以进行一定的操作(action),例如点击增加按钮,触发加法函数,将页面上的数据+1(state),数据改变后,浏览器会将新的数据重新展示到页面上(view),这就形成了一个单向数据流的概念。
但是当我们的组件多了之后,很有可能多个组件使用了同一个共享的数据(依赖于同一状态),在多个页面上用户也有多种方式(action)去改变这一数据(状态)。
如果没有vuex,我们可以将数据(状态)拷贝多份,然后使用多层嵌套来完成数据(状态)的传递和同步,但是显而易见这会使得代码臃肿无法维护,况且无法解决兄弟组件之间状态传递的问题。
于是便出现了vuex。
这就很好理解为什么我们要把组件的状态抽离出来单独管理,主要是为了解决以下问题:
- 兄弟组件之间的通信
- 开发大型应用的时候,多个组件共享状态会破坏单项数据流的简洁性。
但是如果是一个小型应用的话,使用【store模式】就足够了,使用vuex会有点大炮打蚊子的感觉。
二、vuex的五个核心概念
一个vuex应用的核心就是store(仓库),可以理解为一个容器,它通过把大部分状态存放到这个容器中进行管理。vuex和单纯的全局对象有以下两点不同:
- Vuex 的状态存储是响应式的。也就是说有一个组件变更了vuex中的状态时,其他相关组件中的状态都会得到更新。
- 不能直接对store中的状态进行操作。要改变其中的状态只能通过显式的提交(commit)mutation。这样做的目的是为了让我们更方便的跟踪状态的变化,进行debug等操作。
一个简单的case:
在store文件夹下新建个index.js
文件(命名无所谓,不建store文件夹也可以)
//index.js
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
export default new Vuex.Store({
state: {
count: 0
},
mutations: {
increment (state) {
state.count++
}
}
})
main.js
import store from './store/index';
new Vue({
el:'#app',
router,
store,
render: h=> h(App)
});
在组件中进行状态变更
methods: {
increment() {
this.$store.commit('increment')
console.log(this.$store.state.count)
}
}
1.State
vuex中的状态是一颗单一状态树
,也就是说每个应用仅包含一个store实例,一个单例对象便包含了全部的应用层级状态。
单状态树和模块化不冲突!
获取vuex状态
在vue的组件中,如果想要获取vuex中的状态,可以通过以下的方式:
Counter组件:
//Counter
const Counter = {
template: `<div>{{ count }}</div>`,
computed: {
count () {
//获取count
return store.state.count
}
}
}
前面说过,当状态state发生变化后,相关联的组件都会更新到最新的状态。在模块化的系统中,由于每个使用到state的组件都依赖全局状态单例,就会导致state在组件中频繁的导入
。
为了解决这个问题,vuex提供了一种机制将全局状态单例从根组件"注入"到每一个子组件中
,使用方式如下:
在/store/index.js
中调用Vue.use(Vues)
//index.js
Vue.use(Vuex)
然后在根组件中通过store选项将store实例注入所有的子组件
//main.js
new Vue({
el: '#app',
// 把 store 对象提供给 “store” 选项,这可以把 store 的实例注入所有的子组件
store,
components: { Counter },
template: `
<div class="app">
<counter></counter>
</div>
`
})
注入完成后,子组件就可以通过this.$store
进行访问,新的Counter实现如下:
const Counter = {
template: `<div>{{ count }}</div>`,
computed: {
count () {
return this.$store.state.count
}
}
}
对比下两种访问方式:
//注入之前
store.state.count
//注入之后
this.$store.state.count
注意:我们不需要将所有的状态都放入vuex。虽然将所有的状态放到 Vuex 会使状态变化更显式和易调试,但也会使代码变得冗长和不直观。如果有些状态严格属于单个组件,最好还是作为组件的局部状态。
2.Getters
类似于computed(计算属性,对现有的状态进行计算得到新的数据——>派生 )
Getter 会暴露为 store.getters
对象,你可以以属性的形式访问这些值:
const store = new Vuex.Store({
state: {
todos: [
{ id: 1, text: '...', done: true },
{ id: 2, text: '...', done: false }
]
},
getters: {
doneTodos: state => {
return state.todos.filter(todo => todo.done)
}
}
})
//访问方式
store.getters.doneTodos
看了下公司的使用方式略有不同,使用方式如下:
//getter.js
const getters = {
sidebar: state => state.app.sidebar,
size: state => state.app.size
}
export default getters
//访问方式
store.getters.size
3.Mutations
(1)概念理解
更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。mutation可以理解为事件,每个 mutation 都有一个字符串的 事件类型 (type) 和 一个 回调函数 (handler)。这个回调函数就是我们实际进行状态更改的地方,并且它会接受 state 作为第一个参数。
const store = new Vuex.Store({
state: {
count: 1
},
mutations: {
increment (state) {
// 变更状态
state.count++
}
}
})
在上面这个例子中,事件类型就是'increment'
,回调函数就是increment函数
。
在我们commit时会调用 mutation handler去执行此函数,但是不能直接调用handler。
(2)commit提交的两种方式
- commit(type: string, payload?: any, options?: Object)
第一种是以string方式进行提交,如下文'increment'
。
在我们进行commit时,除了默认的state,我们还可以传入额外的参数,这个额外的参数成为载荷payload,payload一般作为一个对象进行传递。
// ...
mutations: {
increment (state, payload) {
state.count += payload.amount
}
}
store.commit('increment', {
amount: 10
})
- commit(mutation: Object, options?: Object)
第二种是以对象方式进行提交。当以这种方式提交时,整个对象都作为载荷payload传给 mutation 函数,因此 handler 保持不变。
mutations: {
increment (state, payload) {
state.count += payload.amount
}
}
store.commit({
type: 'increment',
amount: 10
})
注意:mutation中必须是同步函数!
我们不直接修改state,而是通过先commit的方式,本质上就是为了便于对state中的状态进行追踪。而如果mutation中是异步函数的话,我们无法得知什么时候回调函数会被调用,这就违背了我们要对状态进行追踪的理念。
4.Actions
action和mutation类似,但是有以下两点不同:
- action 提交的是 mutation,而不是直接变更状态
- action 可以包含任意异步操作
一个简单的case:
/store/index.js
const store = new Vuex.Store({
state: {
count: 0
},
mutations: {
increment (state) {
state.count++
}
},
actions: {
increment (context) {
context.commit('increment')
}
}
})
Action 函数接受一个与 store 实例具有相同方法和属性的 context 对象(包含{state,getters,commit}等属性),因此你可以调用 context.commit 提交一个 mutation,或者通过 context.state 和 context.getters 来获取 state 和 getters。下面介绍到 modules时,我们会知道 context 对象为什么不是 store 实例本身。
实际中我们在使用时经常会通过参数解构来简化代码,尤其是需要多次commit的时候,写法如下:
actions: {
increment ({ commit }) {
commit('increment')
}
}
由于mutation中不能包含异步操作,所以我们使用actions来执行一些异步操作,并且通过commit记录状态的变更。
actions: {
checkout ({ commit, state }, products) {
// 把当前购物车的物品备份起来
const savedCartItems = [...state.cart.added]
// 发出结账请求,然后乐观地清空购物车
commit(types.CHECKOUT_REQUEST)
// 购物 API 接受一个成功回调和一个失败回调
shop.buyProducts(
products,
// 成功操作
() => commit(types.CHECKOUT_SUCCESS),
// 失败操作
() => commit(types.CHECKOUT_FAILURE, savedCartItems)
)
}
}
在组件中的使用方式如下:
store.dispatch('checkout',products)
//或者
this.$store.dispatch('checkout',products);
store.dispatch
可以处理被触发的 action 的处理函数返回的 Promise,并且 store.dispatch
仍旧返回 Promise。一个 store.dispatch
在不同模块中可以触发多个 action 函数。在这种情况下,只有当所有触发函数完成后,返回的 Promise 才会执行。
一个store实例具有的方法和属性如下:
属性:
- state:Object类型,根状态,只读
- getters:Object类型,暴露出注册的getter,只读
方法:
- commit:用来提交mutation,有以下两种使用方式。
commit(type: string, payload?: any, options?: Object)
commit(mutation: Object, options?: Object)
payload表示携带的参数,options是对象类型,其中可以包含 root:true,它允许在命名空间模块里提交根的 mutation,在提交mutation时是以对象方式提交的。
- dispatch:分发 action,返回一个解析所有被触发的 action 处理器的 Promise。
dispatch(type: string, payload?: any, options?: Object): Promise
dispatch(action: Object, options?: Object): Promise
- replaceState:替换 store 的根状态,仅用状态合并或时光旅行调试。
replaceState(state: Object)
- watch:响应式地侦听 fn 的返回值,当值改变时调用回调函数。fn 接收 store 的 state 作为第一个参数,其 getter 作为第二个参数。最后接收一个可选的对象参数表示 Vue 的vm.$watch(opens new window) 方法的参数。调用此方法返回的函数即可停止侦听。
watch(fn: Function, callback: Function, options?: Object): Function
- subscribe
- subscribeAction
- registerModule
- unregisterModule
- hasModule
- hotUpdate
详情请见官网:https://v3.vuex.vuejs.org/zh/api/#vuex-store
5.Modules
(1)介绍
我们知道vuex使用一个状态树的全局实例对象store来管理所有的状态state,例如在store文件夹下创建的index.js文件。但是随着state越来越多,如果全部放到一个文件中会使代码显得十分臃肿,不易于维护。
于是我们可以创建一个store/modules
文件夹,然后根据业务需求创建不同的.js文件,也就是将store对象模块化。如下图所示:
(2)访问数据的方式
访问state/mutations(actions)
的方式分两种情况。
方式一:对于最外层中的数据
-
state:this.$store.state.name
-
mutations/actions:this.$store.commit/dispatch(‘name’)
如果我们以这种方式进行commit/dispatch,vuex会对所有actions和mutations中的方法进行匹配。也就是说如果不同模块中有同名的方法,会导致方法同时调用。如果我们要单独调用模块中的方法,现需要使用方式二。
方式二:对于模块中的数据
-
state:this.$store.state.moduleName.name
-
mutations/actions:this.$store.commit/dispatch(‘moduleName/name’)
使用此方式调用方法的时候,需要我们在定义模块的时候添加上namespaced:true属性。
所谓namespaced就是命名空间,默认模块内的action、mutation等是注册在全局命名空间,这样多个模块能够对同一 mutation 或 action 作出响应。将其设置为true后,模块就成为了带命名空间的模块,拥有更高的封装度和复用性。