likes
comments
collection
share

vue2源码解析之keep-alive

作者站长头像
站长
· 阅读数 41

基本使用

Props：

  • include - 字符串或正则表达式。只有名称匹配的组件会被缓存。
  • exclude - 字符串或正则表达式。任何名称匹配的组件都不会被缓存。
  • max - 数字。最多可以缓存多少组件实例。

用法： <keep-alive> 包裹动态组件时，会缓存不活动的组件实例，而不是销毁它们。 和 <transition> 相似，<keep-alive> 是一个抽象组件：它自身不会渲染 一个 DOM 元素，也不会出现在组件的父组件链中。 当组件在 <keep-alive> 内被切换，它的 activated 和 deactivated  这两个生命周期钩子函数将会被对应执行。

注意，<keep-alive> 是用在其一个直属的子组件被开关的情形。如果你在其 中有 v-for 则不会工作。如果有上述的多个条件性的子元素，<keep-alive>  要求同时只有一个子元素被渲染。

include 和 exclude prop 允许组件有条件地缓存。二者都可以用逗号分 隔字符串、正则表达式或一个数组来表示：

匹配首先检查组件自身的 name 选项，如果 name 选项不可用，则匹配它 的局部注册名称 (父组件 components 选项的键值)。匿名组件不能被匹配。

max:最多可以缓存多少组件实例。一旦这个数字达到了，在新实例被创建之前， 已缓存组件中最久没有被访问的实例会被销毁掉

注意：<keep-alive> 不会在函数式组件中正常工作，因为它们没有缓存实例。

<!-- 基本 -->  
<keep-alive>  
    <component :is="view"></component>  
</keep-alive>  
  
<!-- 多个条件判断的子组件 -->  
<keep-alive>  
    <comp-a v-if="a > 1"></comp-a>  
    <comp-b v-else></comp-b>  
</keep-alive>  
  
<!-- 和 `<transition>` 一起使用 -->  
<transition>  
    <keep-alive>  
    <component :is="view"></component>  
    </keep-alive>  
</transition>

<!-- 逗号分隔字符串 -->  
<keep-alive include="a,b">  
    <component :is="view"></component>  
</keep-alive>  
  
<!-- 正则表达式 (使用 `v-bind`) -->  
<keep-alive :include="/a|b/">  
    <component :is="view"></component>  
</keep-alive>  
  
<!-- 数组 (使用 `v-bind`) -->  
<keep-alive :include="['a', 'b']">  
    <component :is="view"></component>  
</keep-alive>

<keep-alive>是Vue中内置的一个抽象组件，它自身不会渲染一个 DOM 元素，也不会出现在父组件链中。当它包裹动态组件时，会缓存不活动的组件实例，而不是销毁它们。

keep-alive是Vue的一个内置组件，也就是说在vue内部自己封装了一个组件；它会把需要缓存的组件保存起来，下次使用的时候直接从缓存中获取，而不是销毁和重新创建，因此可以保留组件的状态，从而可以提高性能；

源码预览

// 源码位置 src/core/components/keep-alive.js

function getComponentName (opts: ?VNodeComponentOptions): ?string {
  return opts && (opts.Ctor.options.name || opts.tag)
}

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
}

function pruneCache (keepAliveInstance: any, filter: Function) {
  const { cache, keys, _vnode } = keepAliveInstance
  for (const key in cache) {
    const entry: ?CacheEntry = cache[key]
    if (entry) {
      const name: ?string = entry.name
      if (name && !filter(name)) {
        pruneCacheEntry(cache, key, keys, _vnode)
      }
    }
  }
}

function pruneCacheEntry (
  cache: CacheEntryMap,
  key: string,
  keys: Array<string>,
  current?: VNode
) {
  const entry: ?CacheEntry = cache[key]
  if (entry && (!current || entry.tag !== current.tag)) {
    entry.componentInstance.$destroy()
  }
  cache[key] = null
  remove(keys, key)
}

const patternTypes: Array<Function> = [String, RegExp, Array]

