一文学会Vuex 2状态管理：掌握State、Getter、Mutation、Action和Module等关键概念

狗蛋的博客之旅

已于 2023-05-21 09:56:55 修改

阅读量921

点赞数

分类专栏： Vue2 文章标签： vue.js javascript 前端

于 2022-09-29 12:01:50 首次发布

本文链接：https://blog.csdn.net/weixin_43263566/article/details/127102395

版权

Vue2 专栏收录该内容

20 篇文章 1 订阅

订阅专栏

Vuex是一个专为Vue.js应用程序设计的状态管理模式，它集中管理应用状态并确保状态以可预测的方式变化。核心概念包括：State（单一状态树），Getter（计算属性），Mutation（同步更新状态）和Action（处理异步操作）。通过定义模块和使用命名空间，Vuex允许开发者更好地组织和管理复杂应用的状态。

摘要由CSDN通过智能技术生成

参考来源：Vuex

Vuex 是什么？

Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态，并以相应的规则保证状态以一种可预测的方式发生变化。Vuex 也集成到 Vue 的官方调试工具 devtools extension (opens new window)，提供了诸如零配置的 time-travel 调试、状态快照导入导出等高级调试功能。

什么是“状态管理模式”

让我们从一个简单的 Vue 计数应用开始：

const Counter = {
  // 状态
  data () {
    return {
      count: 0
    }
  },
  // 视图
  template: `
    <div>{{ count }}</div>
  `,
  // 操作
  methods: {
    increment () {
      this.count++
    }
  }
}

createApp(Counter).mount('#app')

这个状态自管理应用包含以下几个部分：

状态，驱动应用的数据源；
视图，以声明方式将状态映射到视图；
操作，响应在视图上的用户输入导致的状态变化。

以下是一个表示“单向数据流”理念的简单示意：

但是，当我们的应用遇到多个组件共享状态时，单向数据流的简洁性很容易被破坏：

多个视图依赖于同一状态。
来自不同视图的行为需要变更同一状态。

对于问题一，传参的方法对于多层嵌套的组件将会非常繁琐，并且对于兄弟组件间的状态传递无能为力。对于问题二，我们经常会采用父子组件直接引用或者通过事件来变更和同步状态的多份拷贝。以上的这些模式非常脆弱，通常会导致无法维护的代码。

因此，我们为什么不把组件的共享状态抽取出来，以一个全局单例模式管理呢？在这种模式下，我们的组件树构成了一个巨大的“视图”，不管在树的哪个位置，任何组件都能获取状态或者触发行为！

通过定义和隔离状态管理中的各种概念并通过强制规则维持视图和状态间的独立性，我们的代码将会变得更结构化且易维护。

核心概念

State
Getter
Mutation
Action
Module

1、State 单一状态树

用一个对象就包含了全部的应用层级状态。至此它便作为一个“唯一数据源 (SSOT)”而存在。这也意味着，每个应用将仅仅包含一个 store 实例。(简单理解就是相当于组件的 data)

在 Vue 项目中定义 Vuex 状态

根目录创建 store/index.js

// 状态管理文件  安装vuex npm install vuex --save
import Vue from 'vue'
import Vuex from 'vuex'

// 1.安装插件
Vue.use(Vuex)

// 2.创建 Store 对象
const state = {
  count: 0
}
const store = new Vuex.Store({
// 单一状态树
  state
})

// 3.导出 store
export default store

根组件中 “注入” store 实例

Vuex 通过 Vue 的插件系统将 store 实例从根组件中“注入”到所有的子组件里。且子组件能通过 this.$store 访问到。

import Vue from 'vue'
import App from './App.vue'
// 导入vuex
import store from './store'

Vue.config.productionTip = false

new Vue({
  store, // 注册使用 vuex
  render: (h) => h(App)
}).$mount('#app')

在 Vue 组件中获取 Vuex 状态

那么我们如何在 Vue 组件中展示状态呢？由于 Vuex 的状态存储是响应式的，从 store 实例中读取状态最简单的方法就是在计算属性中返回某个状态：

<template>
   <div> {{ count }} </div>
</template>

<script>
export default {
  name: 'Counter',
  computed: {
    count() {
      return this.$store.state.count
    }
  }
}
</script>

`mapState` 辅助函数

