vuex.3x的使用

2023-05-25 本文已影响0人 CarlosLynn

介绍

Vuex 是什么？

Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态，并以相应的规则保证状态以一种可预测的方式发生变化。
简单理解就是对vue 应用中多个组件的共享状态进行集中式的管理。

什么是“状态管理模式”？

从一个简单的 Vue 计数应用开始：

<!-- view -->
 <template>
  <div>
    <h1>{{ msg }}</h1>
    <div>
      <p>clicked: {{ count }}</p>
      <button @click="increment">点击+</button>
      <button @click="decrement">点击-</button>
    </div>
  </div>
</template> 

<script>
export default {
  name: "Test1",
  props: {
    msg: String,
  },
  // state
  data() {
    return {
      count: 0,
    };
  },
  // actions
  methods: {
    increment() {
      this.count++;
    },
    decrement() {
      this.count--;
    },
  },
};
</script>

这个状态自管理应用包含以下几个部分：

state，驱动应用的数据源；
view，以声明方式将 state 映射到视图；
actions，响应在 view 上的用户输入导致的状态变化。

以下是一个表示“单向数据流”理念的简单示意：

image.png

但是，当我们的应用遇到多个组件共享状态时，单向数据流的简洁性很容易被破坏：

多个视图依赖于同一状态。
来自不同视图的行为需要变更同一状态。
对于问题一，传参的方法对于多层嵌套的组件将会非常繁琐，并且对于兄弟组件间的状态传递无能为力。对于问题二，我们经常会采用父子组件直接引用或者通过事件来变更和同步状态的多份拷贝。以上的这些模式非常脆弱，通常会导致无法维护的代码。

因此，我们为什么不把组件的共享状态抽取出来，以一个全局单例模式管理呢？在这种模式下，我们的组件树构成了一个巨大的“视图”，不管在树的哪个位置，任何组件都能获取状态或者触发行为！

通过定义和隔离状态管理中的各种概念并通过强制规则维持视图和状态间的独立性，我们的代码将会变得更结构化且易维护。
Vuex 是专门为 Vue.js 设计的状态管理库，以利用 Vue.js 的细粒度数据响应机制来进行高效的状态更新。
[图片上传失败...(image-f7d6a7-1685094988384)]

什么情况下我应该使用 Vuex？

Vuex 可以帮助我们管理共享状态，并附带了更多的概念和框架。这需要对短期和长期效益进行权衡。