export default {
  name: 'keep-alive',
  abstract: true,

  props: {
    include: patternTypes,
    exclude: patternTypes,
    max: [String, Number]
  },

  methods: {
    cacheVNode() {
      const { cache, keys, vnodeToCache, keyToCache } = this
      if (vnodeToCache) {
        const { tag, componentInstance, componentOptions } = vnodeToCache
        cache[keyToCache] = {
          name: getComponentName(componentOptions),
          tag,
          componentInstance,
        }
        keys.push(keyToCache)
        // prune oldest entry
        if (this.max && keys.length > parseInt(this.max)) {
          pruneCacheEntry(cache, keys[0], keys, this._vnode)
        }
        this.vnodeToCache = null
      }
    }
  },

  created () {
    this.cache = Object.create(null)
    this.keys = []
  },

  destroyed () {
    for (const key in this.cache) {
      pruneCacheEntry(this.cache, key, this.keys)
    }
  },

  mounted () {
    this.cacheVNode()
    this.$watch('include', val => {
      pruneCache(this, name => matches(val, name))
    })
    this.$watch('exclude', val => {
      pruneCache(this, name => !matches(val, name))
    })
  },

  updated () {
    this.cacheVNode()
  },

  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
        // 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 {
        // delay setting the cache until update
        this.vnodeToCache = vnode
        this.keyToCache = key
      }

      vnode.data.keepAlive = true
    }
    return vnode || (slot && slot[0])
  }
}

首先定义props属性和对应的类型,include匹配需要缓存的组件名，exclude匹配不需要缓存的组件名，max匹配最多缓存的组件数量，如果超过这个数量就删除调最久不使用的组件；

props: {
    include: patternTypes,
    exclude: patternTypes,
    max: [String, Number]
},

created生命周期钩子中，定义了cache用来保存缓存的组件，keys用来存储需要保存组件的key;

created () {
    // 创建一个空的对象用来缓存组件
    this.cache = Object.create(null)
    // 缓存的组件的key
    this.keys = []
},

此组件不是模板组件，而是一个函数组件，通过render函数返回html;render函数中首先获取了默认插槽(在keep-alive标签之间放的值会被作为默认插入的值)，获取插槽中的第一个节点(keep-alive只缓存它内部的第一个组件)，接着获取了节点上的options选项；

// 获取到默认插槽
const slot = this.$slots.default
// 获取到插槽中的第一个子节点
const vnode: VNode = getFirstComponentChild(slot)
// 获取到第一个子节点的options选项
const componentOptions: ?VNodeComponentOptions = vnode && vnode.componentOptions

接着判断options选项是否存在，存在就获取组件的名称，然后判断include存在并且name不存在或者name不在include中表示不需要缓存，或exclude存在并且name存在并且name存在exclude中表示不需要缓存，直接返回当前节点；

    // componentOptions存在
    if (componentOptions) {
      // 获取到组件的名称
      const name: ?string = getComponentName(componentOptions)
      const { include, exclude } = this
      if (
        // include存在，并且没有name或name不存在include中 或 有exclude并且有name并且
        // name存在于exclude中直接返回当前vnode
        (include && (!name || !matches(include, name))) ||
        // excluded
        (exclude && name && matches(exclude, name))
      ) {
        return vnode
      }

接着获取到节点的key,通过key判断是否在缓存中，如果在缓存中，就获取到缓存中此节点的实例进行重新赋值；并且删除掉keys中的此节点的key,再重新添加到keys的尾部(目的：区分不常用的组件，不常用的组件慢慢的会移动到keys数组的头部)

const { cache, keys } = this
  // 获取到节点的key
  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]) {
    // 获取缓存中的值的componentInstance给当前节点的componentInstance
    vnode.componentInstance = cache[key].componentInstance
    // 从keys数组中删除掉当前的key
    remove(keys, key)
    // 重新添加到尾部
    keys.push(key)
  }

如果不存在于缓存中，就保存当前节点和它的key;在mounted生命钩子中进行缓存；

else { // 如果缓存中不存在
    // delay setting the cache until update
    // 赋值给vnodeToCache和keyToCache
    this.vnodeToCache = vnode
    this.keyToCache = key
}

最后给当前节点添加标记并且返回此节点

