Front-end Dev Engineer

0%

Vuex官方文档学习笔记

发表于 分类于 ， ， 阅读次数： Valine： 本文字数： 14k 阅读时长 ≈ 13 分钟

在 Vue 的学习中，Vuex 是一个专为 Vue 开发的应用程序的状态管理模式，当我们构建一个中大型的单页面应用程序时，Vuex可以更好的帮助我们在组件外部统一管理状态，Vuex具体使用方法查看文档笔记；

Vuex官方文档学习笔记

学习链接：Vuex官方文档

1. 安装

  1. 在一个模块化的打包系统中，先下载 vuex 第三方模块，再显式地通过 Vue.use() 来安装 Vuex ：
1
2
3
npm install vuex --save
# 或者
yarn add vuex
1
2
3
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)

1.1 Vuex 是什么？

Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式；状态管理模式介绍如下：

  1. 状态自管理应用包含以下几个部分：
    • state：驱动应用的数据源；
    • view：以声明方式将 state 映射到视图；
    • actions：响应在 view 上的用户输入导致的状态变化；
  2. Vuex 的基本思想是把组件的共享状态抽取出来，以一个全局单例模式管理，在这种模式下，我们的组件树构成了一个巨大的“视图”，不管在树的哪个位置，任何组件都能获取状态或者触发行为；另外，通过定义和隔离状态管理中的各种概念并强制遵守一定的规则，我们的代码将会变得更结构化且易维护；
  3. Vuex 是专门为 Vue.js 设计的状态管理库，以利用 Vue.js 的细粒度数据响应机制来进行高效的状态更新；

图片

1.2 开始

每一个 Vuex 应用的核心就是 store （仓库）,它包含着你的应用中大部分的状态 state ;

Vuex 和单纯的全局对象有以下两点不同：

  1. Vuex 的状态存储是响应式的；当 Vue 组件从 store 中读取状态的时候，若 store 中的状态发生变化，那么相应的组件也会相应地得到高效更新；
  2. 不能直接改变 store 中的状态；改变 store 中的状态的唯一途径就是显式地 提交 (commit) mutation ，而非直接改变 store.state.count；这样使得我们可以方便地跟踪每一个状态的变化，从而让我们能够实现一些工具帮助我们更好地了解我们的应用，代码如下：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// 创建一个 store，提供一个初始 state 对象和一些 mutation
const store = new Vuex.Store({
  state: {
    count: 0
  },
  mutations: {
    increment (state) {
      state.count++
    }
  }
})
// 通过 store.state 来获取状态对象，以及通过 store.commit 方法触发状态变更：
store.commit('increment')
console.log(store.state.count) // -> 1

2. 核心概念

2.1 State

2.1.1 单一状态树

Vuex 使用单一状态树——用一个对象就包含了全部的应用层级状态；每个应用将仅仅包含一个 store 实例；单一状态树让我们能够直接地定位任一特定的状态片段，在调试的过程中也能轻易地取得整个当前应用状态的快照。

2.1.2 在 Vue 组件中获得 Vuex 状态

Vuex 的状态存储是响应式的，从 store 实例中读取状态最简单的方法就是在计算属性中返回某个状态，如代码中每当 store.state.count 变化的时候, 都会重新求取计算属性，并且触发更新相关联的 DOM：

1
2
3
4
5
6
7
8
9
10
// 创建一个 Counter 组件
const Counter = {
  template: `<div>{{ count }}</div>`,
  computed: {
    count () {
      return store.state.count
    }
  }
}
// 这种模式导致组件依赖全局状态单例，解决办法如下

Vuex 通过 store 选项，提供了一种机制将状态从根组件“注入”到每一个子组件中（需调用 Vue.use(Vuex)），通过在根实例中注册 store 选项，该 store 实例会注入到根组件下的所有子组件中，且子组件能通过 this.$store 访问到，更新下 Counter 的实现：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// 在根实例 app.vue 中进行注册 store选项；
const app = new Vue({
  el: '#app',
  // 把 store 对象提供给 “store” 选项，这可以把 store 的实例注入所有的子组件
  store,
  components: { Counter },
  template: `
    <div class="app">
      <counter></counter>
    </div>
  `
})
// 子组件访 Counter 问该数据
const Counter = {
  template: `<div>{{ count }}</div>`,
  computed: {
    count () {
      return this.$store.state.count
    }
  }
}

2.1.3 mapState 辅助函数

