VUEX开发教程

为什么要做这篇文集呢？市面上关于 vuex 的教程多如牛毛，甚至 vuex 被某些大神都封装出花儿来了；一方面是想从最简单最基础的地方带大家使用一下 vuex，另一方面也是想让自己复习一下 vuex，好，不多废话了，接下来我们简单对 vuex 介绍一下，这究竟是个啥？

第一步，如果你想了解一个技术，就去他的官网去看，准没错，进入官网，映入眼帘的就是 “vuex 是什么”：

如图所示，它是一个程序里面的状态管理模式，它是集中式存储所有组件的状态的小仓库，并且保持我们存储的状态以一种可以预测的方式发生变化。对于可以预测，现在我不多做说明，相信在看完这篇文章之后，你就会有自己的理解。

第一步，了解 Vuex

🤯 想象一个场景

如果你的项目里有很多页面（组件 / 视图），页面之间存在多级的嵌套关系，此时，这些页面假如都需要共享一个状态的时候，此时就会产生以下两个问题：

多个视图依赖同一个状态
来自不同视图的行为需要变更同一个状态

🤪 动动你的小脑袋你就会想到解决以上方法的方案:

对于第一个问题，假如是多级嵌套关系，你可以使用父子组件传参进行解决，虽有些麻烦，但好在可以解决；对于兄弟组件或者关系更复杂组件之间，就很难办了，虽然可以通过各种各样的办法解决，可实在很不优雅，而且等项目做大了，代码就会变成屎山，实在令人心烦。
对于第二个问题，你可以通过父子组件直接引用，或者通过事件来变更或者同步状态的多份拷贝，这种模式很脆弱，往往使得代码难以维护，而且同样会让代码变成屎山。

😇 此时，既然思考到了这里，如果换一种思路呢：

把各个组件都需要依赖的同一个状态抽取出来，在全局使用单例模式进行管理。
在这种模式下，任何组件都可以直接访问到这个状态，或者当状态发生改变时，所有的组件都获得更新。

👶 这时候，Vuex 诞生了！

这就是 Vuex 背后的基本思想，借鉴了 Flux、Redux。与其他模式不同的是，Vuex 是专门为 Vue 设计的状态管理库，以利用 Vue.js 的细粒度数据响应机制来进行高效的状态更新。

😨 接着，你就会看到下面这张官网的 vuex 使用周期图（看不懂没关系）：

🤩 什么时候应该用 vuex 呢？

这个问题因人而异，如果你不需要开发大型的单页应用，此时你完全没有必要使用 vuex，比如你的页面就两三个，使用 vuex 后增加的文件比你现在的页面还要多，那就没这个必要了。
假如你的项目达到了中大型应用的规模，此时您很可能会考虑如何更好地在组件外部管理状态，Vuex 将会成为自然而然的选择。

🤔 对于 vuex 的简单介绍就到这里，接下来，我们一起用起来吧！

第二步，安装

进入项目，在命令行中输入安装指令，回车

npm install vuex --save

然后配置 vuex，使其工作起来：在 src 路径下创建 store 文件夹，然后创建 index.js 文件，文件内容如下：

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

Vue.use(Vuex);

const store = new Vuex.Store({
  state: {
    // 定义一个name，以供全局使用
    name: '张三',
    // 定义一个number，以供全局使用
    number: 0,
    // 定义一个list，以供全局使用
    list: [
      { id: 1, name: '111' },
      { id: 2, name: '222' },
      { id: 3, name: '333' },
    ],
  },
});

export default store;

修改 main.js：

import Vue from 'vue';
import App from './App';
import router from './router';
import store from './store'; // 引入我们前面导出的store对象

Vue.config.productionTip = false;

new Vue({
  el: '#app',
  router,
  store, // 把store对象添加到vue实例上
  components: { App },
  template: '<App/>',
});

最后修改 App.vue：

<template>
  <div></div>
</template>