当一个组件需要获取多个状态的时候，将这些状态都声明为计算属性会有些重复和冗余。为了解决这个问题，我们可以使用 mapState 辅助函数帮助我们生成计算属性，让你少按几次键：

数组语法：

<template>
   <div>{{ count }}</div>
</template>

<script>
// 在单独构建的版本中辅助函数为 Vuex.mapState
import { mapState } from 'vuex'

export default {
  name: 'Counter',
  computed: {
   ...mapState([
      // 映射 this.count 为 store.state.count
      'count'
    ])
  }
}
</script>

对象语法：

<template>
   <div>{{ setCount }}</div>
</template>

<script>
// 在单独构建的版本中辅助函数为 Vuex.mapState
import { mapState } from 'vuex'

export default {
  name: 'Counter',
  computed: {
    // 对象的语法可以重命名
      ...mapState({
      // 映射 this.setCount 为 store.state.count
      // setCount 是自定义的名称
      setCount: state => state.count
    })
  }
}
</script>

注意：使用 Vuex 并不意味着你需要将所有的状态放入 Vuex。虽然将所有的状态放到 Vuex 会使状态变化更显式和易调试，但也会使代码变得冗长和不直观。如果有些状态严格属于单个组件，最好还是作为组件的局部状态。应该根据应用开发需要进行权衡和确定。

2、Getter （可以认为是 store 的计算属性）

有时候我们需要从 store 中的 state 中派生出一些状态，例如对列表进行过滤并计数：

computed: {
  doneTodosCount () {
    return this.$store.state.todos.filter(todo => todo.done).length
  }
}

如果有多个组件需要用到此属性，我们要么复制这个函数，或者抽取到一个共享函数然后在多处导入它——无论哪种方式都不是很理想。

Vuex 允许我们在 store 中定义“getter”，示例如下：

在根目录的store文件夹中创建 getters.js
在store/index.js 中导入使用

在store/index.js 中导入使用

// 状态管理文件  安装vuex npm install vuex --save
import Vue from 'vue'
import Vuex from 'vuex'

// 导入分离之后的 getters
import getters from './getters'

// 1.安装插件
Vue.use(Vuex)

// 2.创建 Store 对象
const state = {
  count: 0,
  todos: [ // 列表数据
      { id: 1, text: '...', done: true },
      { id: 2, text: '...', done: false }
    ]
}
const store = new Vuex.Store({
  state,
  getters, 
})

// 3.导出 store
export default store

Getter 接受 state 作为其第一个参数：

// getters.js
export default{
 doneTodos (state) {
      return state.todos.filter(todo => todo.done)
  }
}

通过属性访问

Getter 会暴露为 store.getters 对象，你可以以属性的形式访问这些值：

store.getters.doneTodos // -> [{ id: 1, text: '...', done: true }]

Getter 也可以接受其他 getter 作为第二个参数：

// getters.js
export default{
 doneTodos (state) { // 对列表进行过滤
      return state.todos.filter(todo => todo.done) // 把todo.done等于true的数据返回
  },
   doneTodosCount (state, getters) { // 对列表过滤后的数据进行统计
    return getters.doneTodos.length
  }
}

调用：

store.getters.doneTodosCount // -> 1

我们可以很容易地在任何组件中使用它：

computed: {
  doneTodosCount () {
    return this.$store.getters.doneTodosCount
  }
}

注意：getter 在通过属性访问时是作为 Vue 的响应式系统的一部分缓存其中的。

通过方法访问

你也可以通过让 getter 返回一个函数，来实现给 getter 传参。在你对 store 里的数组进行查询时非常有用。

// getters.js
export default{
 doneTodos (state) { // 对列表进行过滤
      return state.todos.filter(todo => todo.done) // 把todo.done等于true的数据返回
  },
   doneTodosCount (state, getters) { // 对列表过滤后的数据进行统计
    return getters.doneTodos.length
  },
  getTodoById: (state) => (id) => {
    return state.todos.find(todo => todo.id === id)
  }
}

调用：

store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }

注意：getter 在通过方法访问时，每次都会去进行调用，而不会缓存结果。

`mapGetters` 辅助函数

mapGetters 辅助函数仅仅是将 store 中的 getter 映射到局部计算属性：

import { mapGetters } from 'vuex'