一个简单的 [store 模式就足够您所需了。但是，如果您需要构建一个中大型单页应用，您很可能会考虑如何更好地在组件外部管理状态，Vuex 将会成为自然而然的选择。

安装

NPM

安装最新版本

npm install vuex --save

安装指定版本

npm install vuex@3.6.2 --save

卸载安装过的vuex

npm uninstall 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。这样使得我们可以方便地跟踪每一个状态的变化，从而让我们能够实现一些工具帮助我们更好地了解我们的应用。

最简单的 Store

我们来创建一个 store。创建过程直截了当——仅需要提供一个初始 state 对象和一些 mutation：

import Vue from "vue";
import Vuex from "vuex";
Vue.use(Vuex);

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

现在，你可以通过 $store.state 来获取状态对象，以及通过 $store.commit方法触发状态变更：

this.$store.state.count

this.$store.commit("increment");
this.$store.commit("decrement");

为了在 Vue 组件中访问 this.$store property，你需要为 Vue 实例提供创建好的 store。Vuex 提供了一个从根组件向所有子组件，以 store 选项的方式“注入”该 store 的机制：

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

如果使用 ES6，你也可以以 ES6 对象的 property 简写 (用在对象某个 property 的 key 和被传入的变量同名时)：

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

从组件的方法提交一个变更：

  methods: {
    increment() {
      this.$store.commit("increment");
      console.log("increment:" + this.$store.state.count);
    },
    decrement() {
      this.$store.commit("decrement");
      console.log("decrement:" + this.$store.state.count);
    },
  },

再次强调，我们通过提交 mutation 的方式，而非直接改变 store.state.count，是因为我们想要更明确地追踪到状态的变化。这个简单的约定能够让你的意图更加明显，这样你在阅读代码的时候能更容易地解读应用内部的状态改变。此外，这样也让我们有机会去实现一些能记录每次状态改变，保存状态快照的调试工具。

由于 store 中的状态是响应式的，在组件中调用 store 中的状态简单到仅需要在计算属性中返回即可。触发变化也仅仅是在组件的 methods 中提交 mutation。

核心概念

State

单一状态树

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

单状态树和模块化并不冲突。

存储在 Vuex 中的数据和 Vue 实例中的 data 遵循相同的规则，例如状态对象必须是纯粹 (plain) 的。

在 Vue 组件中获得 Vuex 状态

那么我们如何在 Vue 组件中展示状态呢？由于 Vuex 的状态存储是响应式的，从 store 实例中读取状态最简单的方法就是在[计算属性中返回某个状态：
创建一个Counter 组件

 <template>
  <div>
    <h1>{{ msg }}</h1>
    <div>
      <p>计算属性取值: {{ count }}</p>
    </div>
  </div>
</template> 

<script>
export default {
  name: "Counter",
  props: {
    msg: String,
  },
  computed: {
    count() {
      return this.$store.state.count;
    },
  },
};
</script>

每当 store.state.count变化的时候, 都会重新求取计算属性，并且触发更新相关联的 DOM。
通过在根实例中注册 store 选项，该 store 实例会注入到根组件下的所有子组件中，且子组件能通过 this.$store 访问到。

mapState 辅助函数

当一个组件需要获取多个状态的时候，将这些状态都声明为计算属性会有些重复和冗余。为了解决这个问题，我们可以使用 mapState 辅助函数帮助我们生成计算属性，让你少按几次键且能够便捷的获取多个状态：

 <template>
  <div>
    <h1>{{ msg }}</h1>
    <div>
      <p>映射取值count: [{{ count }}]</p>
      <p>箭头函数映射取值count: [{{ count2 }}]</p>
      <p>映射取值name: [{{ name }}]</p>
      <p>别名映射取值name: [{{ nameAlias }}]</p>
      <p>函数映射取值: [{{ countplustempcount }}]</p>
      <p>其他函数映射取值: [{{ countplustempcount2 }}]</p>
    </div>
  </div>
</template> 

<script>
import { mapState } from "vuex";
export default {
  name: "Test3",
  props: {
    msg: String,
  },
  data() {
    return {
      temp: "hello",
      tempcount: 1,
      tempcount2: 2,
    };
  },
  computed: mapState({
    // 箭头函数可使代码更简练
    count2: (state) => state.count,
    name: (state) => state.name, // function   映射 this.name 为 store.state.name的值
    // 传字符串参数 映射 this.count 为 store.state.count的值
    count: "count",
    nameAlias: "name", // string   映射 this.nameAlias 为 store.state.name的值
    //为了能够使用 `this` 获取局部状态，必须使用常规函数
    countplustempcount: function (state) {
      return this.tempcount + state.count;
    },
    countplustempcount2(state) {
      return this.tempcount2 + state.count;
    },
  }),
};
</script>

当映射的计算属性的名称与 state 的子节点名称相同时，我们也可以给 mapState 传一个字符串数组。

  computed: {
    localComputed() {
      return this.tempCount + 10;
    },
    ...mapState(["count", "name"]),
  },

对象展开运算符

mapState 函数返回的是一个对象。我们如何将它与局部计算属性混合使用呢？通常，我们需要使用一个工具函数将多个对象合并为一个，以使我们可以将最终对象传给 computed 属性。但是自从有了对象展开运算符，我们可以极大地简化写法：

<script>
import { mapState } from "vuex";
export default {
  name: "Test4",
  props: {
    msg: String,
  },
  data() {
    return {
      temp: "hello:this is localComputed",
      tempCount: 1,
    };
  },
  computed: {
    //局部计算属性
    localComputed() {
      return this.tempCount + 10;
    },
    // 使用对象展开运算符将此对象混入到外部对象中
    ...mapState({
      count: (state) => state.count,
      name: (state) => state.name,
      countComputed: function (state) {
        return this.tempCount + state.count;
      },
    }),
  },
};
</script>

组件仍然保有局部状态

使用 Vuex 并不意味着你需要将所有的状态放入 Vuex。虽然将所有的状态放到 Vuex 会使状态变化更显式和易调试，但也会使代码变得冗长和不直观。如果有些状态严格属于单个组件，最好还是作为组件的局部状态。你应该根据你的应用开发需要进行权衡和确定。

Getter

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

computed: {
  doneTodosCount () {
    return this.$store.state.todos.filter(todo => todo.done).length
  }
}

如果有多个组件需要用到此属性，我们要么复制这个函数，或者抽取到一个共享函数然后在多处导入它——无论哪种方式都不是很理想。

Vuex 允许我们在 store 中定义“getter”（可以认为是 store 的计算属性）。
Getter 接受 state 作为其第一个参数：

const store = new Vuex.Store({
  state: {
    count: 0,
    name: "zxn",
    todos: [
      { id: 1, text: "吃早饭", done: true },
      { id: 2, text: "学习vue", done: true },
      { id: 3, text: "吃午饭", done: false },
    ],
  },
  getters: {
    count: (state) => {
      return state.count;
    },
    doneTodos: (state) => {
      return state.todos.filter((todo) => todo.done);
    },
  },

  mutations: {
    increment(state) {
      state.count++;
    },
    decrement(state) {
      state.count--;
    },
  },
});

通过属性访问

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

  methods: {
    testGetter() {
      console.log("testGetter:" + this.$store.getters.count);
      this.testValue = this.$store.getters.count;
      console.log();
      let obj = this.$store.getters.doneTodos;
      console.log("testGetter:" + JSON.stringify(obj));
      return this.testValue;
    },
  },

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

getters: {
  // ...
  doneTodosCount: (state, getters) => {
    return getters.doneTodos.length
  }
}

store.getters.doneTodosCount // -> 2

我们可以很容易地在任何组件中使用它：

  computed: {
    doneTodosCount() {
      return this.$store.getters.doneTodosCount;
    },
  },

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

通过方法访问

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

getters: {
  // ...
  getTodoById: (state) => (id) => {
    return state.todos.find(todo => todo.id === id)
  }
}

store.getters.getTodoById(2) // -> { id: 2, text: '...', done: false }

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

mapGetters 辅助函数

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

  computed: {
    doneTodosCount() {
      return this.$store.getters.doneTodosCount;
    },
    getTodoById() {
      let todo = this.$store.getters.getTodoById(2);
      console.log(JSON.stringify(todo));
      return todo.text;
    },
    // 使用对象展开运算符将 getter 混入 computed 对象中
    ...mapGetters(["count", "doneTodos"]),
  },

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

Mutation

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

const store = new Vuex.Store({
  state: {
    count: 1
  },
  mutations: {
    increment (state) {
      // 变更状态
      state.count++
    }
  }
})

你不能直接调用一个 mutation handler。这个选项更像是事件注册：“当触发一个类型为 increment 的 mutation 时，调用此函数。”要唤醒一个 mutation handler，你需要以相应的 type 调用 store.commit 方法：

store.commit('increment')

提交载荷（Payload）

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

mutations: {
  increment (state, n) {
    state.count += n
  }
}

this.$store.commit("increment", n);

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

  mutations: {
    incrementByObj(state, payload) {
      state.count += payload.amount;
    },
  },

    increment5() {
      this.$store.commit("incrementByObj", {
        amount: 5,
      });
    },

对象风格的提交方式

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

    increment10() {
      this.$store.commit({
        type: "incrementByObj",
        amount: 10,
      });
    },

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

mutations: {
  increment (state, payload) {
    state.count += payload.amount
  }
}

提交荷载有两种方式：

// 把载荷和type分开提交
store.commit('increment', {
 amount: 10
})
 
// 整个对象都作为载荷传给mutation函数
store.commit({
 type: 'increment',
 amount: 10
})

Mutation 需遵守 Vue 的响应规则

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

最好提前在你的 store 中初始化好所有所需属性。
当需要在对象上添加新属性时，你应该

使用 Vue.set(obj, 'newProp', 123)

console.log("update:之前:" + JSON.stringify(this.person));
this.$set(this.person, "age", 35);
this.$set(this.person, "gender", "male");
console.log("update:之后:" + JSON.stringify(this.person));

以新对象替换老对象。例如，利用[对象展开运算符我们可以这样写：

state.obj = { ...state.obj, newProp: 123 }
this.person = { ...this.person, type: "黄种人" }

使用常量替代 Mutation 事件类型

使用常量替代 mutation 事件类型在各种 Flux 实现中是很常见的模式。这样可以使 linter 之类的工具发挥作用，同时把这些常量放在单独的文件中可以让你的代码合作者对整个 app 包含的 mutation 一目了然：

// mutation-types.js
export const DECREMENT_NUMBER = "decrementNumber";
export const DECREMENT_BY_OBJ = "decrementByObj";

// store.js
import Vuex from 'vuex'
import { DECREMENT_NUMBER, DECREMENT_BY_OBJ } from "./mutation-types";

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

使用代码代码

<script>
import { DECREMENT_NUMBER, DECREMENT_BY_OBJ } from "../store/mutation-types";
export default {
  methods: {
    decrementNumber(n) {
      this.$store.commit(DECREMENT_NUMBER, n);
      //store.dispatch('increment');
    },
    decrement5() {
      this.$store.commit({
        type: DECREMENT_BY_OBJ,
        amount: 5,
      });
    },
  },
};
</script>

用不用常量取决于你——在需要多人协作的大型项目中，这会很有帮助。但如果你不喜欢，你完全可以不这样做。

Mutation 必须是同步函数

一条重要的原则就是要记住 mutation 必须是同步函数。为什么？请参考下面的例子：

mutations: {
  someMutation (state) {
    api.callAsyncMethod(() => {
      state.count++
    })
  }
}

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

在组件中提交 Mutation

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

<script>
import { mapMutations } from "vuex";
import { DECREMENT_NUMBER, DECREMENT_BY_OBJ } from "../store/mutation-types";
export default {
  methods: {
    decrementNumber(n) {
      this.$store.commit(DECREMENT_NUMBER, n);
    },
    decrement5() {
      this.$store.commit({
        type: DECREMENT_BY_OBJ,
        amount: 5,
      });
    },
    ...mapMutations([
      "increment", // 将 `this.increment()` 映射为 `this.$store.commit('increment')`
      "decrement", // 将 `this.decrement()` 映射为 `this.$store.commit('decrement')`
      // `mapMutations` 也支持载荷：
      "incrementNumber", // 将 `this.incrementNumber(amount)` 映射为 `this.$store.commit('incrementNumber', amount)`
    ]),
    ...mapMutations({
      sub1: "decrement", // 将 `this.sub1()` 映射为 `this.$store.commit('decrement')`
    }),
  },
};
</script>

在 mutation 中混合异步调用会导致你的程序很难调试。例如，当你调用了两个包含异步回调的 mutation 来改变状态，你怎么知道什么时候回调和哪个先回调呢？这就是为什么我们要区分这两个概念。在 Vuex 中，mutation 都是同步事务：

Action

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。
context 对象不是 store 实例本身了!
实践中，我们会经常用到 ES2015 的参数解构来简化代码（特别是我们需要调用 commit 很多次的时候）：

actions: {
  increment ({ commit }) {
    commit('increment')
  }
}

分发 Action

Action 通过 store.dispatch 方法触发：

store.dispatch('increment')

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

  actions: {
    incrementAsync({ commit }) {
      setTimeout(() => {
        commit("increment");
        //commit("increment2");
      }, 1000);
    },
  },

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

    increment3() {
      // 以对象形式分发
      this.$store.dispatch({
        type: "incrementAsync2",
        amount: 3,
      });
    },
    increment2() {
      // 以载荷形式分发
      this.$store.dispatch("incrementAsync2", {
        amount: 2,
      });
    },

actions的函数定义.

  actions: {
    incrementAsync2({ commit }, payload) {
      setTimeout(() => {
        commit("incrementByObj", payload);
      }, 1000);
    },
  },
});

注意我们正在进行一系列的异步操作，并且通过提交 mutation 来记录 action 产生的副作用（即状态变更）。

在组件中分发 Action

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

<script>
import { mapActions } from "vuex";
export default {
  name: "Test8",
  props: {
    msg: String,
  },
  methods: {
    increment1() {
      this.$store.dispatch("incrementAsync");
    },
    ...mapActions([
      "increment", // 将 `this.increment()` 映射为 `this.$store.dispatch('increment')`

      // `mapActions` 也支持载荷：
      "incrementNumber", // 将 `this.incrementNumber(amount)` 映射为 `this.$store.dispatch('incrementNumber', amount)`
    ]),
    ...mapActions({
      sub: "decrement", // 将 `this.sub()` 映射为 `this.$store.dispatch('decrement')`
    }),
  },
};
</script>

组合 Action

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

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

  actions: {
    add10({ commit }) {
      return new Promise((resolve, reject) => {
        setTimeout(() => {
          commit("incrementNumber", 6);
          resolve();
        }, 1000);
      });
    },
 //...
}

现在你可以：

this.$store.dispatch("add10").then(() => {
        this.incrementNumber(4);
      });

在另外一个 action 中也可以：

add5({ dispatch, commit }) {
      return dispatch("add6").then(() => {
        commit("decrement");
      });
    },

最后，如果我们利用 async / await (opens new window)，我们可以如下组合 action：

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

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

Module

由于使用单一状态树，应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时，store 对象就有可能变得相当臃肿。

为了解决以上问题，Vuex 允许我们将 store 分割成模块（module）。每个模块拥有自己的 state、mutation、action、getter、甚至是嵌套子模块——从上至下进行同样方式的分割：

const moduleDemo1 = {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... },
  getters: { ... }
}