<script>
export default {
  mounted() {
    // 使用this.$store.state.XXX可以直接访问到仓库中的状态
    console.log(this.$store.state.name);
  },
};
</script>

此时，启动项目npm run dev，即可在控制台输出刚才我们定义在 store 中的 name 的值。

🤖 官方建议 1：官方建议我们以上操作 this.$store.state.XXX 最好放在计算属性中，当然，我也建议你这么使用，这样可以让你的代码看起来更优雅一些，就像这样：

export default {
  mounted() {
    console.log(this.getName);
  },
  computed: {
    getName() {
      return this.$store.state.name;
    },
  },
};

此时可以得到和上面一样的效果。

🤖 官方建议 2：是不是每次都写 this.$store.state.XXX 让你感到厌烦，你实在不想写这个东西怎么办，当然有解决方案，就像下面这样：

<script>
import { mapState } from 'vuex'; // 从vuex中导入mapState
export default {
  mounted() {
    console.log(this.name);
  },
  computed: {
    ...mapState(['name']), // 经过解构后，自动就添加到了计算属性中，此时就可以直接像访问计算属性一样访问它
  },
};
</script>

你甚至可以在解构的时候给它赋别名，取外号，就像这样：

...mapState({ aliasName: 'name' }),  // 赋别名的话，这里接收对象，而不是数组

🤗 至此，安装 vuex 并且初始化的工作就结束了，此时你可以很轻易的在项目的任意地方访问到仓库里的状态

第三步，了解修饰器：Getter

当你看到这里的时候，证明你上一步已经完美的创建好一个 vue 项目，并且将 vuex 安装了进去！

好！接下来，我们介绍一个读取操作的 “修饰利器” ---Getter

🤨 设想一个场景，你已经将 store 中的 name 展示到页面上了，而且是很多页面都展示了，此时产品经理过来找事儿😡：
产品经理：所有的 name 前面都要加上 “hello”！
我：为什么？
产品经理：我提需求还需要为什么吗？
我：好，我加！

这时候，你第一想到的是怎么加呢，emm... 在每个页面上，使用 this.$store.state.name 获取到值之后，进行遍历，前面追加 "hello" 即可。

🤦🏻‍♂️ 错！这样很不好，原因如下：

第一，假如你在 A、B、C 三个页面都用到了 name，那么你要在这 A、B、C 三个页面都修改一遍，多个页面你就要加很多遍这个方法，造成代码冗余，很不好；
第二，假如下次产品经理让你把 “hello” 改成 “fuck” 的时候，你又得把三个页面都改一遍，这时候你只能抽自己的脸了...

👏🏻 吸取上面的教训，你会有一个新的思路：我们可以直接在 store 中对 name 进行一些操作或者加工，从源头解决问题！那么具体应该怎么写呢？这时候，本次将要介绍的这个 Getter 利器闪亮登场！

🤡 怎么用呢？不废话，show code！

首先，在 store 对象中增加 getters 属性

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

Vue.use(Vuex);

const store = new Vuex.Store({
  state: {
    name: '张三',
    number: 0,
    list: [
      { id: 1, name: '111' },
      { id: 2, name: '222' },
      { id: 3, name: '333' },
    ],
  },
  // 在store对象中增加getters属性
  getters: {
    getMessage(state) {
      // 获取修饰后的name，第一个参数state为必要参数，必须写在形参上
      return `hello${state.name}`;
    },
  },
});

export default store;

在组件中使用：

export default {
  mounted() {
    // 注意不是$store.state了，而是$store.getters
    console.log(this.$store.state.name);
    console.log(this.$store.getters.getMessage);
  },
};

然后查看控制台：

没有问题的

🤖 官方建议：是不是每次都写 this.$store.getters.XXX 让你感到厌烦，你实在不想写这个东西怎么办，当然有解决方案，官方建议我们可以使用 mapGetters 去解构到计算属性中，就像使用 mapState 一样，就可以直接使用 this 调用了，就像下面这样：

