【sduoj】初识 Vuex

2024-01-18 08:33:16

2021SC@SDUSC

文章目录

Vuex

在最初的几代版本中， SDUOJ 一直依赖组件传参的方式来传递管理整个系统中的数据。然而，随着后续的版本迭代，项目规模不断增大，依赖组件传参的数据同步方式已不再可靠，因此，我们选择了使用 Vuex 来进行全局的数据储存管理。

Vuex

Vuex简介

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

Vuex安装

在项目中，我们使用 NPM 或 Yarn 进行依赖的安装。在控制台中敲入命令：

npm install vuex --save
# 或
yarn add vuex

引入Vuex

在一个模块化的打包系统中，我们必须显式地通过 Vue.use() 来安装 Vuex：

import Vue from 'vue'
import Vuex from 'vuex'

Vue.use(Vuex)

核心概念

每一个 Vuex 应用的核心就是 store（仓库）。“store”基本上就是一个容器，它包含着你的应用中大部分的状态 (state)。Vuex 和单纯的全局对象有以下两点不同：

Vuex 的状态存储是响应式的。当 Vue 组件从 store 中读取状态的时候，若 store 中的状态发生变化，那么相应的组件也会相应地得到高效更新。
你不能直接改变 store 中的状态。改变 store 中的状态的唯一途径就是显式地提交 (commit) mutation。这样使得我们可以方便地跟踪每一个状态的变化，从而让我们能够实现一些工具帮助我们更好地了解我们的应用。

下面，我将展示一个最为简单的 Vuex 实例。在这个实例中，我们只创建一个 state 对象和一个 mutation：

import Vue from 'vue'
import Vuex from 'vuex'
import App from './App.vue'

Vue.use(Vuex)

const store = new Vuex.Store({
	state: {
		num: 1,
	},
	mutations: {
		add(state, num) {
			state.num += num;
		}
	}
})

new Vue({
	store,
	render: h => h(App)
}).$mount('#app')

现在，我们可以使用 store.state 获取状态对象，并通过 store.commit 调用来提交触发状态变更。

<!-- 这个是App.vue -->
<template>
	<div>
		<div>
			{{ $store.state.num }}
		</div>
		<div>
			<button @click="add(1)"> 点我加1 </button>
			<button @click="add(2)"> 点我加2 </button>
		</div>
	</div>
</template>

<script>
export default {
	methods: {
		add(num) {
			this.$store.commit('add', num);
		}
	}
}
</script>

好，这样一个简单的 Vuex Store 就创建好了。下面我们来较为深入地了解一下 Vuex 最基本的五个核心概念。

State

单一状态树

Vuex 使用单一状态树，也就是说用一个对象就包含了全部的应用层级状态。至此它便作为一个“唯一数据源 (SSOT) ”而存在。这也意味着，每个应用将仅仅包含一个 store 实例。单一状态树让我们能够直接地定位任一特定的状态片段，在调试的过程中也能轻易地取得整个当前应用状态的快照。
单状态树和模块化并不冲突，后面我们将会讨论如何将状态和状态变更事件分布到各个子模块中。
存储在 Vuex 中的数据和 Vue 实例中的 data 遵循相同的规则，例如状态对象必须是纯粹 (plain) 的。

在 Vue 组件中获得 Vuex 状态

Vuex 的状态存储是响应式的，从 store 实例中读取状态最简单的方法就是在计算属性中返回某个状态：

export default {
	... ,
	computed: {
		num() {
			return this.$store.state.num;
		}
	}
}

每当 store.state.num 变化的时候, 都会重新求取计算属性，并且触发更新相关联的 DOM。

Getters

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

computed: {
	availableItemLength() {
		return this.$store.state.list.filter((item) => {return item.available}).length;
	}
}

如果有多个组件需要用到此属性，我们要么复制这个函数，或者抽取到一个共享函数然后在多处导入它——无论哪种方式都不是很理想。Vuex 允许我们在 store 中定义 getter（可以认为是 store 的计算属性）。就像计算属性一样，getter 的返回值会根据它的依赖被缓存起来，且只有当它的依赖值发生了改变才会被重新计算。
Getter 接受 state 作为其第一个参数：

const store = new Vuex.Store({
	state: {
		list: [
			{ id: 0, value: '...', available: true },
			{ id: 1, value: '...', available: false }
		]
	},
	getters: {
		availableItems(state) {
			return state.list.filter((item) => {return item.available});
		}
	}
})

