vuex中Modules的使用詳解

2022-04-17 13:00:29

前言

在Vue中State使用是單一狀態樹結構，應該的所有的狀態都放在state裡面，如果專案比較複雜，那state是一個很大的物件，store物件也將對變得非常大，難於管理。於是Vuex中就存在了另外一個核心概念 modules。本文就來總結 modules 相關知識點。

1 、什麼是模組Modules

Vuex允許我們將store分割成模組(Module), 而每個模組擁有自己的state、getters、mutation、action等,甚至是巢狀子模組——從上至下進行同樣方式的分割。

const moduleA = {
        state: () => ({ ... }),
        mutations: { ... },
        actions: { ... },
        getters: { ... }
    }
    const moduleB = {
        state: () => ({ ... }),
        mutations: { ... },
        actions: { ... }
    }
    const store = new Vuex.Store({
        modules: {
            a: moduleA,
            b: moduleB
        }
    })
    this.store.state.a // -> 獲得moduleA 的狀態
    this.store.state.b // -> 獲得moduleB 的狀態

內部state，模組內部的state是區域性的，也就是模組私有的，

內部getter,mutation,action 仍然註冊在全域性名稱空間內，這樣使得多個模組能夠對同一 mutation 或 action 作出響應。

2、模組內部引數問題

對於模組內部的 mutation 和 getter，接收的第一個引數是模組的區域性狀態物件 state。

對於模組內部的 action，區域性狀態通過 context.state 暴露出來，根節點狀態則為 context.rootState：

對於模組內部的 getter，根節點狀態會作為第三個引數暴露出來：

const moduleA = {
        state: () => ({
            count:"",
        }),
        actions: {
            //這裡的state為區域性狀態，rootState為根節點狀態
            incrementIfOddOnRootSum ({ state, commit, rootState }) {
                if ((state.count + rootState.count) % 2 === 1) {
                    commit('increment')
                }
            }
        }
        mutations: {
            // 這裡的 `state` 物件是模組的區域性狀態
            increment (state) {
                state.count++
            }
        },
        getters: {
            //這裡的state為區域性狀態，rootState為根節點狀態
            doubleCount (state) {
                return state.count * 2
            },
            sumWithRootCount (state, getters, rootState) {
                return state.count + rootState.count
            }
        }
    }

3、模組名稱空間問題

（1）namespaced: true 使模組成為帶名稱空間的模組

當模組被註冊後，它的所有 getter、action 及 mutation 都會自動根據模組註冊的路徑調整命名。

const store = new Vuex.Store({
  modules: {
    account: {
      namespaced: true,
      // 模組內容（module assets） 在使用模組內容（module assets）時不需要在同一模組內額外新增空間名字首。
      state: () => ({}), // 模組內的狀態已經是巢狀的了，使用 `namespaced` 屬性不會對其產生影響
      getters: {
        isAdmin() {}, // ->使用: getters['account/isAdmin'],
        // 你可以使用 getter 的第四個引數來呼叫
        someGetter(state, getters, rootState, rootGetters) {
          // getters.isAdmin
          // rootGetters.someOtherGetter
        },
      },
      actions: {
        login() {}, // ->使用: dispatch('account/login')
        // 你可以使用 action 的第四個引數來呼叫
        //若需要在全域性名稱空間內分發 action 或提交 mutation，將 { root: true } 作為第三引數傳給 dispatch 或 commit 即可
        someAction({ dispatch, commit, getters, rootGetters }) {
          // getters.isAdmin;
          // rootGetters.someGetter;
          // dispatch("someOtherAction");
          // dispatch("someOtherAction", null, { root: true });
          // commit("someMutation");
          // commit("someMutation", null, { root: true });
        },
        someOtherAction(ctx, payload) {},
        // 若需要在帶名稱空間的模組註冊全域性 action，你可新增 root: true，並將這個 action 的定義放在函數 handler 中。
        otherAction: {
          root: true,
          handler(namespacedContext, payload) {}, // -> 'someAction'
        },
      },
      mutations: {
        login() {}, // ->使用: commit('account/login')
      },
      // 巢狀模組
      modules: {
        // 繼承父模組的名稱空間
        myPage: {
          state: () => ({}),
          getters: {
            profile() {}, // -> 使用:getters['account/profile']
          },
        },

        // 進一步巢狀名稱空間
        posts: {
          namespaced: true,

          state: () => ({}),
          getters: {
            popular() {}, // -> 使用:getters['account/posts/popular']
          },
        },
      },
    },
  },
});

（2）帶名稱空間的繫結函數的使用

當使用 mapState, mapGetters, mapActions 和 mapMutations 這些函數來繫結帶名稱空間的模組時，寫起來可能比較繁瑣：

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

createNamespacedHelpers 建立基於某個名稱空間輔助函數,它返回一個物件，物件裡有新的繫結在給定名稱空間值上的元件繫結輔助函數。

import { createNamespacedHelpers } from 'vuex'
        const { mapState, mapActions } = createNamespacedHelpers('some/nested/module')
        export default {
            computed: {
                // 在 `some/nested/module` 中查詢
                ...mapState({
                a: state => state.a,
                b: state => state.b
                })
            },
            methods: {
                // 在 `some/nested/module` 中查詢
                ...mapActions([
                    'foo',
                    'bar'
                ])
            }
        }

4、模組動態註冊

在 store 建立之後，你可以使用 store.registerModule 方法註冊模組

import Vuex from 'vuex'
        const store = new Vuex.Store({ /* 選項 */ })
        // 註冊模組 `myModule`
        store.registerModule('myModule', {
            // ...
        })
        // 註冊巢狀模組 `nested/myModule`
        store.registerModule(['nested', 'myModule'], {
            // ...
        })

之後就可以通過 store.state.myModule 和 store.state.nested.myModule 存取模組的狀態。

也可以使用 store.unregisterModule(moduleName) 來動態解除安裝模組。注意，你不能使用此方法解除安裝靜態模組（即建立 store 時宣告的模組）。

可以通過 store.hasModule(moduleName) 方法檢查該模組是否已經被註冊到 store。