<script>
import { mapState, mapGetters } from 'vuex';
export default {
  mounted() {
    console.log(this.name);
    console.log(this.getMessage);
  },
  computed: {
    ...mapState(['name']),
    ...mapGetters(['getMessage']),
  },
};
</script>

此时可以得到和之前一样的效果。

当然，和 mapState 一样你也可以取别名，取外号，就像下面这样：

...mapGetters({ aliasName: 'getMessage' }),  // 赋别名的话，这里接收对象，而不是数组

🤗 OK，当你看到这里，你已经成功的把 Getter 用起来了，你也能明白在什么时候应该用到 getters，你可以通过计算属性访问（缓存），也可以通过方法访问（不缓存），你甚至可以在 getters 的方法里面再调用 getters 方法，当然你也实现了像 state 那样，使用 mapGetters 解构到计算属性中，这样你就可以很方便的使用 getters 啦！

😎 读取值的操作我们有 “原生读（state）” 和 “修饰读（getters）”，接下来就要介绍怎么修改值了！

第四步，了解如何修改值：Mutation

🤗 OK！首先恭喜你看到了这里，至此，我们已经成功访问到了 store 里面的值，接下来我来介绍一下怎么修改 state 里面的值。

说到修改值，有的同学就会想到这样写：

// 错误示范
this.$store.state.XXX = XXX;

🤪 首先，这里我先明确的说明：这是错误的写法！这是错误的写法！这是错误的写法！

为什么上面是错误的写法？因为这个 store 仓库比较奇怪，你可以随便拿，但是你不能随便改，我举个例子：

🤔 假如你打开微信朋友圈，看到你的好友发了动态，但是动态里有个错别字，你要怎么办呢？你可以帮他改掉吗？当然不可以！我们只能通知他本人去修改，因为是别人的朋友圈，你是无权操作的，只有他自己才能操作，同理，在 vuex 中，我们不能直接修改仓库里的值，必须用 vuex 自带的方法去修改，这个时候，Mutation 闪亮登场了！

😬 把问题解释清楚之后，我们准备完成一个效果：我们先输出 state 中的 number 的默认值 0，然后我们在 vue 组件里通过提交 Mutations 改变 number 的默认值 0，改成我们想修改的值，然后再输出出来，这样就可以简单练习怎么使用 Mutations 了。不说废话，上代码。

修改 store/index.js

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

Vue.use(Vuex);

const store = new Vuex.Store({
  state: {
    name: '张三',
    number: 0,
  },
  mutations: {
    // 增加nutations属性
    setNumber(state) {
      // 增加一个mutations的方法，方法的作用是让num从0变成5，state是必须默认参数
      state.number = 5;
    },
  },
});

export default store;

修改 App.vue

<script>
export default {
  mounted() {
    console.log(`旧值：${this.$store.state.number}`);
    this.$store.commit('setNumber');
    console.log(`新值：${this.$store.state.number}`);
  },
};
</script>

运行项目，查看控制台：

🤡 以上是简单实现 mutations 的方法，是没有传参的，如果我们想传不固定的参数怎么办？接下来教你解决
修改 store/index.js

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

Vue.use(Vuex);

const store = new Vuex.Store({
  state: {
    name: '张三',
    number: 0,
  },
  mutations: {
    setNumber(state) {
      state.number = 5;
    },
    setNumberIsWhat(state, number) {
      // 增加一个带参数的mutations方法
      state.number = number;
    },
  },
});

export default store;

修改 App.vue

<script>
export default {
  mounted() {
    console.log(`旧值：${this.$store.state.number}`);
    this.$store.commit('setNumberIsWhat', 666);
    console.log(`新值：${this.$store.state.number}`);
  },
};
</script>

运行项目，查看控制台：

没有问题！

注意：上面的这种传参的方式虽然可以达到目的，但是并不推荐，官方建议传递一个对象进去，这样看起来更美观，对象的名字你可以随意命名，但我们一般命名为 payload，代码如下：
修改 store/index.js