const moduleDemo1 = {
  state: () => ({ ... }),
  mutations: { ... },
  actions: { ... }
}

const store = new Vuex.Store({
  modules: {
    demo1: moduleDemo1,
    demo2: moduleDemo2,
  }
})

store.state.demo1 // -> moduleDemo1 的状态
store.state.demo2 // ->moduleDemo2的状态

模块的局部状态

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

/**
 * 用于展示demo1中的模块部分状态
 */
const moduleDemo1 = {
  /**
   * 模块内的state对象
   */
  state: () => ({
    /**
     * 初始化状态数据
     */
    count: 0,
  }),
  mutations: {
    // 这里的 `state` 对象是模块的局部状态
    increment(state) {
      state.count++;
    },
  },
  getters: {
    // 这里的 `state` 对象是模块的局部状态
    oddOrEven(state) {
      return state.count % 2 === 0 ? "偶数" : "奇数";
    },
  },
};

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

const moduleDemo1 = {
  actions: {
    incrementIfOddOnRootSum ({ state, commit, rootState }) {
      if ((state.count + rootState.count) % 2 === 1) {
        commit('increment')
      }
    }
  }
}

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

const moduleDemo1 = {
  getters: {
    sumWithRootCount (state, getters, rootState) {
      return state.count + rootState.count
    }
  }
}