export default {
  // ...
  computed: {
  // 使用对象展开运算符将 getter 混入 computed 对象中
    ...mapGetters([
      'doneTodosCount',
      'anotherGetter',
      // ...
    ])
  }
}

如果你想将一个 getter 属性另取一个名字，使用对象形式：

...mapGetters({
  // 把 `this.doneCount` 映射为 `this.$store.getters.doneTodosCount`
  doneCount: 'doneTodosCount'
})

3、Mutation （类似于事件，唯一的目的就是修改state中的状态）

更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。Vuex 中的 mutation 非常类似于事件：每个 mutation 都有一个字符串的事件类型 (type)和一个回调函数 (handler)。这个回调函数就是我们实际进行状态更改的地方，并且它会接受 state 作为第一个参数：

在根目录的store文件夹中创建 mutations.js
在store/index.js 中导入使用，跟上面的方法一样

在 store/index.js 中导入使用

// 状态管理文件  安装vuex npm install vuex --save
import Vue from 'vue'
import Vuex from 'vuex'

// 导入分离之后的 getters、mutation 
import getters from './getters'
import mutations from './mutations'

// 1.安装插件
Vue.use(Vuex)

// 2.创建 Store 对象
const state = {
  count: 0,
  todos: [ // 列表数据
      { id: 1, text: '...', done: true },
      { id: 2, text: '...', done: false }
    ]
}
const store = new Vuex.Store({
  state,
  getters, 
  mutations
})

// 3.导出 store
export default store

mutations.js

 // mutation.js
export default{
  increment (state) {
      // 变更状态
      state.count++
    }
}

你不能直接调用一个 mutation 处理函数。这个选项更像是事件注册：“ 当触发一个类型为 increment的 mutation 时，调用此函数。”要唤醒一个 mutation 处理函数，你需要以相应的 type 调用 store.commit 方法：

store.commit('increment')

提交载荷（Payload）

你可以向 store.commit 传入额外的参数，即 mutation 的载荷（payload）：

 // mutation.js
export default{
  increment (state,n) {
      state.count += n
    }
}

提交

store.commit('increment', 10)

在大多数情况下，载荷应该是一个对象，这样可以包含多个字段并且记录的 mutation 会更易读：

 // mutation.js
export default{
  increment (state, payload) {
    state.count += payload.amount
  }
}

提交

store.commit('increment', {
  amount: 10
})

对象风格的提交方式

提交 mutation 的另一种方式是直接使用包含 type 属性的对象：

store.commit({
  type: 'increment',
  amount: 10
})

当使用对象风格的提交方式，整个对象都作为载荷传给 mutation 函数，因此处理函数保持不变：

 // mutation.js
export default{
  increment (state, payload) {
    state.count += payload.amount
  }
}

使用常量替代 Mutation 事件类型

使用常量替代 mutation 事件类型在各种 Flux 实现中是很常见的模式。这样可以使 linter 之类的工具发挥作用（ESLint，这是最流行的linter工具之一），同时把这些常量放在单独的文件中可以让你的代码合作者对整个 app 包含的 mutation 一目了然：

// mutation-types.js
export const SOME_MUTATION = 'SOME_MUTATION'

 // mutation.js

import{
  ADD_COUNTER,
  ADD_TO_CART
}from './mutation-types'

export default{
  [SOME_MUTATION] (state, payload) {
    // 我们可以使用 ES2015 风格的计算属性命名功能
    // 来使用一个常量作为函数名
    state.count += payload.amount
  }
}

用不用常量取决于你——在需要多人协作的大型项目中，这会很有帮助。但如果你不喜欢，你完全可以不这样做。

Mutation 必须是同步函数

一条重要的原则就是要记住 mutation 必须是同步函数。为什么？请参考下面的例子：

mutations: {
  someMutation (state) {
    api.callAsyncMethod(() => {
      state.count++
    })
  }
}

现在想象，我们正在 debug 一个 app 并且观察 devtool 中的 mutation 日志。每一条 mutation 被记录，devtools 都需要捕捉到前一状态和后一状态的快照。然而，在上面的例子中 mutation 中的异步函数中的回调让这不可能完成：因为当 mutation 触发的时候，回调函数还没有被调用，devtools 不知道什么时候回调函数实际上被调用——实质上任何在回调函数中进行的状态的改变都是不可追踪的。