mutations: {
    setNumber(state) {
      state.number = 5;
    },
    setNumberIsWhat(state, payload) {
      // 增加一个带参数的mutations方法，并且官方建议payload为一个对象
      state.number = payload.number;
    },
  },

修改 App.vue

<script>
export default {
  mounted() {
    console.log(`旧值：${this.$store.state.number}`);
    this.$store.commit('setNumberIsWhat', { number: 666 }); // 调用的时候也需要传递一个对象
    console.log(`新值：${this.$store.state.number}`);
  },
};
</script>

此时可以得到和之前一样的效果，并且代码更加美观！

😱 这里说一条重要原则：Mutations里面的函数必须是同步操作，不能包含异步操作！（别急，后面会讲到异步）

好的，记住这个重要原则，我们再说一个小技巧：

🤖 官方建议：就像最开始的 mapState 和 mapGetters 一样，我们在组件中可以使用 mapMutations 以代替 this.$store.commit('XXX')，是不是很方便呢？

<script>
import { mapMutations } from 'vuex';
export default {
  mounted() {
    this.setNumberIsWhat({ number: 999 });
  },
  methods: {
    // 注意，mapMutations是解构到methods里面的，而不是计算属性了
    ...mapMutations(['setNumberIsWhat']),
  },
};
</script>

此时可以得到和之前一样的效果，并且代码又美观了一点！
当然你也可以给它叫别名，取外号，就像这样：

methods: {
  ...mapMutations({ setNumberIsAlias: 'setNumberIsWhat' }), // 赋别名的话，这里接收对象，而不是数组
},

🤔 OK，关于 Mutation 的介绍大致就是这样，另外你也掌握了在定义 mutations 方法的时候有无参数应该怎么写；并且听取了官方建议，使用 mapMutations 解构到你的组件内部的 methods 里，这样你就可以很简单的使用 mutations 方法啦！
🤪 上面提到，Mutations 只能进行同步操作，所以，我们马上开始下一节，看看使用 Actions 进行异步操作的时候应该注意什么！

第五步，了解异步操作：Actions

😆 OK！本节我们来学习使用 Actions，Actions 存在的意义是假设你在修改 state 的时候有异步操作，vuex 作者不希望你将异步操作放在 Mutations 中，所以就给你设置了一个区域，让你放异步操作，这就是 Actions

😛 我们直接上一个代码

修改 store/index.js

const store = new Vuex.Store({
  state: {
    name: '张三',
    number: 0,
  },
  mutations: {
    setNumberIsWhat(state, payload) {
      state.number = payload.number;
    },
  },
  actions: {
    // 增加actions属性
    setNum(content) {
      // 增加setNum方法，默认第一个参数是content，其值是复制的一份store
      return new Promise(resolve => {
        // 我们模拟一个异步操作，1秒后修改number为888
        setTimeout(() => {
          content.commit('setNumberIsWhat', { number: 888 });
          resolve();
        }, 1000);
      });
    },
  },
});

修改 App.vue

async mounted() {
  console.log(`旧值：${this.$store.state.number}`);
  await this.$store.dispatch('setNum');
  console.log(`新值：${this.$store.state.number}`);
},

运行项目，查看控制台：

🤓 看了例子，是不是明白了，action 就是去提交 mutation 的，什么异步操作都在 action 中消化了，最后再去提交 mutation 的。

😼 当然，你可以模仿 mutation 进行传参，就像下面这样：

修改 store/index.js

actions: {
  setNum(content, payload) {
    // 增加payload参数
    return new Promise(resolve => {
      setTimeout(() => {
        content.commit('setNumberIsWhat', { number: payload.number });
        resolve();
      }, 1000);
    });
  },
},

修改 App.vue

async mounted() {
  console.log(`旧值：${this.$store.state.number}`);
  await this.$store.dispatch('setNum', { number: 611 });
  console.log(`新值：${this.$store.state.number}`);
},

