Vue 教程(四十九)Vuex 核心概念和项目结构

Posted 2023-02-23 _否极泰来_

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Vue 教程(四十九)Vuex 核心概念和项目结构相关的知识，希望对你有一定的参考价值。

Vue 教程(四十九)Vuex 核心概念和项目结构

Vuex 核心概念

State
Getters
Mutations
Actions
Modules

State 单一状态树

Vuex 使用单一状态树——是的，用一个对象就包含了全部的应用层级状态。至此它便作为一个“唯一数据源 ”而存在。这也意味着，每个应用将仅仅包含一个 store 实例。单一状态树让我们能够直接地定位任一特定的状态片段，在调试的过程中也能轻易地取得整个当前应用状态的快照。

new Vue(
  // state
  data() 
    return 
      count: 0,
    
  ,
  // view
  template: `
    <div> count </div>
  `,
  // actions
  methods: 
    increment() 
      this.count++
    ,
  ,
)

Getters

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

配置 vuecli2\\src\\store\\index.js 文件

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

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

// 2. 创建对象
const store = new Vuex.Store(
  state: 
    counter: 1000,
    goods: [
       id: 1, name: '[五得利]高筋小麦粉', price: 92.9 ,
       id: 2, name: '新鲜莲藕（泥藕） 约600g', price: 6.8 ,
       id: 3, name: '香菜 约100g', price: 1.39 ,
       id: 4, name: '益客冷鲜鸡翅中 400g', price: 21.9 ,
       id: 5, name: '进口原切冷冻牛腩 400g', price: 31.8 ,
       id: 6, name: '多力葵花籽油 5L/桶（另送小油）', price: 79.9 ,
    ],
  ,
  mutations: 
    // 对state.counter属性每次+1操作
    increment(state) 
      state.counter++
    ,
    // 对state.counter属性每次-1操作
    decrement(state) 
      state.counter--
    ,
  ,
  getters: 
    // state 作为第一个参数
    queryGoods(state) 
      // 要求筛选价格大于 30 的商品。
      return state.goods.filter((g) => g.price > 30)
    ,
    queryGoodsCount(state, getters) 
      // 筛选价格大于 30 的商品 的个数
      return getters.queryGoods.length
    ,
    queryGoodsById(state) 
      // 根据商户id获取商品
      return function (id) 
        return state.goods.find((g) => g.id === id)
      
    ,
  ,
)

// 3. 导出store独享
export default store

修改 vuecli2\\src\\App.vue 文件

<template>
  <div id="root">
    <div>
      计数器：
      <button @click="addition()">+</button>
      <button @click="subtraction()">-</button>
    </div>
    <div class="layout">
      <h3>APP组件内容</h3>
      <p>counter值：$store.state.counter</p>
      <p>getters:$store.getters.queryGoods</p>
      <p>getters长度:$store.getters.queryGoodsCount</p>
      <p>getters根据id查找元素:$store.getters.queryGoodsById(2)</p>
    </div>
    <div class="layout">
      <h3>HelloVuex组件内容</h3>
      <hello-vuex />
    </div>
  </div>
</template>

<script>
// 1. 引入HelloVuex组件
import HelloVuex from './components/HelloVuex.vue'
export default 
  name: 'App',
  // 2. 注册组件
  components: 
    HelloVuex
  ,
  methods: 
    addition () 
      this.$store.commit('increment')
    ,
    subtraction () 
      this.$store.commit('decrement')
    
  

</script>

<style>
#root 
  width: 100%;

.layout 
  width: 49%;
  border: 1px solid black;
  float: left;

</style>

修改 vuecli2\\src\\components\\HelloVuex.vue 文件

<template>
  <div>
    <!-- 从$store.state中获取counter值 -->
    <p>counter值：$store.state.counter </p>
    <p>getters:$store.getters.queryGoods</p>
    <p>getters长度:$store.getters.queryGoodsCount</p>
    <p>getters根据id查找元素:$store.getters.queryGoodsById(2)</p>
  </div>
</template>

<script>
export default 
  name: 'HelloVuex'

</script>

<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
</style>

查看效果

Mutations

更改 Vuex 的 store 中的状态的唯一方法是提交 mutation。Vuex 中的 mutation 主要包含两个部分：

字符串的 事件类型 (type)
一个 **回调函数 (handler)，**该回调函数的第一个参数就是 state

这个回调函数就是我们实际进行状态更改的地方，并且它会接受 state 作为第一个参数：

