Vuex知识点梳理

技术总结 , 评论

Vuex 是专门为 vue.js 应用程序开发的状态管理模式，它采用集中式存储管理应用的所有组件的状态，并以相应的规则保证状态以一种可预测的方式发生变化。

vuex

基本概念

每一个 Vuex 应用的核心就是store（仓库），它是一个容器，包含着应用中大部分的 state（状态）。其有 2 点 不同于单纯的全局对象：

  1. store 中的 state 响应式的，当 Vue 组件从 store 中读取 state （状态）的时候，若 store 中 state（状态） 发生变化，相应的组件也会得到更新
  2. 不能直接改变 store 中的 state（状态）。唯一途径就是*显示地 commit （提交） mutation
1
2
3
4
5
6
7
8
9
10
11
12
13
import Vue from "vue";
import Vuex from "vuex";

const store = new Vuex.Store({
  state: {
    count: 0,
  },
  mutations: {
    increment(state) {
      state.count++;
    },
  },
});

State

Vuex 使用单一状态树，用一个对象包含全部的应用层级状态。每个应用仅包含一个 store 实例。

在 Vue 组件中获取 Vuex 状态

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

Vuex 通过store选项，可将 store 实例 从根组件”注入”到每一个子组件中。之后子组件就能通过this.$store访问到 store 实例。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import Vue from "vue";
import Vuex from "vuex";
Vue.use(Vuex);

const sotre = new Vuex.Store({
  modules: {
    cart,
    product,
  },
  // data
  state: {},
  // computed properties
  getters: {},

  actions,
  // update
  mutations: {},
});

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

mapState 辅助函数

当一个组件需要获取多个状态时，将这些状态都声明为计算属性会重复冗余。mapState辅助函数可帮助创建计算属性,并返回 store 中的状态。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// 在单独构建的版本中辅助函数为 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;
    },
  }),
};

Getter

Vuex 允许在 store 中 定义 “getter”,它可理解为 store 的计算属性。getter的返回值会根据它的依赖 被缓存起来，且只用当它的依赖发生了改变才会被重新计算。

在 store 上注册 getter，getter 方法 接受以下参数：

  • state , 如果在模块中定义则为模块的局部状态
  • getters, 等同于 store.getters
  • rootState, 全局 state 状态，即 store.state
  • rootGetters，全局getter, 即 所有 getters

访问 getter

  1. 注册的 getter,会暴露 为store.getters对象，可 通过属性形式 访问

    1
    2
    3
    4
    5
    computed: {
      doneTodosCount () {
        return this.$store.getters.doneTodosCount
      }
    }

  2. 让 getter 返回一个函数，来 实现给 getter 传参，则可通过方法访问，且每次都会取进行调用，而不会缓存结果

    1
    2
    3
    4
    5
    6
    7
    8
    9
    getters: {
      // ...
      getTodoById: (state) => (id) => {
        return state.todos.find((todo) => todo.id === id);
      };
    }

    // 组件内 访问
    this.$store.getters.getTodoById(2); // -> { id: 2, text: '...', done: false }

mapGetters 辅助函数

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import { mapGetters } from "vuex";

export default {
  // ...
  computed: {
    // 使用对象展开运算符将 getter 混入 computed 对象中
    ...mapGetters([
      "doneTodosCount",
      "anotherGetter",
      // ...
    ]),
    ...mapGetters({
      // 把 `this.doneCount` 映射为 `this.$store.getters.doneTodosCount`
      doneCount: "doneTodosCount", // 重新命名
    }),
  },
};

Mutation

更改 Vuex 的 store 中的状态的唯一方法就是提交 mutation。

mutation 非常类似于事件： 事件类型 （type）+ 处理函数（handler）。这个处理函数就是实际进行状态 更改的地方 。

mutation 必须时同步函数，因为要追踪 状态的改变，每一条 mutation 都会被记录，如果 mutation 是异步函数，devtools不知道什么时候回调函数被调用的。

注册 Mutation

在 store 上注册 mutation， 处理函数 总是接受 2 个参数

  1. state,如果 定义在模块中，则为模块的局部状态
  2. payload,提交的载荷
1
2
3
4
5
6
7
8
9
10
const store = new Vuex.Store({
  state: {
    count: 1,
  },
  mutations: {
    increment(state, payload) {
      state.count += payload.amount;
    },
  },
});

组件内提交 Mutation

  • 载荷方式：this.$store.commit('increment',{amount: 10})
  • 对象方式： this.$store.commit({type:'increment', amount: 10})

Action

当需要处理异步操作，需要在 Action。它类似 与 Mutation，不同在于：

  • Action 提交 的是 mutation, 而不是直接改变状态
  • Action 可以包含任意 异步操作

注册 Action

