天天看点

深入理解vuex1、什么是vuex?理解状态管理的核心概念getterMutationActionModule项目结构参考文档:

1、什么是vuex?

Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式。它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化,从而到达各个组件之间的数据共享!

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

引用 Redux 的作者 Dan Abramov 的话说就是:

Flux 架构就像眼镜:您自会知道什么时候需要它。

当我们的项目越来越复杂时,多个视图可能公用一个状态,并且不同视图需要变更同一个状态时,我们就发现传参的方法对于多层嵌套的组件将会非常繁琐,并且对于兄弟组件间的状态传递无能为力,并且简单的store存储已经不能满足我们的需求,维护起来也比较困难。所以当我们考虑如何在组件外部更好的管理状态时,就是我们需要vuex的时候了。

理解状态管理的核心概念

state

单一状态树,用一个对象就包含了全部的应用层级状态,如下所示,state对象中存储的我们需要的是一个一个的状态。

state: {

    state1: '状态1',
    state2: {
                name: 状态2,
                id: 2
            }

}
           

如何获取state

  • 从store中获取state :  this.$store.state.count

Vuex 通过 

store

 选项,提供了一种机制将状态从根组件“注入”到每一个子组件中(需调用 

Vue.use(Vuex)

),且子组件能通过 

this.$store

 可以访问到。

const app = new Vue({
  el: '#app',
  // 把 store 对象提供给 “store” 选项,这可以把 store 的实例注入所有的子组件
  store,
  components: { Counter },
  template: `
    <div class="app">
      <counter></counter>
    </div>
  `
})
           
  • mapState中获取

当一个组件需要获取多个状态时候,将这些状态都声明为计算属性会有些重复和冗余。因为每一个计算属性都是一个函数,并且需要我们每个都写return this.$store.state不是很方便。为了解决这个问题,我们可以使用 

mapState

 辅助函数帮助我们生成计算属性。它的两种用法,或接受一个对象,或接受一个数组

// 在单独构建的版本中辅助函数为 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
    }
  })
}
           

当映射的计算属性的名称与 state 的子节点名称相同时,我们也可以给 

mapState

 传一个字符串数组。

computed: mapState([
  // 映射 this.count 为 store.state.count
  'count'
])
           

mapState

 函数返回的是一个对象。我们如何将它与局部计算属性混合使用呢?通常,我们需要使用一个工具函数将多个对象合并为一个,以使我们可以将最终对象传给 

computed

 属性。但是自从有了对象展开运算符(现处于 ECMAScript 提案 stage-4 阶段),我们可以极大地简化写法:

computed: {
  localComputed () { /* ... */ },
  // 使用对象展开运算符将此对象混入到外部对象中
  ...mapState({
    'count',
    'people'
  })
}
           

mapState通过扩展运算符将store.state.count 映射this.count,  这个映射直接映射到当前Vue的this对象上。

所以通过this都能将这些对象点出来,这将大大的简化了我们的代码。同理,mapGetters, mapActions, mapMutations都是一样的道理。

getter

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

为什么要用getter

有的组件中获取到 store 中的state,  需要对进行加工才能使用,computed 属性中就需要写操作函数,如果有多个组件中都需要进行这个操作,那么在各个组件中都写相同的函数,那就非常麻烦,这时可以把这个相同的操作写到store 中的getters,  每个组件只要引用getter 就可以了,非常方便。Getter 就是把组件中共有的对state 的操作进行了提取,它就相当于对state 的computed. 所以它会获得state 作为第一个参数。

如何访问getter?

  • 通过属性访问

Getter 会暴露为 

store.getters

 对象,你可以以属性的形式访问这些值:

store.getters.doneTodos // -> [{ id: 1, text: '...', done: true }]
           

Getter 也可以接受getters 作为第二个参数,并使用其他的getter:

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

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

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

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

  • 通过方法访问

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

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


.vue文件

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

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

  • 利用mapGetters

mapGetters

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

import { mapGetters } from 'vuex'

export default {
  // ...
  computed: {
  // 使用对象展开运算符将 getter 混入 computed 对象中
    ...mapGetters([
      'doneTodosCount',
      'anotherGetter',
      // ...
    ])
  }
}
           

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

mapGetters({
  // 把 `this.doneCount` 映射为 `this.$store.getters.doneTodosCount`
  doneCount: 'doneTodosCount'
})
           

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')    //increment 为mutation的type


//对象风格的提交方式(当使用对象风格的提交方式,整个对象都作为载荷传给 mutation 函数)
store.commit({
  type: 'increment',
  amount: 10
})
           

提交载荷(Payload) 

你可以向 

store.commit

 传入额外的参数,即 mutation 的 载荷(payload):

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

}
//在大多数情况下,载荷应该是一个对象,这样可以包含多个字段并且记录的 mutation 会更易读
           
store.commit('increment', 10);

store.commit('decrement', countobj);
           

mapMutations辅助提交

import { mapMutations } from 'vuex'

export default {
  // ...
  methods: {
    ...mapMutations([
      'increment', // 将 `this.increment()` 映射为 `this.$store.commit('increment')`

      // `mapMutations` 也支持载荷:
      'incrementBy' // 将 `this.incrementBy(amount)` 映射为 `this.$store.commit('incrementBy', amount)`
    ]),
    ...mapMutations({
      add: 'increment' // 将 `this.add()` 映射为 `this.$store.commit('increment')`
    })
  }
}
           