当一个组件需要获取多个状态时候，将这些状态都声明为计算属性会有些重复和冗余，可以使用 mapState 辅助函数帮助我们生成计算属性；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 在单独构建的版本中辅助函数为 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 传一个字符串数组：

1
2
3
4
computed: mapState([
  // 映射 this.count 为 store.state.count
  'count'
])

2.1.4 对象展开运算符

mapState 函数返回的是一个对象；我们需要使用一个工具函数将多个对象合并为一个，以使我们可以将最终对象传给 computed 属性：

1
2
3
4
5
6
7
computed: {
  localComputed () { /* ... */ },
  // 使用对象展开运算符将此对象混入到外部对象中
  ...mapState({
    // ...
  })
}

2.1.5 组件仍然保有局部状态

使用 Vuex 并不意味着你需要将所有的状态放入 Vuex ；如果有些状态严格属于单个组件，最好还是作为组件的局部状态；你应该根据你的应用开发需要进行权衡和确定。

2.2 Getter

2.2.1 从 store 中的 state 中派生出一些状态

例如：对列表进行数据过滤并计算个数，代码如下：

1
2
3
4
5
6
// 过滤函数获取todo.done 为true的值
computed: {
  doneTodosCount () {
    return this.$store.state.todos.filter(todo => todo.done).length
  }
}

Vuex 允许我们在 store 中定义“getter”（可以认为是 store 的计算属性）；就像计算属性一样， getter 的返回值会根据它的依赖被缓存起来，且只有当它的依赖值发生了改变才会被重新计算， Getter 接受 state 作为其第一个参数：

1
2
3
4
5
6
7
8
9
10
11
12
13
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)
    }
  }
})

2.2.2 通过属性访问

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
store.getters.doneTodos // -> [{ id: 1, text: '...', done: true }]

// Getter 也可以接受其他 getter 作为第二个参数
getters: {
  // ...
  doneTodosCount: (state, getters) => {
    return getters.doneTodos.length
  }
}
store.getters.doneTodosCount // -> 1

// 还可以很容易地在任何组件中使用它
computed: {
  doneTodosCount () {
    return this.$store.getters.doneTodosCount
  }
}

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

2.2.3 通过方法访问

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

1
2
3
4
5
6
7
getters: {
  // ...
  getTodoById: (state) => (id) => {
    return state.todos.find(todo => todo.id === id)
  }
}
store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }

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

2.2.4 mapGetters 辅助函数

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

1
2
3
4
5
6
7
8
9
10
11
12
import { mapGetters } from 'vuex'
export default {
  // ...
  computed: {
  // 使用对象展开运算符将 getter 混入 computed 对象中
    ...mapGetters([
      'doneTodosCount',
      'anotherGetter',
      // ...
    ])
  }
}

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

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

2.3 Mutation

2.3.1 修改 store 中的状态

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

1
2
3
4
5
6
7
8
9
10
11
const store = new Vuex.Store({
  state: {
    count: 1
  },
  mutations: {
    increment (state) {
      // 变更状态
      state.count++
    }
  }
})

要调用此 mutation handler，需要以相应的 type 调用 store.commit 方法：
store.commit('increment')

2.3.2 提交载荷（Payload）——额外参数

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

1
2
3
4
5
6
7
// ...
mutations: {
  increment (state, n) {
    state.count += n
  }
}
store.commit('increment', 10)

载荷还可以是一个对象，这样可以包含多个字段并且记录的 mutation 会更易读；

1
2
3
4
5
6
7
8
9
// ...
mutations: {
  increment (state, payload) {
    state.count += payload.amount
  }
}
store.commit('increment', {
  amount: 10
})

2.3.3 对象风格的提交方式

提交 mutation 的另一种方式是直接使用包含 type 属性的对象，使用对象风格的提交方式，整个对象都作为载荷传给 mutation 函数，因此 handler 保持不变：

1
2
3
4
5
6
7
8
9
10
11
// 定义在store中的函数
mutations: {
  increment (state, payload) {
    state.count += payload.amount
  }
}
// 调用mutation handler
store.commit({
  type: 'increment',
  amount: 10
})

2.3.4 Mutation 需遵守 Vue 的响应规则

  1. 最好提前在你的 store 中初始化好所有所需属性。
  2. 当需要在对象上添加新属性时，你应该使用 Vue.set(obj, 'newProp', 123), 或者 以新对象替换老对象；例如：state.obj = { ...state.obj, newProp: 123 }

