vuex冷门实例方法replaceState、watch、subscribe、subscribeAction等介绍

前言

vuex的热门实例方法其实就2个,commit和dispatch,冷门方法倒是不少,虽然你可能一辈子不用都不妨碍开发一个牛逼的项目,但是有些功能你学了或许真的能用上。

官方文档:https://vuex.vuejs.org/zh/api/#vuex-store-实例方法

replaceState

官方文档就一句话,替换 store 的根状态,仅用状态合并或时光旅行调试。

状态合并

看这段代码:

      if (sessionStorage.getItem("store")) {
        this.$store.replaceState(Object.assign({}, this.$store.state, JSON.parse(sessionStorage.getItem("store"))))
        console.log('正在从sessionStorage恢复store')
        console.log(this.$store.state)
        sessionStorage.removeItem("store")
      }

我们经常遇到一个问题就是,刷新页面导致状态丢失,一个解决方案就是使用sessionStorage随时储存state,刷新页面出发created则判断sessionStorage.state是否有内容,有则覆盖原state。

这里注意:

  1. replaceState是覆盖state,合并的工作要使用Object.assign(),当然了,大部分时候并不需要合并,因为sessionStorage里的就是最新的state,直接覆盖就行了。

  2. 尽量避免使用这个方法,在错误的位置使用这个方法会造成数据被错误覆盖,只应该在非常有必要恢复state的时候才使用,更多的时候,如果用户刷新页面,应让用户从头走操作流程,只有在连续答题、购物等少数场合需要用到,而且并不是必须使用,依然有其他变通方法。

时光旅行调试

时光旅行调试是指devtools提供的时光旅行调试,这里提到时光旅行调试,我其实不太明白其中的意思,可能的意思有两个,不是一就是二:

  1. devtools自己调用replaceState方法来时光旅行,无需开发者写任何代码。

  2. 开发者在某些代码位置覆盖state,这种可能性比较小。

watch

官方文档是:

watch(fn: Function, callback: Function, options?: Object): Function
响应式地侦听 fn 的返回值,当值改变时调用回调函数。fn 接收 store 的 state 作为第一个参数,其 getter 作为第二个参数。最后接收一个可选的对象参数表示 Vue 的 vm.$watch 方法的参数。
要停止侦听,调用此方法返回的函数即可停止侦听。

这个方法的作用就是监听state或是getters的变化,它实际上跟vue实例的watch作用差不多,比如state有一个状态叫a:

  created() {
    this.$store.watch((state, getter) => {
      return state.a
    }, (newVal) => {
      console.log('变成了', newVal);
    });
  },

只要state的a有变化,就会被监听到。

vue实例的watch也可以监听state或是getters的变化,区别大约是:

  • vue实例的watch监听更倾向于监听data的变化

  • vuex实例的watch监听state似的代码更容易维护

所以vuex实例的watch可用可不用。

subscribe

官方文档:

subscribe(handler: Function): Function
订阅 store 的 mutation。handler 会在每个 mutation 完成后调用,接收 mutation 和经过 mutation 后的状态作为参数:
store.subscribe((mutation, state) => { console.log(mutation.type) console.log(mutation.payload) })
要停止订阅,调用此方法返回的函数即可停止订阅。
通常用于插件。详细介绍

比如:

  state: {
    a: '1'
  },
  mutations: {
    SET_A(state, n) {
      state.a += n;
    },
  },
  created() {
    this.$store.subscribe((mutation, state) => {
      console.log('mutation.type', mutation.type)
      console.log('mutation.payload', mutation.payload)
      console.log('state.a', state.a)
    });
  },
  methods: {
    x() {
      this.$store.commit('SET_A', 3);
      console.log(this.$store.state.a);
    }
  }

现在执行this.x(),得到:

mutation.type SET_A
mutation.payload 3
state.a 13
13

可见,subscribe的回调函数的执行先于this.$store.commit()之后的代码。

subscribe的用途比如为mutation添加统一的回调函数等等,还是蛮有用的。

subscribeAction

跟subscribe类似,

  actions: {
    ACTION_A(context, n) {
      console.log('ACT_A run');
      context.commit('SET_A', n);
    }
  },
    this.$store.subscribeAction((action, state) => {
      console.log('action.type', action.type)
      console.log('action.payload', action.payload)
      console.log('state.a', state.a)
    });

得到:

action.type ACTION_A
action.payload 3
state.a 1
ACT_A run
13

可见,subscribeAction的回调函数会在ACTION_A的所有代码之前执行,如果想改成之后执行,需要按照官网手册改成after对象:

    this.$store.subscribeAction({after: (action, state) => {
      console.log('action.type', action.type)
      console.log('action.payload', action.payload)
      console.log('state.a', state.a)
    }});

得到:

ACT_A run
13
action.type ACTION_A
action.payload 3
state.a 1

可见,subscribeAction的回调函数不仅仅是落后于ACTION_A,甚至比this.$store.dispatch()后面的同步代码还要落后。

registerModule和unregisterModule

registerModule用来动态注册一个新的module,也是只在插件中使用,因为但凡你能写死module,也犯不着动态注册,一旦必须动态注册,一定是在外部插件中使用。

unregisterModule用于反注册module。

这两个方法就不细说了,因为https://vuex.vuejs.org/zh/guide/modules.html#模块动态注册说的很清楚。

hotUpdate

这个方法除非是Vue.js的高级开发者,不然真的用不上,手册在https://vuex.vuejs.org/zh/guide/hot-reload.html,我目前也只是在学习中,就不多说了。

总结

这几个方法,我个人理解的学习优先级由高到低是:

  • subscribe、subscribeAction

  • watch

  • replaceState

  • 其他

replaceState、watch、subscribe、subscribeAction这几个不在插件中也依然好用,可以在恰当场合下使用。

你可能感兴趣的:(vuex冷门实例方法replaceState、watch、subscribe、subscribeAction等介绍)