mutation使用过程中需要注意的点

  1. 通常情况下,使用常量来定义mutation的type
  2. mutation必须是同步函数
  3. 修改对象时,需要遵循vue修改对象规则
Vue.set(obj, 'newProp', 123)
           

或是:

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

Action

Action 类似于 mutation,不同在于:

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

让我们来注册一个简单的 action:

const store = new Vuex.Store({
  state: {
    count: 0
  },
  mutations: {
    increment (state) {
      state.count++
    }
  },
  actions: {
    increment (context) {  //context对象与store实例具有相同方法和属性
      context.commit('increment')
    },
    decrement ({ commit }) {  //参数解构,当需要在一个action中触发多个commit时,这种用法很方便
      commit('decrement')
    }
  }
})
           

分发action

store.dispatch('increment')
           

为什么通过action来提交mutation,而不是直接提交mutation?

一个anction是可以提交多个commit的,当这些commit直接通过mutation提交时,只能同步进行,而action内部可以执行异步操作。

来看一个更加实际的购物车示例,涉及到调用异步 API 和分发多重 mutation

actions: {
//action支持对象方式和负载方式提交mutation
  checkout ({ commit, state }, products) {
    // 把当前购物车的物品备份起来
    const savedCartItems = [...state.cart.added]
    // 发出结账请求,然后乐观地清空购物车
    commit(types.CHECKOUT_REQUEST)
    // 购物 API 接受一个成功回调和一个失败回调
    shop.buyProducts(
      products,
      // 成功操作
      () => commit(types.CHECKOUT_SUCCESS),
      // 失败操作
      () => commit(types.CHECKOUT_FAILURE, savedCartItems)
    )
  }
}
           

 mapActions辅助分发

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 什么时候结束呢?更重要的是,我们如何才能组合多个 action,以处理更加复杂的异步流程?

首先,你需要明白 

store.dispatch

 可以处理被触发的 action 的处理函数返回的 Promise,并且 

store.dispatch

 仍旧返回 Promise

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

Module

由于使用单一状态树,应用的所有状态会集中到一个比较大的对象。当应用变得非常复杂时,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 的状态
           

默认情况下,模块内部的actions,mutations, getters是注册在全局命名空间上的,只有state是需要通过分模块来访问的。但是在模块内部的mutation 和 getter,接收的第一个参数是模块的局部状态对象。模块内部的action局部状态通过 

context.state

 暴露出来,根节点状态则为 

context.rootState,

模块的局部状态

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

const moduleA = {
  state: { count: 0 },
  mutations: {
    increment (state) {
      // 这里的 `state` 对象是模块的局部状态
      state.count++
    }
  },

  getters: {
    doubleCount (state, mutations) {
      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
    }
  }
}
           

命名空间

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

如果希望你的模块具有更高的封装度和复用性,你可以通过添加 

namespaced: true

 的方式使其成为带命名空间的模块。当模块被注册后,它的所有 getter、action 及 mutation 都会自动根据模块注册的路径调整命名。例如

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

在带命名空间的模块内访问全局内容(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) { ... }
    }
  }
}
           

带命名空间的绑定函数

当使用 

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

项目结构

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

  1. 应用层级的状态应该集中到单个 store 对象中。
  2. 提交 mutation 是更改状态的唯一方法,并且这个过程是同步的。
  3. 异步逻辑都应该封装到 action 里面。

只要遵守以上规则,如何组织你的代码结构都是ok的。在我们实际项目中,我们一般会根据项目的大小以及复杂程度对项目的结构进行区分,以下是我给出的推荐方式。

简单且不复杂项目

  1. 直接写在一个store文件中,所有的states、actions、mutations、getters写在一起。统一进行管理
import Vue from 'vue';
import Vuex from 'vuex';
import _ from 'lodash';

Vue.use(Vuex);

export default new Vuex.Store({
    state: {
      todos: [
        { id: 1, text: '...', done: true },
        { id: 2, text: '...', done: false }
      ]
    },
    getters: {
      doneTodos: state => {
        return state.todos.filter(todo => todo.done)
      }
    },
    actions: {
      toDoToday({commit}) {
        coomit('TO_DO_TODAY');
      }
    },
    mutations: {
      TO_DO_TODAY(state) {
        _.forEach(state.todos, todo=>{
          if(!todo.done){
            todo.done = true;
          }
        });
      }
    
    }  

});
           

复杂项目使用modules来进行管理

目录结构:

深入理解vuex1、什么是vuex?理解状态管理的核心概念getterMutationActionModule项目结构参考文档:

各个模块分模块1统一进行管理

import Vue from 'vue';
import Vuex from 'vuex';
import state from './states';
import mutations from './mutations';
import actions from './actions';
import getters from './getters';
import okrModules from './modules/okr';
import missionModules from './modules/mission';

Vue.use(Vuex);

export default new Vuex.Store({
  modules: {
    okr: okrModules,
    mission: missionModules,
  },
  state,
  mutations,
  actions,
  getters
});


//state.okr.currentOid  获取okr模块内的state
//state.mission.currentPid 获取mission模块内的state
           

将store挂载到vue身上,然后在各vue文件中访问

//分发模块内的action
this.$store.dispatch('okr/setObjective', null);

//获取模块内的getters
this.$store.getters['mission/getProjectType'];
           

当涉及到模块的东西时,需要详细的了解以上关于模块的描述,基本就可以理解了!

参考文档:

https://vuex.vuejs.org/zh/