1. 简介
keep-alive 是 Vue 的内置组件,当它包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们。
和 transition 相似,keep-alive 是一个抽象组件:它自身不会渲染成一个 DOM 元素,也不会出现在父组件链中。
作用: 在组件切换过程中将状态保留在内存中,防止重复渲染DOM,减少加载时间及性能消耗,提高用户体验性。
原理: 在 created 函数调用时将需要缓存的 VNode 节点保存在 this.cache 中/在 render(页面渲染) 时,如果 VNode 的 name 符合缓存条件(可以用 include 以及 exclude 控制),则会从 this.cache 中取出之前缓存的 VNode 实例进行渲染。
(VNode:虚拟DOM,其实就是一个JS对象)
2. 使用
2.1 参数
参数名 | 值 | 描述 |
include | 字符串或正则表达式 | 只有名称匹配的组件会被缓存。 |
exclude | 字符串或正则表达式 | 任何名称匹配的组件都不会被缓存。 |
max | 数字 | 最多可以缓存多少组件实例。 |
注意: include/exclude 值是组件中的 name 命名,而不是路由中的组件 name 命名;
// router.js { path: '/home', name: 'home', component: () => import('../views/home.vue') }, { path: '/test', name: 'test', component: () => import('../views/test.vue') },
// App.vue <keep-alive include="test"> <router-view/> </keep-alive> ---------------------------------------------------------------------------------------------------------------- 补充: include/exclude 值的多种形式。 // 1. 将缓存 name 为 test 的组件(基本) <keep-alive include='test'> <router-view/> </keep-alive> // 2. 将缓存 name 为 a 或者 b 的组件,结合动态组件使用 <keep-alive include='a,b'> <router-view/> </keep-alive> // 3. 使用正则表达式,需使用 v-bind <keep-alive :include='/a|b/'> <router-view/> </keep-alive> // 4.动态判断 <keep-alive :include='includedComponents'> <router-view/> </keep-alive> // 5. 将不缓存 name 为 test 的组件 <keep-alive exclude='test'> <router-view/> </keep-alive> // 6. 和 `<transition>` 一起使用 <transition> <keep-alive> <router-view/> </keep-alive> </transition> // 7. 数组 (使用 `v-bind`) <keep-alive :include="['a', 'b']"> <component :is="view"></component> </keep-alive>
// test.vue <template> <div class="wrap"> <input type="text" v-model="inputVal"> </div> </template> <script> export default { name:'test', data(){ return { inputVal:'', } } } </script>
此时切换路由,我们就会发现 test 文件内的 inputVal 会被缓存了,而 home 内的值没有被缓存。
此外,我们还可以通过路由中的 meta 属性来控制,是否需要缓存。
将 test 路由中的 meta 添加 keepAlive 属性为 true,表示当前路由组件要进行缓存。
// router.js { path: '/home', name: 'home', component: () => import('../views/home.vue') }, { path: '/test', name: 'test', meta:{ keepAlive:true }, component: () => import('../views/test.vue') },
keep-alive 代码可以结合 v-if 进行包裹,如果 meta 中的 keepAlive 为 true 进行缓存,否侧不进行缓存。
<keep-alive> <router-view v-if="$route.meta.keepAlive" /> </keep-alive> <router-view v-if="!$route.meta.keepAlive" />
实际开发中,我们可以结合路由守卫来实现需要缓存组件的缓存。
export default { beforeRouteLeave(to, from, next) { to.meta.keepAlive = true; next(); } } </script>
2.2 生命周期函数
名称 | 描述 |
activated | 在 keep-alive 组件激活时调用, 该钩子函数在服务器端渲染期间不被调用。 |
deactivated | 在 keep-alive 组件停用时调用,该钩子在服务器端渲染期间不被调用。 |
使用< keep-alive > 会将数据保留在内存中,如果要在每次进入页面的时候获取最新的数据,需要在 activated 阶段获取数据,承担原来created钩子中获取数据的任务。
被包含在 < keep-alive > 中创建的组件,会多出两个生命周期的钩子: activated 与 deactivated
activated:在组件被激活时调用,在组件第一次渲染时也会被调用,之后每次keep-alive激活时被调用。
deactivated:在组件被停用时调用。
注意: 只有组件被 keep-alive 包裹时,这两个生命周期才会被调用,如果作为正常组件使用,是不会被调用,以及在 2.1.0 版本之后,使用 exclude 排除之后,就算被包裹在 keep-alive 中,这两个钩子依然不会被调用!另外在服务端渲染时此钩子也不会被调用的。
什么时候获取数据?
当引入keep-alive 的时候,页面第一次进入,钩子的触发顺序 created -> mounted -> activated,退出时触发 deactivated。
当再次进入(前进或者后退)时,只触发 activated。
我们知道 keep-alive 之后页面模板第一次初始化解析变成 HTML 片段后,再次进入就不在重新解析而是读取内存中的数据。
只有当数据变化时,才使用 VirtualDOM 进行 diff 更新。所以,页面进入的数据获取应该在 activated 中也放一份。
数据下载完毕手动操作 DOM 的部分也应该在activated中执行才会生效。
所以,应该 activated 中留一份数据获取的代码,或者不要 created 部分,直接将 created 中的代码转移到 activated 中。
2.3 应用场景
如果未使用 keep-alive 组件,则在页面回退时仍然会重新渲染页面,触发 created 钩子,使用体验不好。
在以下场景中使用 keep-alive 组件会显著提高用户体验,菜单存在多级关系(如:主页 -> 列表页 -> 详情页)的场景:
- 当从主页跳转列表页时,列表页组件重新渲染;
- 当从详情页返回列表页时,列表页组件缓存 不重新请求数据;
// app.vue <template> <div id="app"> <keep-alive :include="keepAliveInclude"> <router-view/> </keep-alive> </div> </template> <script> import { mapGetters } from 'vuex' export default { name:'home', computed:{ ...mapGetters([ 'keepAliveInclude', ]) }, } </script>
store 中对 keepAliveInclude 的状态更新保存
// store.js import Vue from 'vue' import Vuex from 'vuex' Vue.use(Vuex) export default new Vuex.Store({ state: { // keepAlive缓存组件 keepAliveInclude:[], }, getters:{ keepAliveInclude: state => state.keepAliveInclude, }, mutations: { SET_KEEPALIVEINCLUDE:(state, keepAliveInclude) => { state.keepAliveInclude = keepAliveInclude; } }, actions: { setKeepAliveInclude({ commit }, keepAliveInclude){ commit("SET_KEEPALIVEINCLUDE", keepAliveInclude) }, }, })
需要进行缓存的页面 list.vue
<template> <div> <button @click="goHome">主页</button> <button @click="goDetail">详情</button> 列表: <input type="text" v-model="inputVal"> </div> </template> <script> export default { name:'list', data(){ return { inputVal:'', } }, methods:{ goDetail(){ this.$router.push('./detail') }, goHome(){ this.$router.push('./home') } }, beforeRouteLeave (to, from, next) { if(to.name == 'detail'){ this.$store.dispatch('setKeepAliveInclude',['list']) }else{ this.$store.dispatch('setKeepAliveInclude',[]) } // next(); setTimeout(() => { next(); }, 10); // next()需用定时器包裹,否则多次切换无法缓存 } } </script>