在 store 上 注册 action，处理函数接受 2 个参数，

  • context,一个与 store 实例具有相同方法和属性的对象，其包含以下属性：
    • state, 等同于 store.state, 若在 模块中 则为局部状态
    • rootState, 全局的 state
    • commit, 等同于 store.commit
    • dispatch, 等同于 store.dispatch
    • getters, 等同于 store.getters
    • rootGetters, 全局的 getter
  • payload,载荷
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
const store = new Vuex.Store({
  state: {
    count: 0,
  },
  mutations: {
    increment(state) {
      state.count++;
    },
  },
  actions: {
    incrementAsync({ commit }) {
      setTimeout(() => {
        commit("increment");
      }, 1000);
    },
  },
});

组件内分发 Action

  • 载荷方式：this.$store.dispatch('incrementAsync',{amount: 10})
  • 对象方式： this.$store.dispatch({type:'incrementAsync', amount: 10})

mapActions辅助函数

mapActions 辅助函数将组件的 methods 映射为 store.dispatch 调用

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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 什么时候结束？

因为store.dispatch是可以处理被触发的 action 的处理函数 返回 的 Promise,并且store.dispatch仍旧返回 Promise。那么利用此，就可以组合多个 action，处理复杂的异步流程。

需要注意

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

注册 action，处理函数 返回 Promise

1
2
3
4
5
6
7
8
9
10
actions: {
  actionA({commit}) {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        commit('someMutation');
        resolve();
      }, 1000)
    })
  }
}

在分发 action 时，就可处理 返回的 Promise

1
2
3
4
5
6
7
8
store.dispatch("actionA").then(
  () => {
    // ... resolved
  },
  () => {
    // ... rejected
  }
);

在另一个 action 中也可以

1
2
3
4
5
6
7
8
actions: {
  // ...
  actionB ({ dispatch, commit }) {
    return dispatch('actionA').then(() => {
      commit('someOtherMutation')
    })
  }
}

使用 async/await语法，轻松组合 action

1
2
3
4
5
6
7
8
9
10
11
// 假设 getData() 和 getOtherData() 返回的是 Promise

actions: {
  async actionA ({ commit }) {
    commit('gotData', await getData())
  },
  async actionB ({ dispatch, commit }) {
    await dispatch('actionA') // 等待 actionA 完成
    commit('gotOtherData', await getOtherData())
  }
}

Module

由于使用单一的状态树，应用的 store 对象可能变得十分臃肿。为解决该问题，Vuex 可以将 store 分割成 小的模块（module）。

每个模块都拥有自己的 state、getters、mutation、action、嵌套的子模块。

命名空间

默认情况下，模块内部的 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
37
38
39
40
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']
          }
        }
      }
    }
  }
})

在带命名空间的模块内访问全局内容

  • 想 使用全局 state、getter, rootState和rootGetters作为第三、第四个参数出入 getter 的处理函数，也会在 context对象的属性中

  • 想 在全局命名空间分发 action、提交 mutation，将{root: true}作为第三个参数，传入 dispatch,commit即可

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
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) { ... }
    }
  }
}

在带命名空间的 模块注册全局 action

添加 root: true，并将这个 action 的定义放在函数 handler 中

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  actions: {
    someOtherAction ({dispatch}) {
      dispatch('someAction')
    }
  },
  modules: {
    foo: {
      namespaced: true,

      actions: {
        someAction: {
          root: true,
          handler (namespacedContext, payload) { ... } // -> 'someAction'
        }
      }
    }
  }
}

带命名空间的 辅助函数

1
2
3
4
5
6
7
8
9
10
11
12
computed: {
  ...mapState({
    a: state => state.some.nested.module.a,
    b: state => state.some.nested.module.b
  })
},
methods: {
  ...mapActions([
    'some/nested/module/foo', // -> this['some/nested/module/foo']()
    'some/nested/module/bar' // -> this['some/nested/module/bar']()
  ])
}

对于上种情况，可将模块的命名 空间名称字符串 作为第一个参数传递给上述函数

1
2
3
4
5
6
7
8
9
10
11
12
computed: {
  ...mapState('some/nested/module', {
    a: state => state.a,
    b: state => state.b
  })
},
methods: {
  ...mapActions('some/nested/module', [
    'foo', // -> this.foo()
    'bar' // -> this.bar()
  ])
}

表单处理

在严格模式下，状态的变更不是由 mutation 处理函数引起的，将会抛出错误。因此，在 state 上使用v-model会比较棘手，例如

1
<input v-model="obj.message" />

当用户输入时，v-model会试图直接修改ob.message,而非提交 mutation. 有 2 种解决方法

  1. 不使用v-model指令,给<input>中绑定 value，然后监听input或change事件，事件回调中提交 mutation.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    <input :value="message" @input="updateMessage">

    computed: {
      ...mapState({
        message: state => state.obj.message
      })
    },
    methods: {
      updateMessage (e) {
        this.$store.commit('updateMessage', e.target.value)
      }
    }

  2. 使用带有 setter的 双向绑定的计算属性，

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    <input v-model="message">

    // ....
    computed: {
    	message: {
    		get () {
    			 return this.$store.state.obj.message
    		},
    		set () {
    			 this.$store.commit('updateMessage', value)
    		}
    	}
    }

爱学兮Front End & Vue & TypeScript

前端狗，偶尔思考，间歇式码字