vue的入门
按照官方的说法,vuex的定义是
官方文档查传送门
Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化。
按照官方的说法,状态管理模式是什么,我们看一下官方给出的一个例子
new Vue({
// state
data () {
return {
count: 0
}
},
// view
template: `
<div>{{ count }}</div>
`,
// actions
methods: {
increment () {
this.count++
}
}
})
这个状态自管理应用包含以下几个部分:
- state,驱动应用的数据源;
- view,以声明方式将 state 映射到视图;
- actions,响应在 view 上的用户输入导致的状态变化。
以上是一个简单的单向数据流,但是当我们的应用遇到多个组件共享状态时,单向数据流的简洁性很容易被破坏:
包括
- 多个视图依赖于同一状态。
- 来自不同视图的行为需要变更同一状态。
故针对以上场景,我们可以定义和隔离状态管理中的各种概念并通过强制规则维持视图和状态间的独立性,我们的代码将会变得更结构化且易维护。这就是 Vuex 背后的基本思想,借鉴了 Flux、Redux 和 The Elm Architecture。与其他模式不同的是,Vuex 是专门为 Vue.js 设计的状态管理库,以利用 Vue.js 的细粒度数据响应机制来进行高效的状态更新。
什么场景下我们一般会使用vuex呢
官方的说法比较详细,我再次总结一下,当我们开发大型单页应用时,涉及到多个组件共享同一个状态,或者多个组件操作同一个状态时,我们此时会需要vuex帮助我们管理数据。
vuex的简单介绍
每一个 Vuex 应用的核心就是 store(仓库),store中包含了全局共享的变量(state),以及改变state的mutation操作,action操作,和getter类似于计算属性的操作。我们需要记住2条Vuex跟普通全局对象的区别:
- state 包含的变量是响应式的,如果组件引用了state, 若 store 中的状态发生变化,那么相应的组件也会相应地得到高效更新。
- 我们不能直接修改 state 的变量 ,必须通过显示的mutation(commit)。
下面是一个简单的store
const store = new Vuex.Store({
state: {
count: 0
},
mutations: {
increment (state) {
state.count++
}
}
})
下面我们分别介绍下,vuex 中几个核型概念
State
vue组件是如何集成store?的呢
Vuex 通过 store 选项,提供了一种机制将状态从根组件“注入”到每一个子组件中(需调用 Vue.use(Vuex))
const app = new Vue({
el: '#app',
// 把 store 对象提供给 “store” 选项,这可以把 store 的实例注入所有的子组件
store,
components: { Counter },
template: `
<div class="app">
<counter></counter>
</div>
`
})
通过在根实例中注册 store 选项,该 store 实例会注入到根组件下的所有子组件中,且子组件能通过 this.$store 访问到。让我们更新下 Counter 的实现:
const Counter = {
template: `<div>{{ count }}</div>`,
computed: {
count () {
return this.$store.state.count
}
}
}
vue给我们提供了一个简单的函数,mapState 辅助函数,来帮组我们简化获取state的操作
以对象的形式:
// 在单独构建的版本中辅助函数为 Vuex.mapState
import { mapState } from 'vuex'
export default {
// ...
computed: mapState({
// 箭头函数可使代码更简练
count: state => state.count,
// 传字符串参数 'count' 等同于 `state => state.count`
// 添加一个别名
countAlias: 'count',
// 为了能够使用 `this` 获取局部状态,必须使用常规函数
countPlusLocalState (state) {
return state.count + this.localCount
}
})
}
以数组的形式:
当映射的计算属性的名称与 state 的子节点名称相同时,我们也可以给 mapState 传一个字符串数组。
computed: mapState([
// 映射 this.count 为 store.state.count
'count'
])
此时有一个问题,mapState() 返回的是一个对象,我们如何跟组件内计算属性混合使用呢?
答案是使用对象展开运算符
computed: {
localComputed () { /* ... */ },
// 使用对象展开运算符将此对象混入到外部对象中
...mapState({
// ...
})
}
Getter
简单一点说:state中的属性类似于vue单文件组件中data里的属性,都是响应式的。getter类似于单文件组件的计算属性,getter的返回值会根据他的依赖被缓存起来,只有当他的依赖值发生改变的时候,才会重新计算。依赖值就是state的属性。getter可以对state做一些特定逻辑的处理。当然getter也是响应式的。
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 // -> [{ id: 1, text: '...', done: true }]
// 可以接受其他getter
getters: {
// ...
doneTodosCount: (state, getters) => {
return getters.doneTodos.length
}
}
- 通过方法访问
你也可以通过让 getter 返回一个函数,来实现给 getter 传参。在你对 store 里的数组进行查询时非常有用。
getters: {
// ...
getTodoById: (state) => (id) => {
return state.todos.find(todo => todo.id === id)
}
}
store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }
mapGetters简写用法
以数组的形式: 计算属性跟getter 属性同名的情况下
import { mapGetters } from 'vuex'
export default {
// ...
computed: {
// 使用对象展开运算符将 getter 混入 computed 对象中
...mapGetters([
'doneTodosCount',
'anotherGetter',
// ...
])
}
}
以对象的形式: 可以给getter起一个别名
...mapGetters({
// 把 `this.doneCount` 映射为 `this.$store.getters.doneTodosCount`
doneCount: 'doneTodosCount'
})
mutation
唯一能改变state状态的操作,并且是同步操作,每个 mutation 都有一个字符串的 事件类型 (type) 和 一个 回调函数 (handler)。这个回调函数就是我们实际进行状态更改的地方,并且它会接受 state 作为第一个参数:
const store = new Vuex.Store({
state: {
count: 1
},
mutations: {
increment (state) {
// 变更状态
state.count++
}
}
})
mutation 可以传递参数?
第二个参数可以用于传参
mutations: {
increment (state, n) {
state.count += n
}
}
store.commit('increment', 10)
mutation 以对象方式提交
当使用对象风格的提交方式,整个对象都作为参数传给 mutation 函数,因此 handler 保持不变:
store.commit({
type: 'increment',
amount: 10
})
mutations: {
increment (state, payload) {
state.count += payload.amount
}
}
注意点
- 最好提前在你的 store 中初始化好所有所需属性。
- 需要在对象上添加新属性时,你应该
- 使用 Vue.set(obj, 'newProp', 123), 或者
- 以新对象替换老对象。例如,利用对象展开运算符我们可以这样写:
state.obj = { ...state.obj, newProp: 123 }
mapMutations简写
例子中包含了数组与对象的形式
import { mapMutations } from 'vuex'
export default {
// ...
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
action 不能直接操作state数据,必须通过mutation间接的去改变state数据。一个action 可以操作多个mutation,也可以进行异步操作。
const store = new Vuex.Store({
state: {
count: 0
},
mutations: {
increment (state) {
state.count++
}
},
actions: {
increment (context) {
context.commit('increment')
}
}
})
通过es6解构,我们可以这么使用
actions: {
increment ({ commit }) {
commit('increment')
}
}
action 如何使用
store.dispatch('increment')
执行异步操作
actions: {
incrementAsync ({ commit }) {
setTimeout(() => {
commit('increment')
}, 1000)
}
}
如何传递参数
// 传递一个参数
store.dispatch('incrementAsync', {
amount: 10
})
// 以对象形式分发
store.dispatch({
type: 'incrementAsync',
amount: 10
})
mapActions 简写
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' // 将 `this.add()` 映射为 `this.$store.dispatch('increment')`
})
}
}
注意
需要明白 store.dispatch 可以处理被触发的 action 的处理函数返回的 Promise,并且 store.dispatch 仍旧返回 Promise:所以我们可以串联使用,在一个action 里可以包含另一个action。
actions: {
actionA ({ commit }) {
return new Promise((resolve, reject) => {
setTimeout(() => {
commit('someMutation')
resolve()
}, 1000)
})
}
}
store.dispatch('actionA').then(() => {
// ...
})
actions: {
// ...
actionB ({ dispatch, commit }) {
return dispatch('actionA').then(() => {
commit('someOtherMutation')
})
}
}
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())
}
}
注意:
一个 store.dispatch 在不同模块中可以触发多个 action 函数。在这种情况下,只有当所有触发函数完成后,返回的 Promise 才会执行。
vuex的深入
由于使用单一状态树,应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时,store 对象就有可能变得相当臃肿。更详细的请移步官网对Module的讲解
官网已经讲的非常详细了,我这里根据官网的内容以更简洁便于记忆的角度去梳理一下,如果是初学者,建议直接看移步官网,传送门在此Module
就是为了解决臃肿的问题,Vuex 允许我们将 store 分割成模块(module)。每个模块拥有自己的 state、mutation、action、getter、甚至是嵌套子模块——从上至下进行同样方式的分割:
const moduleA = {
state: {
a: 1
},
mutations: { ... },
actions: { ... },
getters: { ... }
}
const moduleB = {
state: {
b: 1
},
mutations: { ... },
actions: { ... }
}
const store = new Vuex.Store({
modules: {
moduleA,
moduleB
}
})
store.state.a // -> moduleA 的状态
store.state.b // -> moduleB 的状态
模块的局部状态
对于模块内部的 mutation 和 getter,接收的第一个参数是模块的局部状态对象。
const moduleA = {
state: { count: 0 },
mutations: {
increment (state) {
// 这里的 `state` 对象是模块的局部状态
state.count++
}
},
getters: {
doubleCount (state) {
return state.count * 2
}
}
}
对于模块内部的 action,局部状态通过 context.state 暴露出来,根节点状态则为 context.rootState
const moduleA = {
// ...
actions: {
incrementIfOddOnRootSum ({ state, commit, rootState }) {
if ((state.count + rootState.count) % 2 === 1) {
commit('increment')
}
}
}
}
对于模块内部的 getter,根节点状态会作为第三个参数暴露出来:
const moduleA = {
// ...
getters: {
sumWithRootCount (state, getters, rootState) {
return state.count + rootState.count
}
}
}
命名空间:
关于命名空间,我觉得官网讲解的并不是明白,根据实际的项目经验,我简单总结了一下命名空间的作用
- 如果加了namespaced: true,则必须以嵌套命名空间的形式访问
- 如果没有设置,则可以直接访问,但是要注意名称的冲突
- 启用了命名空间的 getter 和 action 会收到局部化的 getter,dispatch 和 commit,换言之,你在使用模块内容(module assets)时不需要在同一模块内额外添加空间名前缀。
const store = new Vuex.Store({
modules: {
account: {
namespaced: true,
// 模块内容(module assets)
state: { ... },
getters: {
isAdmin () { ... } // -> getters['account/isAdmin']
},
actions: {
login () { ... } // -> dispatch('account/login')
},
mutations: {
login () { ... } // -> commit('account/login')
},
// 嵌套模块
modules: {
// 继承父模块的命名空间
myPage: {
state: { ... },
getters: {
profile () { ... } // -> getters['account/profile']
}
},
// 进一步嵌套命名空间
posts: {
namespaced: true,
state: { ... },
getters: {
popular () { ... } // -> getters['account/posts/popular']
}
}
}
}
}
})
几种特殊高阶用法
在带命名空间的模块内访问全局内容(Global Assets)
如果你希望使用全局 state 和 getter,rootState 和 rootGetters 会作为第三和第四参数传入 getter,也会通过 context 对象的属性传入 action。
若需要在全局命名空间内分发 action 或提交 mutation,将 { root: true } 作为第三参数传给 dispatch 或 commit 即可。
modules: {
foo: {
namespaced: true,
getters: {
// 在这个模块的 getter 中,`getters` 被局部化了
// 你可以使用 getter 的第四个参数来调用 `rootGetters`
someGetter (state, getters, rootState, rootGetters) {
getters.someOtherGetter // -> 'foo/someOtherGetter'
rootGetters.someOtherGetter // -> 'someOtherGetter'
},
someOtherGetter: state => { ... }
},
actions: {
// 在这个模块中, dispatch 和 commit 也被局部化了
// 他们可以接受 `root` 属性以访问根 dispatch 或 commit
someAction ({ dispatch, commit, getters, rootGetters }) {
getters.someGetter // -> 'foo/someGetter'
rootGetters.someGetter // -> 'someGetter'
dispatch('someOtherAction') // -> 'foo/someOtherAction'
dispatch('someOtherAction', null, { root: true }) // -> 'someOtherAction'
commit('someMutation') // -> 'foo/someMutation'
commit('someMutation', null, { root: true }) // -> 'someMutation'
},
someOtherAction (ctx, payload) { ... }
}
}
}
带命名空间的访问
computed: {
...mapState('some/nested/module', {
a: state => state.a,
b: state => state.b
})
},
methods: {
...mapActions('some/nested/module', [
'foo', // -> this.foo()
'bar' // -> this.bar()
])
}
当然如果组件中只使用了某一个模块的store: 你可以通过使用 createNamespacedHelpers 创建基于某个命名空间辅助函数。它返回一个对象,对象里有新的绑定在给定命名空间值上的组件绑定辅助函数:
import { createNamespacedHelpers } from 'vuex'
const { mapState, mapActions } = createNamespacedHelpers('some/nested/module')
export default {
computed: {
// 在 `some/nested/module` 中查找
...mapState({
a: state => state.a,
b: state => state.b
})
},
methods: {
// 在 `some/nested/module` 中查找
...mapActions([
'foo',
'bar'
])
}
}
分享一些关于命名空间的用法
如果一个组件中既使用了根的store,又使用了模块的store,这种情况下建议不要使用createNamespacedHelpers,正常引用就像:
import { mapGetters, mapMutations } from 'vuex'
对于这种场景的使用方式我们有2中方法:
- 以对象的形式: 可以重命名,但是需要注意与根root命名区分
...mapGetters({
// 根模块的
grayStatusBit: 'grayStatusBit',
// apply 模块的
approvalOpinion: 'apply/approvalOpinion',
identityOpinion: 'apply/identityOpinion'
}),
引用方式为: 对象的方式引用比较简单,不用加命名空间路径
this.grayStatusBit
this.approvalOpinion()
this.identityOpinion()
- 以数组的形式:以数组的形式不能重命名,引用起来比较麻烦
...mapMutations([
'apply/setApprovalOpinion',
'apply/setIdentityOpinion'
]),
引用方式为: 数组的方式引用需要加命名空间路径
this['apply/setApprovalOpinion'](list)
this[ 'apply/setIdentityOpinion'](list)
依次类推,getter ,state,action 应该都是一样的规则
模块的动态注册
在 store 创建之后,你可以使用 store.registerModule 方法注册模块:
// 注册模块 `myModule`
store.registerModule('myModule', {
// ...
})
// 注册嵌套模块 `nested/myModule`
store.registerModule(['nested', 'myModule'], {
// ...
})
你也可以使用 store.unregisterModule(moduleName) 来动态卸载模块。注意,你不能使用此方法卸载静态模块(即创建 store 时声明的模块)。
最后说明一下常用的表单处理:
原文传送门
背景描述:
<input v-model="obj.message">
假设这里的obj是计算属性mapState 返回的对象,在用户输入时,v-model 会试图直接修改 obj.message,这样就不符合我们的规定,state属性的改变只能通过mutation,并且在严格模式中,vue直接会抛出错误。
那我们应该怎么处理呢?
<input :value="message" @input="updateMessage">
// ...
computed: {
...mapState({
message: state => state.obj.message
})
},
methods: {
updateMessage (e) {
this.$store.commit('updateMessage', e.target.value)
}
}
mutations: {
updateMessage (state, message) {
state.obj.message = message
}
}
但是以上的写法比较啰嗦,我们尝试以v-model的方式试试:
<input v-model="message">
// ...
computed: {
message: {
get () {
return this.$store.state.obj.message
},
set (value) {
this.$store.commit('updateMessage', value)
}
}
}