2.3.5 使用常量替代 Mutation 事件类型

使用常量替代 mutation 事件类型在各种 Flux 实现中是很常见的模式；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// mutation-types.js
export const SOME_MUTATION = 'SOME_MUTATION'

// store.js
import Vuex from 'vuex'
import { SOME_MUTATION } from './mutation-types'

const store = new Vuex.Store({
  state: { ... },
  mutations: {
    // 我们可以使用 ES2015 风格的计算属性命名功能来使用一个常量作为函数名
    [SOME_MUTATION] (state) {
      // mutate state
    }
  }
})

2.3.6 Mutation 必须是同步函数(重要原则)

参考下面的例子：

1
2
3
4
5
6
7
mutations: {
  someMutation (state) {
    api.callAsyncMethod(() => {
      state.count++
    })
  }
}

2.3.7 在组件中提交 Mutation

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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')`
    })
  }
}

2.3.8 Vuex 中 mutation 都是同步事务

在 mutation 中混合异步调用会导致你的程序很难调试。例如，当你调用了两个包含异步回调的 mutation 来改变状态，你怎么知道什么时候回调和哪个先回调呢？这就是为什么我们要区分这两个概念，为了处理异步操作，来看一看 Action的功能；

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

2.4 Action

Action 类似于 mutation ，不同在于：

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

Action 函数接受一个与 store 实例具有相同方法和属性的 context 对象；因此你可以调用 context.commit提交一个 mutation ，或者通过 context.state 和 context.getters 来获取 state 和 getters；

注册一个简单的 action 例子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const store = new Vuex.Store({
  state: {
    count: 0
  },
  mutations: {
    increment (state) {
      state.count++
    }
  },
  actions: {
    increment (context) {
      context.commit('increment')
    }
  }
})

2.4.1 分发 Action

Action 通过 store.dispatch 方法触发: store.dispatch('increment')

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Action 还可以在 action 内部执行异步操作（区别于mutation 必须同步执行）：
actions: {
  incrementAsync ({ commit }) {
    setTimeout(() => {
      commit('increment')
    }, 1000)
  }
}

// Actions 支持同样的载荷方式和对象方式进行分发：
// 以载荷形式分发
store.dispatch('incrementAsync', {
  amount: 10
})
// 以对象形式分发
store.dispatch({
  type: 'incrementAsync',
  amount: 10
})

购物车示例，涉及到调用异步 API 和分发多重 mutation ：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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)
    )
  }
}

2.4.2 在组件中分发 Action

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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')`
    })
  }
}

2.4.3 组合 Action

Action 通常是异步的，那么如何知道 action 什么时候结束呢？首先要明白 store.dispatch 可以处理被触发的 action 的处理函数返回的 Promise ，并且 store.dispatch 仍旧返回 Promise ：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
actions: {
  actionA ({ commit }) {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        commit('someMutation')
        resolve()
      }, 1000)
    })
  }
}

// 可以直接调用，使用 promise 语法
store.dispatch('actionA').then(() => {
  // ...
})

// 在另外一个 action 中也可以如下：
actions: {
  // ...
  actionB ({ dispatch, commit }) {
    return dispatch('actionA').then(() => {
      commit('someOtherMutation')
    })
  }
}

// 若利用 async / await，我们可以如下组合 action：
// 假设 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 才会执行；

2.5 Module

由于使用单一状态树，应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时， store 对象就有可能变得相当臃肿；为了解决以上问题， Vuex 允许我们将 store 分割成模块（ module ），每个模块拥有自己的 state; mutation; action; getter; 嵌套子模块；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
const moduleA = {
  state: { ... },
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}
const moduleB = {
  state: { ... },
  mutations: { ... },
  actions: { ... }
}
const store = new Vuex.Store({
  modules: {
    a: moduleA,
    b: moduleB
  }
})
store.state.a // -> moduleA 的状态
store.state.b // -> moduleB 的状态

2.5.1 模块的局部状态

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const moduleA = {
  state: { count: 0 },
  mutations: {
    increment (state) {
      // 这里的 `state` 对象是模块的局部状态
      state.count++
    }
  },

  getters: {
    doubleCount (state) {
      return state.count * 2
    }
  }
}

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

1
2
3
4
5
6
7
8
9
10
const moduleA = {
  // ...
  actions: {
    incrementIfOddOnRootSum ({ state, commit, rootState }) {
      if ((state.count + rootState.count) % 2 === 1) {
        commit('increment')
      }
    }
  }
}

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