运行项目，查看控制台

没有任何问题！

🤖 官方建议 1：你如果不想一直使用 this.$store.dispatch('XXX') 这样的写法调用 action，你可以采用 mapActions 的方式，把相关的 actions 解构到 methods 中，用 this 直接调用：

<script>
import { mapActions } from 'vuex';
export default {
  methods: {
    ...mapActions(['setNum']), // 就像这样，解构到methods中
  },
  async mounted() {
    await this.setNum({ number: 123 }); // 直接这样调用即可
  },
};
</script>

当然，你也可以取别名，取外号，就像下面这样：

...mapActions({ setNumAlias: 'setNum' }),   // 赋别名的话，这里接收对象，而不是数组

🤖 官方建议 2：在 store/index.js 中的 actions 里面，方法的形参可以直接将 commit 解构出来，这样可以方便后续操作：

actions: {
  setNum({ commit }) {
    // 直接将content结构掉，解构出commit，下面就可以直接调用了
    return new Promise(resolve => {
      setTimeout(() => {
        commit('XXXX'); // 直接调用
        resolve();
      }, 1000);
    });
  },
},

🤠 OK，看到这里，你应该明白 action 在 vuex 的位置了吧，什么时候该用 action，什么时候不用它，你肯定有了自己的判断，最主要的判断条件就是我要做的操作是不是异步，这也是 action 存在的本质。当然，你不要将 action 和 mutation 混为一谈，action 其实就是 mutation 的上一级，在 action 这里处理完异步的一些操作后，后面的修改 state 就交给 mutation 去做了。

第六步，按属性进行拆分

🤯 接下来我们想象一下，目前我们介绍的 store/index.js 里面的内容是非常少的，如果你是一个稍微有些规格的项目，那么你将会得到一个成百上千行的 index.js，然后查找一些东西就会非常费劲，我们建议你的一个文件内的行数尽量不要超过 200 行，不然对于调试来说没有好处。既然问题出来了，我们看一下怎么拆分一下。

🤒 我们看到，一个 store/index.js 里面大致包含 state/getters/mutations/actions 这四个属性，我们可以彻底点，index.js 里面就保持这个架子，把里面的内容四散到其他文件中。

于是我们可以这样拆分：

新建四个文件，分别是state.js getters.js mutations.js actions.js：

1. 拆出来state放到state.js中：

// state.js

export const state = {
  name: '张三',
  number: 0,
  list: [
    { id: 1, name: '111' },
    { id: 2, name: '222' },
    { id: 3, name: '333' },
  ],
};

1. 拆出来getters放到getters.js中：

// getters.js

export const getters = {
  getMessage(state) {
    return `hello${state.name}`;
  },
};

1. 拆出来mutations放到mutations.js中：

// mutations.js

export const mutations = {
  setNumber(state) {
    state.number = 5;
  },
};

1. 拆出来actions放到actions.js中：

// actions.js

export const actions = {
  setNum(content) {
    return new Promise(resolve => {
      setTimeout(() => {
        content.commit('setNumberIsWhat', { number: 888 });
        resolve();
      }, 1000);
    });
  },
};

组装到主文件里面：

import Vue from 'vue';
import Vuex from 'vuex';
import { state } from './state'; // 引入 state
import { getters } from './getters'; // 引入 getters
import { mutations } from './mutations'; // 引入 mutations
import { actions } from './actions'; // 引入 actions

Vue.use(Vuex);

const store = new Vuex.Store({
  state: state,
  getters: getters,
  mutations: mutations,
  actions: actions,
});

// 可以简写成下面这样：

// const store = new Vuex.Store({ state, getters, mutations, actions });

export default store;

🤓 以上就是简单的进行了按属性进行拆分 store 里面的代码，这样就比较清晰了哈，你需要加什么就去哪里加，大家各干各的，互不影响。

