概念
- keep-alive 是 vue 内置的组件,用 keep-alive 包裹组件时,会缓存不活动的组件实例,而不是销毁他们。主要用于保存组件状态或避免重复创建(内存换性能)
特点
- 它是一个抽象组件,自身不会渲染一个 dom 元素,也不会出现在组件的父组件链中
- 当组件在 keep-alive 内被切换,组件的
activated
和 deactivated
这两个生命周期钩子函数会被执行。组件一旦被缓存,再次渲染就不会执行 created
、mounted
生命周期钩子函数
- 当引入 keep-alive 的时候,页面第一次进入,钩子的触发顺序
created
> mounted
> activated
,退出时触发 deactivated
。当再次进入(前进或者后退)时,只触发 activated
- 要求同时只有一个子组件被渲染
- 不会在函数式组件中正常工作,因为它们没有缓存实例
应用
- 点击列表页进入详情页后返回列表页,需要保留列表页的筛选或者滚动等操作不被重置
用法
// whiteList 参数可以是数组形式,也可以是字符串形式, ['a', 'b', 'c'] 或者 a,b,c(不能有空格)
// blackList 参数可以是数组形式,也可以是字符串形式, ['a', 'b', 'c'] 或者 a,b,c(不能有空格)
// whiteList 参数可以是数组形式,也可以是字符串形式, ['a', 'b', 'c'] 或者 a,b,c(不能有空格)
// blackList 参数可以是数组形式,也可以是字符串形式, ['a', 'b', 'c'] 或者 a,b,c(不能有空格)
// 1. 在路由中的meta标签中记录 keepAlive 的属性为 true
{
path: '/shipTradingSale',
name: 'shipTradingSale',
component: () => import('@/views/shipTrading/sale'),
meta: {
title: '船舶出售',
keepAlive: true, // 开启缓存
}
}
// 2. 在创建router实例的时候加上scrollBehavior方法
export default new Router({
mode: 'history',
base: process.env.BASE_URL,
routes,
scrollBehavior (to, from, savedPosition) {
if (savedPosition) {
return savedPosition
} else {
return {
x: 0,
y: 0
}
}
}
})
// 3. 在需要缓存的 router-view 组件上包裹 keep-alive 组件
// 4. 动态控制 keep-alive
beforeRouteLeave (to, from, next) {
this.loading = true
if (to.path === '/goodsDetails') {
from.meta.keepAlive = true
} else {
from.meta.keepAlive = false
}
next()
}
props
-
include
定义缓存白名单,只有名称匹配的组件会被缓存
-
exclude
定义缓存黑名单,任何匹配的组件都不会被缓存
-
max
定义缓存组件上限,超出上限使用 LRU的策略置换
缓存数据
渲染
- Vue的渲染是从 render 阶段开始的,但keep-alive的渲染是在patch阶段,这是构建组件树(虚拟DOM树),并将VNode转换成真正DOM节点的过程
原理
- 在
created
函数调用时将需要缓存的 VNode
节点保存在 this.cache
中,在 render
(页面渲染) 时,如果 VNode
的 name
符合缓存条件(可以用 include 以及 exclude 控制),则会从 this.cache
中取出之前缓存的 VNode 实例进行渲染
源码剖析
- 与定义组件的过程一样,先是设置组件名为 keep-alive,其次定义了一个
abstract
属性,值为true
- props 属性定义了 keep-alive 组件支持的全部参数
- keep-alive 在它生命周期内定义了三个钩子函数
created
初始化两个对象分别缓存 VNode(虚拟DOM)和 VNode 对应的键集合
destroyed
通过遍历调用 pruneCacheEntry
函数删除 this.cache
中缓存的VNode实例
mounted
对 include
和 exclude
参数进行监听,然后实时地更新(删除)this.cache
对象数据。pruneCache
函数的核心也是去调用 pruneCacheEntry
// src/core/components/keep-alive.js
export default {
name: 'keep-alive',
abstract: true, // 判断当前组件虚拟dom是否渲染成真是dom的关键
props: {
include: patternTypes, // 缓存白名单
exclude: patternTypes, // 缓存黑名单
max: [String, Number] // 缓存的组件实例数量上限
},
created () {
this.cache = Object.create(null) // 缓存虚拟dom
this.keys = [] // 缓存的虚拟dom的健集合
},
destroyed () {
for (const key in this.cache) { // 删除所有的缓存
pruneCacheEntry(this.cache, key, this.keys)
}
},
mounted () {
// 实时监听黑白名单的变动
this.$watch('include', val => {
pruneCache(this, name => matches(val, name))
})
this.$watch('exclude', val => {
pruneCache(this, name => !matches(val, name))
})
},
render () {
// 单独拿出来
}
}
- render
1、获取 keep-alive 包裹着的第一个子组件对象及其组件名
2、根据设定的黑白名单(如果有)进行条件匹配,决定是否缓存。不匹配,直接返回组件实例(VNode),否则执行第 3 步
3、根据组件 ID 和 tag 生成缓存 Key,并在缓存对象中查找是否已缓存过该组件实例。如果存在,直接取出缓存值并更新该 key 在 this.keys 中的位置(更新 key 的位置是实现 LRU置换策略 的关键),否则执行第 4 步
4、在 this.cache 对象中存储该组件实例并保存key值,之后检查缓存的实例数量是否超过max的设置值,超过则根据LRU置换策略删除最近最久未使用的实例(即是下标为0的那个key)
5、最后并且很重要,将该组件实例的 keepAlive 属性值设置为 true。
// src/core/components/keep-alive.js
render () {
const slot = this.$slots.default
const vnode: VNode = getFirstComponentChild(slot) // 找到第一个子组件对象
const componentOptions: ?VNodeComponentOptions = vnode && vnode.componentOptions
if (componentOptions) { // 存在组件参数
// check pattern
const name: ?string = getComponentName(componentOptions) // 组件名
const { include, exclude } = this
if ( // 条件匹配
// not included
(include && (!name || !matches(include, name))) ||
// excluded
(exclude && name && matches(exclude, name))
) {
return vnode
}
const { cache, keys } = this
const key: ?string = vnode.key == null // 定义组件的缓存key
// same constructor may get registered as different local components
// so cid alone is not enough (#3269)
? componentOptions.Ctor.cid + (componentOptions.tag ? `::${componentOptions.tag}` : '')
: vnode.key
if (cache[key]) { // 已经缓存过该组件
vnode.componentInstance = cache[key].componentInstance
// make current key freshest
remove(keys, key)
keys.push(key) // 调整key排序
} else {
cache[key] = vnode // 缓存组件对象
keys.push(key)
// prune oldest entry
if (this.max && keys.length > parseInt(this.max)) { // 超过缓存数限制,将第一个删除
pruneCacheEntry(cache, keys[0], keys, this._vnode)
}
}
vnode.data.keepAlive = true // 渲染和执行被包裹组件的钩子函数需要用到
}
return vnode || (slot && slot[0])
}