vue keep-alive 和vue-router 控制组件缓存

写在开头

终极解决方法,直接看文章 解决循环跳转页面不刷新 部分

浏览器前进刷新后退不刷新

这一部分用来祭奠我曾经掉落在地的几根头发和逝去的时间。

  • 思路:

    1. vue 页面浏览记录后退的能力是通过插件 vue-router 实现的。而 vue-rotuer 通过history.pushState 方法增加浏览记录(或者history.replaceState),然后通过监听 popstate 事件来监听浏览器当前会话页面后退行为。
    2. vue-rotuer 调用history.pushState 的时候会传入一个{key: _key /*唯一值*/} 对象,而捕获 popstate 事件时,可以通过 e.state.key 获取这个唯一值
    3. 基于以上两点,我们可以通过收集 key 值来组成页面之间的跳转记录,然后通过 popstate 事件的key值来判断页面是前进还是后退。页面前进时,直接使用 keep-alive 组件缓存当前页面;如果页面后退,那么在回到上一个页面之前从 keep-alive 中清除当前页面缓存
  • 实现代码

    <!-- 组件 keep-previous-alive 代码 -->
    
    <template>
      <keep-alive>
        <slot />
      </keep-alive>
    </template>
    
    <script>
    let routerHistory = [];
    
    function remove(arr, item) {
      if (arr.length) {
        const index = arr.indexOf(item);
        if (index > -1) {
          return arr.splice(index, 1);
        }
      }
    }
    
    // 清除 keep-alive 中的缓存
    function pruneCacheEntry(cache, key, keys) {
      const cached = cache[key];
      if (cached) {
        cached.componentInstance.$destroy();
      }
      cache[key] = null;
      remove(keys, key);
    }
    
    function handleAfterEachRouter(to, from) {
      const historyState = window.history.state || {};
      const historyStateKey = historyState.key;
      const index = routerHistory.indexOf(historyStateKey);
    
      if (index > -1) {
        // 回到旧页面
        routerHistory.splice(index + 1);
      } else {
        // 进入新页面
        routerHistory.push(historyStateKey);
      }
    }
    
    function handleBeforeEachRouter(to, from, next) {
      // setTimeout 确保 handlePopstate 方法的调用是在进入下个页面之前
      setTimeout(() => {
        next();
      }, 0);
    }
    
    function setup(com) {
      const router = com.$router;
    
      if (router.beforeHooks.indexOf(handleBeforeEachRouter) <= -1) {
        router.beforeEach(handleBeforeEachRouter);
      }
    
      if (router.afterHooks.indexOf(handleAfterEachRouter) <= -1) {
        router.afterEach(handleAfterEachRouter);
      }
    }
    
    export default {
      name: 'keep-previous-alive',
      components: {},
      props: {},
      data() {
        return {
          keepAliveVnode: null,
        };
      },
      methods: {
        handlePopstate(e) {
          const state = e.state || {};
          const stateKey = state.key;
          const vnode = this.$slots.default && this.$slots.default[0];
    
          if (!vnode) return;
          if (stateKey === undefined) return;
          if (routerHistory.indexOf(stateKey) <= -1) return;
    
          // history back
          const keepAliveInstance = this.keepAliveVnode.componentInstance;
          const componentOptions = vnode.componentOptions;
          const key =
            vnode.key == null
              ? componentOptions.Ctor.cid +
                (componentOptions.tag ? `::${componentOptions.tag}` : "")
              : vnode.key;
          pruneCacheEntry(keepAliveInstance.cache, key, keepAliveInstance.keys);
        },
      },
      created() {
        window.addEventListener("popstate", this.handlePopstate);
        window.vm = this;
      },
      mounted() {
        this.keepAliveVnode = this._vnode;
        setup(this);
      },
      beforeDestroy() {
        window.removeEventListener("popstate", this.handlePopstate);
      },
    };
    </script>
    
    <style lang="scss" scoped>
    </style>
    
  • 使用方法

    <template>
      <div>
        <KeepPreviousAlive>
          <router-view v-if="$route.matched.some((r) => r.meta.keepAlive)"></router-view>
        </KeepPreviousAlive>
        <router-view v-if="!$route.matched.some((r) => r.meta.keepAlive)"></router-view>
      </div>
    </template>
    
  • 优点和缺陷

    • 配置简单:只要使用KeepPreviousAlive 组件就可以,不用在缓存页面的 beforeRouteEnter 守卫方法中判断是否需要重新创建页面。
    • 缺点:存在循环跳转时,获取到页面数据都是缓存中的,不会重新刷新页面。例如:
      1. 用户在 A 页面,调用 router.push('/b') 跳转到 B 页面
      2. 用户已经跳到 B 页面,然后调用 router.push('/a') 跳转到 A 页面
      3. 这时候 A 页面的数据还是从缓存中取到,并不会进入创建页面的流程。

<h3 id="3">解决循环跳转页面不刷新</h3>

在介绍解决方法之前,让我们一起忘掉上一部分关于 KeepPreviousAlive 组件的实现,来看下面一段代码。

// keep-alive 部分源码
const key = vnode.key == null
    ? componentOptions.Ctor.cid + (componentOptions.tag ? `::${componentOptions.tag}` : "")
    : vnode.key;

pruneCacheEntry(keepAliveInstance.cache, key, keepAliveInstance.keys);

从上面的代码中可以知道 keep-alive 缓存的 key 值可以从 vnode.key 中获取,而 vnode.key 是通过 v-bind:key="xxx" 传入的,因此我们可以自己控制组件缓存的 key 值,那么当我们需要让某个已经缓存的组件重新进入创建页面的时候,可以改变这个组件的 key 值,让它命中不了缓存。

代码示例:

<template>
  <div>
    <!-- 给缓存设置最大个数,避免占用太多内存 -->
    <keep-alive :max="20">
      <!-- 传入缓存 key 值 -->
      <router-view :key="$route.fullPath" v-if="$route.matched.some((r) => r.meta.keepAlive)" />  
    </keep-alive>
    <router-view v-if="!$route.matched.some((r) => r.meta.keepAlive)" />
  </div>
</template>
// 其他页面
// 进入a页面时,a页面需要重新创建
this.$router.push({
  path: '/a',
  query: {
    q: 'random querystring'
  }
})
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容