当然，你完全可以不这么做，引用官方文档中的一句话，“需要多人协作的大型项目中，这会很有帮助。但如果你不喜欢，你完全可以不这样做”。

第七步，按功能进行拆分 - Module

😜 上面我们介绍如何拆分项目，采用的是按属性的方式去拆分，将 getters/actions/mutations 等属性拆分到不同的文件中。

接下来，我们介绍一下按另外的一个维度去拆分我们的 store，‘按功能’，按功能拆分的话，就是我们的标题 Module(模块) 。

🤖 我们先来看下官方文档是怎么介绍 Module 的：

看了图中的描述，你或许已经区分了这里使用的按功能拆分 Module 和我们上次介绍的按属性拆分的异同了；就像图中的场景一样，我们有一个总 store，在这里面根据不同的功能，我们加了两个不同的 store，每个 store 里面维护自己的 state，以及自己的 actions/mutations/getters。
🤡 不说废话，我们用代码实现一下
1. 我们在之前的 store 上，增加一个新的仓库 store2，主要代码如下：

// store2.js

const store2 = {
  state: {
    name: '我是store2',
  },
  mutations: {},
  getters: {},
  actions: {},
};

export default store2;

1. 然后在 store 中引入我们新创建的 store2 模块：

import Vue from 'vue';
import Vuex from 'vuex';
import { state } from './state';
import { getters } from './getters';
import { mutations } from './mutations';
import { actions } from './actions';
import store2 from './store2'; // 引入store2模块

Vue.use(Vuex);

const store = new Vuex.Store({
  modules: { store2 }, // 把store2模块挂载到store里面
  state: state,
  getters: getters,
  mutations: mutations,
  actions: actions,
});

export default store;

1. 访问 state - 我们在 App.vue 测试访问 store2 模块中的 state 中的 name，结果如下：

<template>
  <div></div>
</template>

<script>
export default {
  mounted() {
    console.log(this.$store.state.store2.name); // 访问store2里面的name属性
  },
};
</script>

我们通过下面的代码可以了解到在不同的属性里是怎么访问 模块内的状态 或者 根状态：

mutations: {
  changeName(state, payload) {
    // state 局部状态
    console.log(state);
    console.log(payload.where);
  },
},
getters: {
  testGetters(state, getters, rootState) {
    // state 局部状态
    console.log(state);
    // 局部 getters,
    console.log(getters);
    // rootState 根节点状态
    console.log(rootState);
  },
},
actions: {
  increment({ state, commit, rootState }) {
    // state 局部状态
    console.log(state);
    // rootState 根节点状态
    console.log(rootState);
  },
},

以上是对 module 的简单介绍，其实这里就是一种思想，分而治之，将复杂的进行拆分，可以更有效的管理。

其实以上并不是 module 的全部，还有一些比如命名空间、模块注册全局 action、带命名空间的绑定函数、模块动态注册、模块重用等方法这里就没介绍，如果你在项目中使用到了，再进行查阅即可，有时候不需要完全理解，知道有这个东西就行，知道出了问题的时候该去哪查资料就够啦。😊

第八步，总结

🤗 好！大致对 vuex 的讲解就到这里了，看到这里你肯定对 vuex 不陌生了，你会安装它，配置它，读取 state 的值，甚至修饰读 (Getter)，然后你会修改里面的值了 (Mutation)，假如你有异步操作并且需要修改 state，那你就要使用 Action，这样，你就可以在你的项目中用起来 vuex 啦！加油吧！🤔

VUEX开发教程

第一步，了解 Vuex

🤯 想象一个场景​

🤪 动动你的小脑袋你就会想到解决以上方法的方案:​

😇 此时，既然思考到了这里，如果换一种思路呢：​

👶 这时候，Vuex 诞生了！​

😨 接着，你就会看到下面这张官网的 vuex 使用周期图（看不懂没关系）：​

🤩 什么时候应该用 vuex 呢？​

🤔 对于 vuex 的简单介绍就到这里，接下来，我们一起用起来吧！​