// 添加keepAlive属性为true
  vnode.data.keepAlive = true
}
// 返回当前节点或插槽中的第一个节点
return vnode || (slot && slot[0])

render执行之后就执行mounted生命钩子，钩子中首先执行了cacheVNode方法，此方法主要用来缓存节点；方法中首先判断有没有要缓存的节点，如果有就添加到cache和keys中，接着判断是否有max,如果有并且当前的keys中缓存的值已经超过了设置的max的值，那么就把keys的第一项从缓存中进行删除(LRU(Least recently used，最近最少使用)的缓存策略：核心就是最近被访问的数据后面访问的几率比较高，因此把最近访问的数据不断的从历史记录中取出来重新添加到尾部，久而久之开头位置的数据就是不常访问的因此优先进行删除)；

mounted () {
    // 缓存节点
    this.cacheVNode()
    ... 
}，
methods: {
    // 缓存节点
    cacheVNode() {
      const { cache, keys, vnodeToCache, keyToCache } = this
      // 如果存在没有被缓存的节点
      if (vnodeToCache) {
        const { tag, componentInstance, componentOptions } = vnodeToCache
        // 进行缓存
        cache[keyToCache] = {
          name: getComponentName(componentOptions),
          tag,
          componentInstance,
        }
        // 把key添加到keys中
        keys.push(keyToCache)
        // prune oldest entry
        // 如果max存在，并且当前的keys的长度超过了max的值，那么就删除keys中的第一个节点
        if (this.max && keys.length > parseInt(this.max)) {
          pruneCacheEntry(cache, keys[0], keys, this._vnode)
        }
        // 设置为空
        this.vnodeToCache = null
      }
    }
},

mounted中还监听了include和exclude两个属性，当值变化的时候就根据变化的值判断当前节点的name是否存在于include中，不存在就从缓存中进行删除；如果存在于exclude中就从缓存中进行删除；

// 监控include 执行pruneCache判断include的新值中是否存在name不存在就进行删除节点
this.$watch('include', val => {
  pruneCache(this, name => matches(val, name))
})
// 监控exclude 执行pruneCache判断exclude的新值中是否存在name存在就进行删除节点
this.$watch('exclude', val => {
  pruneCache(this, name => !matches(val, name))
})

// 通过pattern的类型判断name是否在它的里面
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
}

function pruneCache (keepAliveInstance: any, filter: Function) {
  const { cache, keys, _vnode } = keepAliveInstance
  // 遍历缓存
  for (const key in cache) {
    const entry: ?CacheEntry = cache[key]
    // 缓存中有这个值
    if (entry) {
      // 获取到name
      const name: ?string = entry.name
      // name存在并且不存在include或exclude中就进行删除
      if (name && !filter(name)) {
        pruneCacheEntry(cache, key, keys, _vnode)
      }
    }
  }
}

destroyed函数，当keep-alive被销毁的之后，遍历cache删除cache中的所有缓存

destroyed () {
    // 遍历环缓存 进行删除和销毁
    for (const key in this.cache) {
      pruneCacheEntry(this.cache, key, this.keys)
    }
},

update函数，当前keep-alive更新的时候进行添加缓存

updated () {
    this.cacheVNode()
},

总结：

  1. keep-alive是vue内部实现的一个函数组件，它自身不会被渲染成dom元素
  2. 在函数组件中有两个属性分别用来存储要缓存的组件的实例和它的key
  3. 在函数组件的render函数中，首先获取到默认插槽中的第一个元素作为渲染的元素
  4. 通过获取到includes和excludes属性，来判断当前组件的name是否在其中，从而判断是否需要被缓存
  5. 如果不需要缓存直接返回当前的虚拟dom
  6. 否则直接从缓存中找当前组件并且返回，并且把key从缓存中进行删除，再push到尾部(最近最久未被访问的组件就会慢慢的移动到缓存数组的头部)；如果需要缓存就把当前的组件的实例采用LRU(Least Recently used)最近最小使用缓存原则；
  7. 当组件再次被渲染的时候直接使用缓存中的实例，无需重新进行创建组件的实例
转载自:https://juejin.cn/post/7239226209371652151
评论
请登录