vue2.x中keep-alive源码解析(实例代码)

<keep-alive :include="componentOne`" :exclude="componentTwo" :max="num"> 
    <component :is="currentComponent"></component> 
</keep-alive>

<keep-alive :include="componentOne`" :exclude="componentTwo" :max="num"> 
    <router-view :is="currentComponent"></router-view> 
</keep-alive>

<router-view v-slot="{ Component }">
   <keep-alive :include="includeList">
	    <component :is="Component"/>
   </keep-alive>
</router-view>

// 源码位置：class="lazy" data-src/core/components/keep-alive.js
export default {
  name: 'keep-alive',
  abstract: true,
  props: {
    include: patternTypes,
    exclude: patternTypes,
    max: [String, Number]
  },
  created () {
    this.cache = Object.create(null)
    this.keys = []
  },
  destroyed () {
    for (const key in this.cache) {
      pruneCacheEntry(this.cache, key, this.keys)
    }
  },
  mounted () {
   //查看是否有缓存没有缓存的话直接走缓存
    this.cacheVNode()
    // 这里借助 watch 监控 include  和 exclude 
  // 如果有变化的话，则按照最新的 include 和 exclude 更新 this.cache
  // 将不满足 include、exclude 限制的 缓存vnode 从 this.cache 中移除  
  this.$watch('include', val => {
      pruneCache(this, name => matches(val, name))
    })
    this.$watch('exclude', val => {
      pruneCache(this, name => !matches(val, name))
    })
  },
  updated() {
    this.cacheVNode()
  },
  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
      }
    }
 },
  render(){
    //下面详细介绍
  }
}

// class="lazy" data-src/core/components/keep-alive.js

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() // 执行组件的destory钩子函数
  }
  cache[key] = null  // cache中对象的key设为null
  remove(keys, key) // 删除keys对应的元素
}

render () {
	// 获取 keep-alive 组件子节点中的第一个组件 vnode
    const slot = this.$slots.default
    const vnode = getFirstComponentChild(slot)
    // 获取组件的配置选项对象
    const componentOptions = vnode && vnode.componentOptions
    if (componentOptions) {
      // 获取组件的名称
      const name = _getComponentName(componentOptions)
      const { include, exclude } = this
       // 如果当前的组件 name 不在 include 中或者组件的 name 在 exclude 中
		  // 说明当前的组件是不被 keep-alive 所缓存的，此时直接 return vnode 即可
      if (
        // not included
        (include && (!name || !matches(include, name))) ||
        // excluded
        (exclude && name && matches(exclude, name))
      ) {
        return vnode
      }
     // 代码执行到这里，说明当前的组件受 keep-alive 组件的缓存
      const { cache, keys } = this
        // 定义 vnode 缓存用的 key
      const key =
        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
           // 如果 cache[key] 已经存在的话，则说明当前的组件 vnode 已经被缓存过了,此时需要将其恢复还原出来
      if (cache[key]) {
      	// 将缓存的 Vue 实例赋值给 vnode.componentInstance
        vnode.componentInstance = cache[key].componentInstance
        // make current key freshest
        	// 先从 keys 中移除 key，然后再 push key，这可以保证当前的 key 在 keys 数组中的最后面
        remove(keys, key)
        keys.push(key)
      } else {
        // delay setting the cache until update
        	// 如果 cache[key] 不存在的话，说明当前的子组件是第一次出现，此时需要将 vnode 缓存到 cache 中，将 key 存储到 keys 字符串数组中。这里是用一个中间变量接收，当数据变化时触发updated去调用cacheVNode方法。
        this.vnodeToCache = vnode
        this.keyToCache = key
      }

      // @ts-expect-error can vnode.data can be undefined
       // 将 vnode.data.keepAlive 属性设置为 true，这对 vnode 有一个标识的作用，标识这个
		  // vnode 是 keep-alive 组件的 render 函数 return 出去的，这个标识在下面的运行代码中有用
      vnode.data.keepAlive = true
    }
    return vnode || (slot && slot[0])
  }