通过属性访问

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

this.$store.getters.availableItems // -> [{ id: 0, value: '...', available: true }]

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

const store = new Vuex.Store({
	state: {
		list: [
			{ id: 0, value: '...', available: true },
			{ id: 1, value: '...', available: false }
		]
	},
	getters: {
		availableItems(state) {
			return state.list.filter((item) => {return item.available});
		},
		availableItemLength(state, getters) {
			return getters.availableItems.length
		}
	}
})

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

通过方法访问

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

getters: {
	// ... ,
	getItemById(state) => (id) => {
		return state.list.find((item) => item.id === id)
	}
}

this.$store.getters.getItemById(1) // -> [{ id: 1, value: '...', available: false }]

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

Mutations

更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。Vuex 中的 mutation 非常类似于事件：每个 mutation 都有一个字符串的 事件类型 (type) 和一个 回调函数 (handler)。这个回调函数就是我们实际进行状态更改的地方，并且它会接受 state 作为第一个参数。
你不能直接调用一个 mutation handler。这个选项更像是事件注册：“当触发一个类型为 add 的 mutation 时，调用此函数。”要唤醒一个 mutation handler，你需要以相应的 type 调用 store.commit 方法。

const store = new Vuex.Store({
  state: {
    num: 0
  },
  mutations: {
    add(state) {
      // 变更状态
      state.num++
    }
  }
})

store.commit('add');

提交载荷（Payload）

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

// ...
mutations: {
	add(state, n) {
		state.num += n;
	}
}

this.$store.commit('add', 2)

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

// ...
mutations: {
	add(state, payload) {
		state.num += payload.numToAdd;
	}
}

this.$store.commit('add', {
	numToAdd: 10
})

对象风格的提交方式

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

this.$store.commit({
	type: 'add',
	numToAdd: 10
})

Mutation 需遵守 Vue 的响应规则

既然 Vuex 的 store 中的状态是响应式的，那么当我们变更状态时，监视状态的 Vue 组件也会自动更新。这也意味着 Vuex 中的 mutation 也需要与使用 Vue 一样遵守一些注意事项：

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

Mutation 必须是同步函数

这一点非常重要：mutation 必须是同步函数。
一旦我们的代码逻辑中涉及到了异步操作，那就让我们使用 Action 吧。

Actions

Action 类似于 mutation，不同在于：

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

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

const store = new Vuex.Store({
  state: {
    num: 0
  },
  mutations: {
    add(state) {
      state.num++
    }
  },
  actions: {
    increment (context) {
      context.commit('add')
    }
  }
})

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

分发 Action

Action 通过 store.dispatch 方法触发：

this.$store.dispatch('add')

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

actions: {
  addAsync ({ commit }) {
    setTimeout(() => {
      commit('add')
    }, 1000)
  }
}

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

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

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

Action 的 Promise

Action 通常是异步的，那么如何知道 action 什么时候结束呢？更重要的是，我们如何才能组合多个 action，以处理更加复杂的异步流程？
首先，你需要明白 store.dispatch 可以处理被触发的 action 的处理函数返回的 Promise，并且 store.dispatch 仍旧返回 Promise。

actions: {
  actionA ({ commit }) {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        commit('mutationA')
        resolve()
      }, 1000)
    })
  }
}

这样一来，我们就可以实现这样的操作：

actions: {
  // ...
  actionB ({ dispatch, commit }) {
    return dispatch('actionA').then(() => {
      commit('mutationB')
    })
  }
}

Modules

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

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 的状态

模块的局部状态

对于模块内部的 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
		}
	}
}

命名空间

默认情况下，模块内部的 action、mutation 和 getter 是注册在全局命名空间的——这样使得多个模块能够对同一 mutation 或 action 作出响应。
如果希望你的模块具有更高的封装度和复用性，你可以通过添加 namespaced: true 的方式使其成为带命名空间的模块。当模块被注册后，它的所有 getter、action 及 mutation 都会自动根据模块注册的路径调整命名。例如：

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

启用了命名空间的 getter 和 action 会收到局部化的 getter，dispatch 和 commit。换言之，你在使用模块内容（module assets）时不需要在同一模块内额外添加空间名前缀。更改 namespaced 属性后不需要修改模块内的代码。

码农公寓