`mapMutations` 辅助函数

在组件中提交 Mutation

你可以在组件中使用 this.$store.commit('xxx') 提交 mutation，或者使用 mapMutations 辅助函数将组件中的 methods 映射为 store.commit 调用（需要在根节点注入 store）。

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

在 mutation 中混合异步调用会导致你的程序很难调试。例如，当你调用了两个包含异步回调的 mutation 来改变状态，你怎么知道什么时候回调和哪个先回调呢？这就是为什么我们要区分这两个概念。在 Vuex 中，mutation 都是同步事务：

store.commit('increment')
// 任何由 "increment" 导致的状态变更都应该在此刻完成。

为了处理异步操作，让我们来看一看 Action。

4、Action （类似于 mutation，处理异步操作）

Action 类似于 mutation，不同在于：

Action 提交的是 mutation，而不是直接变更状态。
Action 可以包含任意异步操作。

让我们来注册一个简单的 action：

在根目录的store文件夹中创建 actions.js
在store/index.js 中导入使用，跟上面的方法一样

在store/index.js 中导入使用

// 状态管理文件  安装vuex npm install vuex --save
import Vue from 'vue'
import Vuex from 'vuex'

// 导入分离之后的 getters、mutation 、actions 
import getters from './getters'
import mutations from './mutations'
import actions from './actions'

// 1.安装插件
Vue.use(Vuex)

// 2.创建 Store 对象
const state = {
  count: 0,
  todos: [ // 列表数据
      { id: 1, text: '...', done: true },
      { id: 2, text: '...', done: false }
    ]
}
const store = new Vuex.Store({
  state,
  getters, 
  mutations,
  actions 
})

// 3.导出 store
export default store

actions.js

// actions.js
export default { 
    increment (context) {
      context.commit('increment')
    }
}

Action 函数接受一个与 store 实例具有相同方法和属性的 context 对象，因此你可以调用 context.commit 提交一个 mutation，或者通过 context.state 和 context.getters 来获取 state 和 getters。当我们在之后介绍到 Modules 时，你就知道 context 对象为什么不是 store 实例本身了。

实践中，我们会经常用到 ES2015 的参数解构来简化代码（特别是我们需要调用 commit 很多次的时候）：

// actions.js
export default { 
    increment ({ context }) {
      context.commit('increment')
    }
}

分发 Action

Action 通过 store.dispatch 方法触发：

store.dispatch('increment')

乍一眼看上去感觉多此一举，我们直接分发 mutation 岂不更方便？实际上并非如此，还记得 mutation 必须同步执行这个限制么？Action 就不受约束！我们可以在 action 内部执行异步操作：

// actions.js
export default { 
    increment ({ context }) {
      setTimeout(() => {
        commit('increment')
      }, 1000)
    }
}

Actions 支持同样的载荷方式和对象方式进行分发：

// 以载荷形式分发
store.dispatch('incrementAsync', {
  amount: 10
})

// 以对象形式分发
store.dispatch({
  type: 'incrementAsync',
  amount: 10
})

`mapActions` 辅助函数

在组件中分发 Action

你在组件中使用 this.$store.dispatch('xxx') 分发 action，或者使用 mapActions 辅助函数将组件的 methods 映射为 store.dispatch 调用（需要先在根节点注入 store）

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')`
    })
  }
}

组合 Action

Action 通常是异步的，那么如何知道 action 什么时候结束呢？更重要的是，我们如何才能组合多个 action，以处理更加复杂的异步流程？

首先，你需要明白 store.dispatch 可以处理被触发的 action 的处理函数返回的 Promise，并且 store.dispatch 仍旧返回 Promise：

// actions.js
export default { 
...
 actionA ({ commit }) {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        commit('someMutation')
        resolve()
      }, 1000)
    })
  }
}

现在你可以：

store.dispatch('actionA').then(() => {
  // ...
})

在另外一个 action 中也可以：

// actions.js
export default { 
 ...
 actionB ({ dispatch, commit }) {
    return dispatch('actionA').then(() => {
      commit('someOtherMutation')
    })
  }
}

最后，如果我们利用 async / await，我们可以如下组合 action：

// actions.js

