欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

vue.js内置组件之keep-alive组件使用

程序员文章站 2023-11-23 17:27:58
keep-alive是vue.js的一个内置组件。 包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们。它自身不会渲染一个 dom...

keep-alive是vue.js的一个内置组件。<keep-alive> 包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们。它自身不会渲染一个 dom 元素,也不会出现在父组件链中。 当组件在 <keep-alive> 内被切换,它的 activated 和 deactivated 这两个生命周期钩子函数将会被对应执行。 它提供了include与exclude两个属性,允许组件有条件地进行缓存。

举个栗子

<keep-alive>
  <router-view v-if="$route.meta.keepalive"></router-view>
 </keep-alive>
 <router-view v-if="!$route.meta.keepalive"></router-view>

vue.js内置组件之keep-alive组件使用

在点击button时候,两个input会发生切换,但是这时候这两个输入框的状态会被缓存起来,input标签中的内容不会因为组件的切换而消失。

* include - 字符串或正则表达式。只有匹配的组件会被缓存。
* exclude - 字符串或正则表达式。任何匹配的组件都不会被缓存。

<keep-alive include="a">
 <component></component>
</keep-alive>

只缓存组件别民name为a的组件

<keep-alive exclude="a">
 <component></component>
</keep-alive>

除了name为a的组件,其他都缓存下来

生命周期钩子

生命钩子 keep-alive提供了两个生命钩子,分别是activated与deactivated。

因为keep-alive会将组件保存在内存中,并不会销毁以及重新创建,所以不会重新调用组件的created等方法,需要用activated与deactivated这两个生命钩子来得知当前组件是否处于活动状态。

深入keep-alive组件实现

vue.js内置组件之keep-alive组件使用 

查看vue--keep-alive组件源代码可以得到以下信息

created钩子会创建一个cache对象,用来作为缓存容器,保存vnode节点。

props: {
 include: patterntypes,
 exclude: patterntypes,
 max: [string, number]
},
created () {
 // 创建缓存对象
 this.cache = object.create(null)
 // 创建一个key别名数组(组件name)
 this.keys = []
},

destroyed钩子则在组件被销毁的时候清除cache缓存中的所有组件实例。

destroyed () {
 /* 遍历销毁所有缓存的组件实例*/
 for (const key in this.cache) {
  prunecacheentry(this.cache, key, this.keys)
 }
},

:::demo

render () {
 /* 获取插槽 */
 const slot = this.$slots.default
 /* 根据插槽获取第一个组件组件 */
 const vnode: vnode = getfirstcomponentchild(slot)
 const componentoptions: ?vnodecomponentoptions = vnode && vnode.componentoptions
 if (componentoptions) {
 // 获取组件的名称(是否设置了组件名称name,没有则返回组件标签名称)
 const name: ?string = getcomponentname(componentoptions)
 // 解构对象赋值常量
 const { include, exclude } = this
 if ( /* name不在inlcude中或者在exlude中则直接返回vnode */
  // 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
  // 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)
 } else {
  cache[key] = vnode
  keys.push(key)
  // 判断是否设置了最大缓存实例数量,超过则删除最老的数据,
  if (this.max && keys.length > parseint(this.max)) {
  prunecacheentry(cache, keys[0], keys, this._vnode)
  }
 }
 // 给vnode打上缓存标记
 vnode.data.keepalive = true
 }
 return vnode || (slot && slot[0])
}
// 销毁实例
function prunecacheentry (
 cache: vnodecache,
 key: string,
 keys: array<string>,
 current?: vnode
) {
 const cached = cache[key]
 if (cached && (!current || cached.tag !== current.tag)) {
 cached.componentinstance.$destroy()
 }
 cache[key] = null
 remove(keys, key)
}
// 缓存
function prunecache (keepaliveinstance: any, filter: function) {
 const { cache, keys, _vnode } = keepaliveinstance
 for (const key in cache) {
 const cachednode: ?vnode = cache[key]
 if (cachednode) {
  const name: ?string = getcomponentname(cachednode.componentoptions)
  // 组件name 不符合filler条件, 销毁实例,移除cahe
  if (name && !filter(name)) {
  prunecacheentry(cache, key, keys, _vnode)
  }
 }
 }
}
// 筛选过滤函数
function matches (pattern: string | regexp | array<string>, name: string): boolean {
 if (array.isarray(pattern)) {
 return pattern.indexof(name) > -1
 } else if (typeof pattern === 'string') {
 return pattern.split(',').indexof(name) > -1
 } else if (isregexp(pattern)) {
 return pattern.test(name)
 }
 /* istanbul ignore next */
 return false
}
// 检测 include 和 exclude 数据的变化,实时写入读取缓存或者删除
mounted () {
 this.$watch('include', val => {
 prunecache(this, name => matches(val, name))
 })
 this.$watch('exclude', val => {
 prunecache(this, name => !matches(val, name))
 })
},

:::

通过查看vue源码可以看出,keep-alive默认传递3个属性,include 、exclude、max, max 最大可缓存的长度

结合源码我们可以实现一个可配置缓存的router-view

<!--exclude - 字符串或正则表达式。任何匹配的组件都不会被缓存。-->
<!--todo 匹配首先检查组件自身的 name 选项,如果 name 选项不可用,则匹配它的局部注册名称-->
<keep-alive :exclude="keepaliveconf.value">
 <router-view class="child-view" :key="$route.fullpath"></router-view>
</keep-alive>
<!-- 或者 -->
<keep-alive :include="keepaliveconf.value">
 <router-view class="child-view" :key="$route.fullpath"></router-view>
</keep-alive>
<!-- 具体使用 include 还是exclude 根据项目是否需要缓存的页面数量多少来决定-->

创建一个keepaliveconf.js 放置需要匹配的组件名

// 路由组件命名集合
 var arr = ['component1', 'component2'];
 export default {value: routelist.join()};

配置重置缓存的全局方法

import keepaliveconf from 'keepaliveconf.js'
vue.mixin({
 methods: {
 // 传入需要重置的组件名字
 resetkeepaive(name) {
  const conf = keepaliveconf.value;
  let arr = keepaliveconf.value.split(',');
  if (name && typeof name === 'string') {
   let i = arr.indexof(name);
   if (i > -1) {
    arr.splice(i, 1);
    keepaliveconf.value = arr.join();
    settimeout(() => {
     keepaliveconf.value = conf
    }, 500);
   }
  }
 },
 }
})

在合适的时机调用调用this.resetkeepaive(name),触发keep-alive销毁组件实例;

vue.js内置组件之keep-alive组件使用

vue.js内部将dom节点抽象成了一个个的vnode节点,keep-alive组件的缓存也是基于vnode节点的而不是直接存储dom结构。它将满足条件的组件在cache对象中缓存起来,在需要重新渲染的时候再将vnode节点从cache对象中取出并渲染。

总结

以上所述是小编给大家介绍的vue.js内置组件之keep-alive组件使用,希望对大家有所帮助