Vuex重置store的方法记录

Vue项目中使用Vuex作为状态管理已经是比较通用的做法了,Vuex本质上类似全局的变量存储,方便在所有Vue组件中共享,而且也可以动态改变状态。

目前使用Vuex可以把登录数据保存到localStorage中,实现短时间内免登陆。

存储localStorage参考:Vue项目集成vuex-persistedstate

但是Vuex似乎没有考虑提供一个重置或者清空state的方法,需要自己来实现。

清理登录数据

注销时需要清理store比较麻烦,store是在内存中,哪怕是删除localStorage,也可能再次把内存中的store数据写入localStorage,造成注销失败。

直接删除localStorage

可以直接删除localStorage,删除后还需要刷新页面,似乎体验不是很好,整个页面会刷新。

window.localStorage.removeItem(STORAGE_KEY)
window.location.reload()

重置store

还是考虑从store下手,重置store的思路如下:

  1. store初始化的时候把store中的初始state存下来
  2. actionsmutations增加一个重置(__resetStoreState)方法,并把重置方法名称保存到重置方法列表
  3. 如果有子模块,递归处理子模块,重复第2步骤
  4. 提供一个外部访问的重置方法,具体逻辑就是把重置方法列表中的重置方法触发一下。
具体实现

具体代码如下(StoreHelper.js),依赖lodash库:

import cloneDeep from 'lodash/cloneDeep'
import store from '@/store'
import Vuex from 'vuex'
const TO_RESET_STORE_STATE_KEYS = [] // 需要清理的Key
const RESET_STORE_STATE_KEY = '__resetStoreState' // 内部清理方法名
/**
 * store重置初始化,递归处理子模块,并把需要重置的key保存下来
 *
 * @param configData store数据
 * @param excludeNames 不清理的模块名,有些数据可能需要在注销时也不清理
 * @param parentModuleKey 模块名拼接,处理子模块
 */
export function $createStoreWithResetHandler (configData, excludeNames = [], parentModuleKey = '') {
  const resetStoreKey = parentModuleKey ? `${parentModuleKey}/${RESET_STORE_STATE_KEY}` : RESET_STORE_STATE_KEY
  TO_RESET_STORE_STATE_KEYS.push(resetStoreKey) // reset相关key存入数组中
  if (configData.modules) {
    Object.keys(configData.modules).forEach(moduleName => {
      if (excludeNames.indexOf(moduleName) === -1) {
        const module = configData.modules[moduleName]
        const newParentModuleKey = parentModuleKey ? `${parentModuleKey}/${moduleName}` : moduleName
        $createStoreWithResetHandler(module, excludeNames, newParentModuleKey)
      }
    })
  }
  if (configData.state) {
    configData.mutations = configData.mutations || {}
    configData.actions = configData.actions || {}
    if (!configData.mutations[RESET_STORE_STATE_KEY]) {
      const initialState = cloneDeep(configData.state)
      configData.mutations[RESET_STORE_STATE_KEY] = state => Object.assign(state, cloneDeep(initialState))
    }
    if (!configData.actions[RESET_STORE_STATE_KEY]) {
      configData.actions[RESET_STORE_STATE_KEY] = ({ commit }) => commit(RESET_STORE_STATE_KEY)
    }
  }
  return configData
}
/**
 * 重置store方法
 *
 * @returns Promise
 */
export function $resetStoreState () { // 需要重置的key已经存下来,循环key触发重置
  const resetResults = TO_RESET_STORE_STATE_KEYS.map(resetKey => store.dispatch(resetKey))
  return Promise.allSettled(resetResults)
}
/**
 * 包装store,方便使用
 *
 * @param configData
 * @param excludeNames
 * @returns {Store<unknown>}
 */
export function $wrapStore (configData, excludeNames = []) {
  return new Vuex.Store($createStoreWithResetHandler(configData, excludeNames))
}
/**
 * 导出$resetStoreState方法,方便使用
 * Vue.use(StoreHelper)
 */
export default {
  install: (Vue, options = {}) => Object.assign(Vue.prototype, { $resetStoreState })
}

包装store搜集数据

包装store搜集state数据,以及需要触发reset的相关方法

store.js默认代码(去掉import):

Vue.use(Vuex)
export default new Vuex.Store({
  state: {},
  mutations: {},
  actions: {},
  modules: {
    Common: CommonStore,
    Theme: ThemeStore
  },
  plugins: [createPersistedState()]
})

修改代码也比较简单,把new Vuex.Store换成$wrapStore,如果部分模块不要reset,可以过滤掉:

Vue.use(Vuex)
Vue.use(StoreHelper)
export default $wrapStore({
  state: {},
  mutations: {},
  actions: {},
  modules: {
    Common: CommonStore,
    Theme: ThemeStore
  },
  plugins: [createPersistedState()]
}, ['Common']) // Common模块不要reset
触发store重置

在需要的地方触发一下重置,比如注销,然后跳转到登录页面即可

this.$resetStoreState().then(() => {
    // 跳转到登录页面
})
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容