mutation 的定义方式：

const store = new Vuex.Store(
  state: 
    counter: 1000,
  ,
  mutations: 
    increment(state) 
      // 变更状态
      state.counter++
    ,
  ,
)

通过 mutation 更新：

this.$store.commit('increment')

提交载荷（Payload）

在通过 mutation 更新数据的时候，有可能我们希望携带一些额外的参数。

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

// ...
mutations: 
  increment (state, n) 
    state.counter += n

store.commit('increment', 10)

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

// ...
mutations: 
  increment (state, payload) 
    state.counter += payload.amount

store.commit('increment', 
  counter: 10,
)

对象风格的提交方式

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

store.commit(
  type: 'increment',
  counter: 10,
)

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

mutations: 
  increment (state, payload) 
    state.counter += payload.counter

Mutation 需遵守 Vue 的响应规则

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

最好提前在你的 store 中初始化好所有所需属性。
当需要在对象上添加新属性时，你应该使用 Vue.set(obj, ‘newProp’, 123)，或者以新对象替换老对象。例如，利用对象展开运算符 (opens new window)我们可以这样写：

state.obj =  ...state.obj, newProp: 123

示例：

const store = new Vuex.Store(
  state: 
    myInfo: 
      name: 'stary',
      age: 18,
    ,
  ,
  mutations: 
    updateMyInfo(state, payload) 
      // 方式一
      // Vue.set(state.myInfo, 'height', payload.height)
      // 方式二
      state.myInfo = 
        ...state.myInfo,
        height: payload.height,
      
    ,
  ,
)

使用常量替代 mutation 事件类型

在 mutation 中，我们定义了很多事件类型（也就是其中的方法名称）。当我们的项目增大时，Vuex 管理的状态越来越多，需要更新状态的情况越来越多，那么意味着 Mutation 中的方法越来越多。

我们可以创建一个文件： mutation-types.js，并且在其中定义我们的常量。

定义常量时，我们可以使用 ES2015 中的风格，使用一个常量来作为函数的名称。

// 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
    
  
)

示例：

src/store/mutation-types.js

export const UPDATE_MY_INFO = 'UPDATE_MY_INFO'

import Vuex from 'vuex'
import  UPDATE_MY_INFO  from './mutation-types'

const store = new Vuex.Store(
	state: 
		myInfo: 
			name: 'stary',
			age: 18
		
	,
	mutations: 
		[UPDATE_MY_INFO](state, payload) 
			// 方式一
			// Vue.set(state.myInfo, 'height', payload.height)
			// 方式二
			state.myInfo = 
				...state.myInfo,
				height: payload.height

src/components/HelloWorld.vue

<script>
import  UPDATE_MY_INFO  from './../store/mutation-types'
export default 
  name: 'HelloWorld',
	methods: 
		updateMyInfo() 
			this.$store.commit(UPDATE_MY_INFO, height: 180)
		
	

</script>

Mutation 必须是同步函数

Vuex 要求我们 Mutation 中的方法必须是同步方法。

mutations: 
		[UPDATE_MY_INFO](state, payload) 
			setTimeout(() => 
				state.myInfo = 
					...state.myInfo,
					height: payload.height
				
			, 1000)

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

Actions

Action 类似于 mutation，不同在于：

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

Action 的基本使用代码如下：

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

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

分发 Action

在 Vue 组件中，如果我们调用 action 中的方法，那么就需要使用 store.dispatch：

store.dispatch('increment')

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

actions: 
  increment ( commit ) 
    setTimeout(() => 
      commit('increment')
    , 1000)

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

// 以载荷形式分发
store.dispatch('increment', 
  amount: 10,
)
// 以对象形式分发
store.dispatch(
  type: 'increment',
  amount: 10,
)

组合 Action

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

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

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

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())

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
    ,
  ,

项目结构

Vuex 并不限制你的代码结构。但是，它规定了一些需要遵守的规则：

应用层级的状态
以上是关于Vue 教程(四十九)Vuex 核心概念和项目结构的主要内容，如果未能解决你的问题，请参考以下文章

Vue 教程(四十九)Vuex 核心概念和项目结构

Vue 教程(四十九)Vuex 核心概念和项目结构

Vue教程(四十八)Vuex 概念和基本使用

Vue教程(四十八)Vuex 概念和基本使用

Vue教程(四十八)Vuex 概念和基本使用

Vue教程(四十八)Vuex 概念和基本使用