// 假设 getData() 和 getOtherData() 返回的是 Promise
export default { 
 ...
async actionA ({ commit }) {
    commit('gotData', await getData())
  },
  async actionB ({ dispatch, commit }) {
    await dispatch('actionA') // 等待 actionA 完成
    commit('gotOtherData', await getOtherData())
  }
}

注意：一个 store.dispatch 在不同模块中可以触发多个 action 函数。在这种情况下，只有当所有触发函数完成后，返回的 Promise 才会执行。

5、Module（将store 分割成模块）

由于使用单一状态树，应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时，store 对象就有可能变得相当臃肿。

为了解决以上问题，Vuex 允许我们将 store 分割成模块（module）。每个模块拥有自己的 state、mutation、action、getter、甚至是嵌套子模块——从上至下进行同样方式的分割：

步骤：

在store文件夹下创建cart.js 、user.js 模块
在store/index.js 中导入
使用 modules：{} 挂载模块

cart.js

//  cart.js
export default {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

user.js

 // user.js
export default {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

index.js

// 1. 导入 Vue 和 Vuex
import Vue from 'vue'
import Vuex from 'vuex'

// 导入购物车的 vuex 模块
import moduleCart from './cart.js'
// 导入用户的 vuex 模块
import moduleUser from './user.js'

// 2. 将 Vuex 安装为 Vue 的插件
Vue.use(Vuex)

// 3. 创建 Store 的实例对象
const store = new Vuex.Store({
  // TODO：挂载 store 模块
  modules: { 
      // 挂载购物车的 vuex 模块，模块内成员的访问路径被调整为 m_cart
       m_cart: moduleCart, // 子vuex模块
      // 挂载用户的 vuex 模块，访问路径为 m_user
      m_user: moduleUser,
  },
})

// 4. 向外共享 Store 的实例对象
export default store

store.state.m_cart// -> moduleCart 的状态
store.state.m_user // -> moduleUser 的状态

模块的局部状态

对于模块内部的 mutation 和 getter，接收的第一个参数是模块的局部状态对象。

//  cart.js
export default {
   state: () => ({
    count: 0
  }),
  mutations: {
    increment (state) {
      // 这里的 `state` 对象是模块的局部状态
      state.count++
    }
  },
  getters: {
    doubleCount (state) {
      return state.count * 2
    }
  }
}

同样，对于模块内部的 action，局部状态通过 context.state 暴露出来，根节点状态则为 context.rootState：

//  cart.js
export default {
  // ...
  actions: {
    incrementIfOddOnRootSum ({ state, commit, rootState }) {
      if ((state.count + rootState.count) % 2 === 1) {
        commit('increment')
      }
    }
  }
}

对于模块内部的 getter，根节点状态会作为第三个参数暴露出来：

//  cart.js
export default {
  // ...
  getters: {
    sumWithRootCount (state, getters, rootState) {
      return state.count + rootState.count
    }
  }
}

命名空间

默认情况下，模块内部的 action 和 mutation 仍然是注册在全局命名空间的——这样使得多个模块能够对同一个 action 或 mutation 作出响应。Getter 同样也默认注册在全局命名空间，但是目前这并非出于功能上的目的（仅仅是维持现状来避免非兼容性变更）。必须注意，不要在不同的、无命名空间的模块中定义两个相同的 getter 从而导致错误。

如果希望你的模块具有更高的封装度和复用性，你可以通过添加 namespaced: true 的方式使其成为带命名空间的模块。当模块被注册后，它的所有 getter、action 及 mutation 都会自动根据模块注册的路径调整命名。例如：

//  cart.js
export default {
  // 为当前模块开启命名空间 ， 为了解决不同模块命名冲突的问题
  namespaced: true,

  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

 // user.js
export default {
// 开启命名空间
  namespaced: true,

  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

组件内访问命名空间的内容

  // 按需导入辅助函数
import { mapState} from 'vuex'

 computed: {
        // 将 m_cart 模块中的 userinfo 映射到当前页面中使用
        ...mapState('m_cart', ['count']),
      },

 methods:{
     // 映射方法
       ...mapMutations('m_cart', ['updateUserInfo', 'updateToken', 'updateAddress']),
 }

store.state.m_cart// -> moduleCart 的状态
store.state.m_user // -> moduleUser 的状态

总结：将 store 分割成模块（module），并且开启了命名空间，使用 store 内的方法或属性时都要在前面加上你命名的空间名称