命名空间

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

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

/**
 * 用于展示demo1中的模块部分状态
 */
const moduleDemo1 = {
  namespaced: true,
  state: () => ({
    count: 0,
  }),
  mutations: {
    increment(state) {
      state.count++;
    },
    decrement(state) {
      state.count--;
    },
  },
  actions: {
    increment({ commit }) {
      commit("increment");
    },
    decrement({ commit }) {
      commit("decrement");
    },
    incrementIfOdd({ commit, state }) {
      if (state.count % 2 === 1) {
        commit("increment");
      }
    },
    incrementAsync({ commit }) {
      setTimeout(() => {
        commit("increment");
      }, 1000);
    },
    incrementIfOddOnRootSum({ state, commit, rootState }) {
      if ((state.count + rootState.count) % 2 === 1) {
        commit("increment");
      }
    },
  },
  getters: {
    oddOrEven(state) {
      return state.count % 2 === 0 ? "偶数" : "奇数";
    },
    sumWithRootCount(state, getters, rootState) {
      return state.count + rootState.count;
    },
  },
  modules: {
    // 继承父模块的命名空间
    page: {
      state: () => ({ title: "demo1的page" }),
      getters: {
        test(state) {
          return state.title; // -> getters['demo1/test']
        },
      },
    },
    // 进一步嵌套命名空间
    code: {
      namespaced: true,
      state: () => ({ number: 721 }),
      getters: {
        numberType(state) {
          return state.number % 2 === 0
            ? "偶数:" + state.number
            : "奇数:" + state.number; // -> getters['demo1/code/numberType']
        },
      },
    },
  },
};

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