1
2
3
4
5
6
7
const moduleA = {
  // ...
  getters: {
    sumWithRootCount (state, getters, rootState) {
      return state.count + rootState.count
    }
  }

2.5.2 命名空间

默认情况下，模块内部的 action、mutation 和 getter 是注册在全局命名空间的——这样使得多个模块能够对同一 mutation 或 action 作出响应；

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
const store = new Vuex.Store({
  modules: {
    account: {
      namespaced: true,
      // 模块内容（module assets）
      state: { ... }, // 模块内的状态已经是嵌套的了，使用 `namespaced` 属性不会对其产生影响
      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']
          }
        }
      }
    }
  }
})

2.5.3 模块动态注册

使用 store.registerModule 方法注册模块，注册后就可以通过 store.state.myModule 和 store.state.nested.myModule 访问模块的状态：

1
2
3
4
5
6
7
8
// 注册模块 `myModule`
store.registerModule('myModule', {
  // ...
})
// 注册嵌套模块 `nested/myModule`
store.registerModule(['nested', 'myModule'], {
  // ...
})

2.5.4 模块重用

有时需要创建一个模块的多个实例，如果我们使用一个纯对象来声明模块的状态，那么这个状态对象会通过引用被共享，导致状态对象被修改时 store 或模块间数据互相污染的问题；实际上这和 Vue 组件内的 data 是同样的问题：解决办法也是相同的——使用一个函数来声明模块状态（仅 2.3.0+ 支持）：

1
2
3
4
5
6
7
8
9
const MyReusableModule = {
  state () {
    // 使用函数返回数据
    return {
      foo: 'bar'
    }
  },
  // mutation, action 和 getter 等等...
}

3. 项目结构

规定了一些需要遵守的规则：

  1. 应用层级的状态应该集中到单个 store 对象中；
  2. 提交 mutation 是更改状态的唯一方法，并且这个过程是同步的；
  3. 异步逻辑都应该封装到 action 里面；

下面是项目结构示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
├── index.html
├── main.js
├── api
│   └── ... # 抽取出API请求
├── components
│   ├── App.vue
│   └── ...
└── store
    ├── index.js          # 我们组装模块并导出 store 的地方
    ├── actions.js        # 根级别的 action
    ├── mutations.js      # 根级别的 mutation
    └── modules
        ├── cart.js       # 购物车模块
        └── products.js   # 产品模块

4. (未)插件

5. 严格模式

开启严格模式，仅需在创建 store 的时候传入 strict: true：

1
2
3
4
const store = new Vuex.Store({
  // ...
  strict: true
})

在严格模式下，无论何时发生了状态变更且不是由 mutation 函数引起的，将会抛出错误；这能保证所有的状态变更都能被调试工具跟踪到；

5.1 开发环境与发布环境

不要在发布环境下启用严格模式 严格模式会深度监测状态树来检测不合规的状态变更——请确保在发布环境下关闭严格模式，以避免性能损失，处理如下：

1
2
3
4
const store = new Vuex.Store({
  // ...
  strict: process.env.NODE_ENV !== 'production'
})

6. 表单处理

当在严格模式中使用 Vuex 时，在属于 Vuex 的 state 上使用 v-model 会比较棘手：<input v-model="obj.message">；用“Vuex 的思维”去解决这个问题的方法是：给 <input> 中绑定 value ，然后侦听 input 或者 change 事件，在事件回调中调用 action :

1
<input :value="message" @input="updateMessage">
1
2
3
4
5
6
7
8
9
10
11
// ...
computed: {
  ...mapState({
    message: state => state.obj.message
  })
},
methods: {
  updateMessage (e) {
    this.$store.commit('updateMessage', e.target.value)
  }
}
1
2
3
4
5
6
7
// 下面是 mutation 函数：
// ...
mutations: {
  updateMessage (state, message) {
    state.obj.message = message
  }
}

6.1 双向绑定的计算属性

使用带有 setter 的双向绑定计算属性：

1
<input v-model="message">
1
2
3
4
5
6
7
8
9
10
11
// ...
computed: {
  message: {
    get () {
      return this.$store.state.obj.message
    },
    set (value) {
      this.$store.commit('updateMessage', value)
    }
  }
}

7. (未)测试

8. (未)热重载

-------------　　　　本文结束　　感谢您的阅读　　　　-------------
相关文章推荐

赞赏一下吧～ 还可以关注公众号订阅最新内容