这篇文章主要介绍了vue-router 之 keep-alive的使用。

keep-alive 简介

keep-alive 是 Vue 内置的一个组件，可以使被包含的组件保留状态，或避免重新渲染。
用法也很简单：

1
2
3
4
5
<keep-alive>
  <component>
    <!-- 该组件将被缓存！ -->
  </component>
</keep-alive>

props

  • include - 字符串或正则表达，只有匹配的组件会被缓存
  • exclude - 字符串或正则表达式，任何匹配的组件都不会被缓存
1
2
3
4
5
6
7
// 组件 a
export default {
  name: 'a',
  data () {
    return {}
  }
}
1
2
3
4
5
<keep-alive include="a">
  <component>
    <!-- name 为 a 的组件将被缓存！ -->
  </component>
</keep-alive>可以保留它的状态或避免重新渲染
1
2
3
4
5
<keep-alive exclude="a">
  <component>
    <!-- 除了 name 为 a 的组件都将被缓存！ -->
  </component>
</keep-alive>可以保留它的状态或避免重新渲染

遇见 vue-router

西湖雨好大，借把伞躲躲雨…
router-view 也是一个组件，如果直接被包在 keep-alive 里面，所有路径匹配到的视图组件都会被缓存：

1
2
3
4
5
<keep-alive>
    <router-view>
        <!-- 所有路径匹配到的视图组件都会被缓存！ -->
    </router-view>
</keep-alive>

然而产品汪总是要改需求，拦都拦不住…

问题

如果只想 router-view 里面某个组件被缓存，怎么办？

  • 使用 include/exclude
  • 增加 router.meta 属性

使用 include/exclude

1
2
3
4
5
6
7
// 组件 a
export default {
  name: 'a',
  data () {
    return {}
  }
}
1
2
3
4
5
<keep-alive include="a">
    <router-view>
        <!-- 只有路径匹配到的视图 a 组件会被缓存！ -->
    </router-view>
</keep-alive>

exclude 例子类似。

缺点：需要知道组件的 name，项目复杂的时候不是很好的选择

增加 router.meta 属性

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// routes 配置
export default [
  {
    path: '/',
    name: 'home', // 注意这个name属性必须和Home组件中的name属性完全一致，keepAlive: true才会生效
    component: Home,
    meta: {
      keepAlive: true // 需要被缓存
    }
  }, {
    path: '/:id',
    name: 'edit',
    component: Edit,
    meta: {
      keepAlive: false // 不需要被缓存
    }
  }
]
1
2
3
4
5
6
7
8
9
<keep-alive>
    <router-view v-if="$route.meta.keepAlive">
        <!-- 这里是会被缓存的视图组件，比如 Home！ -->
    </router-view>
</keep-alive>

<router-view v-if="!$route.meta.keepAlive">
    <!-- 这里是不被缓存的视图组件，比如 Edit！ -->
</router-view>

优点：不需要例举出需要被缓存组件名称

【加盐】使用 router.meta 拓展

假设这里有 3 个路由： A、B、C。

  • 需求：
    • 默认显示 A
    • B 跳到 A，A 不刷新
    • C 跳到 A，A 刷新
  • 实现方式
    • 在 A 路由里面设置 meta 属性：
1
2
3
4
5
6
7
8
{
        path: '/',
        name: 'A',
        component: A,
        meta: {
            keepAlive: true // 需要被缓存
        }
}
  • 在 B 组件里面设置 beforeRouteLeave：
1
2
3
4
5
6
7
8
9
10
11
export default {
        data() {
            return {};
        },
        methods: {},
        beforeRouteLeave(to, from, next) {
             // 设置下一个路由的 meta
            to.meta.keepAlive = true;  // 让 A 缓存，即不刷新
            next();
        }
};
  • 在 C 组件里面设置 beforeRouteLeave：
1
2
3
4
5
6
7
8
9
10
11
export default {
        data() {
            return {};
        },
        methods: {},
        beforeRouteLeave(to, from, next) {
            // 设置下一个路由的 meta
            to.meta.keepAlive = false; // 让 A 不缓存，即刷新
            next();
        }
};

这样便能实现 B 回到 A，A 不刷新；而 C 回到 A 则刷新。

实现前进刷新，后退不刷新

参考：

1
2
3
[vue实现前进刷新，后退不刷新](https://juejin.im/post/5a69894a518825733b0f12f2)
[vue-router 之 keep-alive](https://www.jianshu.com/p/0b0222954483)
[Vue keep-alive实践总结](https://www.cnblogs.com/sysuhanyf/p/7454530.html)