vue-router 中使用 keep-alive 控制 ajax 请求的缓存策略(一)

1. 背景

vue 中有一个 keep-alive 的功能,可以将组件渲染结果缓存起来,结合 vue-router 中使用,可以缓存某个 view 的整个内容(比如列表页)。

通常会有这样的需求:

用户单击列表页(List)中某个标题,进入到详情页(Detail)。
此后会有两种情况返回到 List:

  1. 用户点击导航栏中的 /list 链接;
  2. 用户点击浏览器返回按钮 ←

情况 1 发生时,我们希望用户进入 List 后,页面的数据需要刷新。用户在导航切换时(点击导航菜单中的链接),其意愿是需要页面刷新,由于我们的应用是 SPA 应用,所以需要主动重新发送 ajax 请求获取数据,以让用户知晓,页面的数据有变化,否则他还要手动去点击浏览器的刷新按钮。

情况 2 发生时,我们希望用户进入 List 后,按照 h5 的行为自动将滚动条还原到原来位置,并且此时不应刷新页面数据,直接使用缓存。

2. 实践

需要缓存数据,那么在 app.vue 中的 router-view 配合使用 keep-alive :

2.1 使 router-view 结合 keep-alive

入口文件(app.vue):

//- app.vue
<template lang="pug">                                                             
#app                                                                              
    .page-header

    .page-main                                                             
        keep-alive
            router-view(v-if="$route.meta.keep_alive")
        router-view(v-if="!$route.meta.keep_alive")

    .page-footer
</template>

注: v-if 是加在 router-view 上,而不是加在 keep-alive 上。

2.2 配置路由

路由配置(router.coffee):

# router.coffee
router = new VueRouter(
    mode: 'history'  # 需要使用 h5 模式,才能使用 scrollBehavior

    routes: [
        {
                path: '/list'
                name: 'list'
                meta:
                    title: '列表页'
                    keep_alive: true  # true 表示需要使用缓存
                component: require('../views/list.vue')
         },
        ...
    ]

    scrollBehavior: (to, from, saved_position) ->
        # 保存到 meta 中,备用
        to.meta.saved_position = saved_position
        return saved_position ? {x: 0, y: 0}
) 

注:

某一个 route 的 meta.keep_alive 值,设定之后就不能再修改其值,即不能动态变更 meta.keep_alive 的方式来动态控制是否使用缓存。

原因:某个 route.meta.keep_alive 初始设定为 true,会有以下两种情况:

若在 scrollBehavior 中判断出是情况 1,此时如果使用 to.meta.keep_alive = false 来禁用缓存,那么 app.vue 中的两个 router-view 会切换,之前缓存在 <keep-alive/> 中的第一个 router-view 的数据,会被 v-if 清空,导致缓存失效;

同理,当判断出是情况 2,如果 to.meta.keep_alive = true 来开启缓存,此时又会发生一次切换,导致重新生成组件。故 route.meta.keep_alive 一旦设定,就表示此组件一定是需要缓存的,后期不能改变其值。

3. keep-alive 下控制数据刷新

既然不能改变 meta.keep_alive 的值,那么如果做到在 keep-alive 包裹内的组件进行数据刷新呢?

答案是:使用 vue-router 中的 beforeRouteEnter 钩子。

这里不能使用 vue 文档中的 mounted、updated 等生命周期中的钩子函数,因为在使用 keep-alive 后,这些钩子,统统不会被调用。

而在 vue-router 中提供了 beforeRouteEnter 钩子(您可以 查看 beforeRouteEnter 官方文档 )。
此钩子与 keep-alive 无关,不会像 mounted 等内置钩子那样被 keep-alive “吃掉”。

# list.coffee
export default List =
    name: 'List'
                                                                                  
    data: ->
        lists: []
               
    beforeRouteEnter: (to, from, next) ->
        next (vm) ->
            # 如果 saved_position === null,那么说明是点击了导航链接(情况1),
            # 此时需要刷新数据,获取新的列表内容。
            # 否则什么也不做,直接使用 keep-alive 中的缓存。
            if to.meta.saved_position is null
                vm.fetchLists()

    methods:
        fetchLists: ->
            @$store
                .dispatch(types.dashboard.actions.GET_LISTS)
                .then (res) =>
                    if res.status == 'success'
                        @posts = res.data
                    else
                        @posts_loading_error_message = res.data.msg

注: 注意 beforeRouteEnter 中使用的是 is null,而不是 if to.meta.saved_position?

一点说明:

is null 相当于 === null;
to.meta.saved_position? 相当于 to.meta.saved_position == null

undefined == null 为 true,但 undefined === null 为 false。

这一点很重要,因为在调试过程中,如果你在 beforeRouteEnter 的 next 方法中:
console.log to.meta.saved_position

当点击的是导航链接(情况 1),此时输出 null,因为 scrollBehavior 中的 saved_position 为 null,你可以 查看 vue-router 的源码 来确定值为什么是 null。

这里显示相关代码:

// src/util/scroll.js#L40
// wait until re-render finishes before scrolling
router.app.$nextTick(() => {
    let position = getScrollPosition()
    const shouldScroll = behavior(to, from, isPop ? position : null)

可以看出 isPop ? position : null 当点击导航链接(情况 1, isPop == false)时,传递的是 null。

其中 isPop 可以理解为是否是点击了浏览器后退按钮。点击了就传递 position,否则传递 null。

那么什么时候会出现 undefined 的情况呢?

上面代码中的 position = getScrollPosition(),其 源码 如下:

function getScrollPosition (): ?Object {
    const key = getStateKey()
    if (key) {
        return positionStore[key]
    }
}

其中 positionStore 的值由 函数 saveScrollPosition 保存。
如果找到了 key 就返回,此时为形如 {x: 33, y: 12} 的值,表示之前横纵滚动条的位置。
如果没有找到 key,此函数没有返回任何内容,那么自然是返回 undefined 了。

以上。

此方法是有问题的,在 另外一篇文章 中解决。

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

推荐阅读更多精彩内容