在带命名空间的模块内访问全局内容（Global Assets）

如果你希望使用全局 state 和 getter，rootState 和 rootGetters 会作为第三和第四参数传入 getter，也会通过 context 对象的属性传入 action。
若需要在全局命名空间内分发 action 或提交 mutation，将 { root: true } 作为第三参数传给 dispatch 或 commit 即可。

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

若需要在带命名空间的模块注册全局 action，你可添加 root: true，并将这个 action 的定义放在函数 handler 中。例如：

{
  actions: {
    someOtherAction ({dispatch}) {
      dispatch('someAction')
    }
  },
  modules: {
    foo: {
      namespaced: true,

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

带命名空间的绑定函数

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

对于这种情况，你可以将模块的空间名称字符串作为第一个参数传递给上述函数，这样所有绑定都会自动将该模块作为上下文。于是上面的例子可以简化为：

computed: {
  ...mapState('some/nested/module', {
    a: state => state.a,
    b: state => state.b
  })
},
methods: {
  ...mapActions('some/nested/module', [
    'foo', // -> this.foo()
    'bar' // -> this.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'
    ])
  }
}

模块动态注册

在 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 访问模块的状态。

模块动态注册功能使得其他 Vue 插件可以通过在 store 中附加新模块的方式来使用 Vuex 管理状态。例如，vuex-router-sync (opens new window)插件就是通过动态注册模块将 vue-router 和 vuex 结合在一起，实现应用的路由状态管理。

你也可以使用 store.unregisterModule(moduleName) 来动态卸载模块。注意，你不能使用此方法卸载静态模块（即创建 store 时声明的模块）。

注意，你可以通过 store.hasModule(moduleName) 方法检查该模块是否已经被注册到 store。
在注册一个新 module 时，你很有可能想保留过去的 state，例如从一个服务端渲染的应用保留 state。你可以通过 preserveState 选项将其归档：store.registerModule('a', module, { preserveState: true })。

当你设置 preserveState: true 时，该模块会被注册，action、mutation 和 getter 会被添加到 store 中，但是 state 不会。这里假设 store 的 state 已经包含了这个 module 的 state 并且你不希望将其覆写。

进阶

项目结构

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

1.应用层级的状态应该集中到单个 store 对象中。

2.提交 mutation 是更改状态的唯一方法，并且这个过程是同步的。

3.异步逻辑都应该封装到 action 里面。

只要你遵守以上规则，如何组织代码随你便。如果你的 store 文件太大，只需将 action、mutation 和 getter 分割到单独的文件。

对于大型应用，我们会希望把 Vuex 相关代码分割到模块中。下面是项目结构示例：

├── index.html
├── main.js
├── api
│   └── ... # 抽取出API请求
├── components
│   ├── App.vue
│   └── ...
└── store
    ├── index.js          # 我们组装模块并导出 store 的地方
    ├── actions.js        # 根级别的 action
    ├── mutations.js      # 根级别的 mutation
    └── modules
        ├── cart.js       # 购物车模块
        └── products.js   # 产品模块

插件

严格模式

表单处理

测试

热重载

参考文献

github 站点: https://github.com/vuejs/vuex
在线文档: https://vuex.vuejs.org/zh-cn/