vue源码解析之keep-alive

问题来了

在使用vue的时，cache or not cache, is a problem。因为页面需不需要缓存是一个很复杂的问题，当被boss问到，这个页面加载怎么白屏这么久？脑子里晃过:

• SSR？可是后端不是node啊！！不过好像白不白屏也没多大关系！
• prerender？history模式？nginx配置？浏览器阻止？各种坑？
• localstorage缓存？存取管理麻烦
• 骨架屏？boss：不还是没内容吗？！！[怄火.jpg]
• 那我还是搞个keep-alive算了吧？

那么问题来了？

• 页面A - 页面B - 页面C : 前进后退时，页面B是keep-alive: true 还是false?
• 前进刷新，后退不刷新
• 前进刷新，后退部分刷新

嗨～，我当初为什么要学前端啊？我是听了谁的话进的这行？为什么我要读大学？为什么要进软件工程这个专业？我妈为什么要把我生下来？开始怀疑人生了，不过，问题还是得解决滴，嘻嘻～～，还是沉下心来好好看一番吧。

官方介绍

keep alive
props：

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

用法：
包裹动态组件时，会缓存不活动的组件实例，而不是销毁它们。和transition 相似, keep-alive是一个抽象组件：它自身不会渲染一个 DOM 元素，也不会出现在父组件链中。

当组件在 内被切换，它的 activated 和 deactivated 这两个生命周期钩子函数将会被对应执行。

主要用于保留组件状态或避免重新渲染。

特性

• 只能包裹一个直属子组件，不能使用v-for
• 2.1.0新增，include和exclude条件缓存

那么我们来看看，keep-alive的源码实现，下面会有详细的注释，源码基于v2.6.10。

源码解析

/* @flow */

/**
 * 引用工具函数：
 * isRegExp ： 判断是否是正则表达式
 * remove: 从数组中删除某一项
 * getFirstComponentChild： 
 */
import { isRegExp, remove } from 'shared/util'
import { getFirstComponentChild } from 'core/vdom/helpers/index'

/**
 * 开始以为是typescript类型，但是发现两点疑问：
 * 1.文件不是ts后缀
 * 2.:和？的顺序不对
 * 结论：原来这家伙是基于FLOW去做的类型检查，有兴趣的同学自行了解一下
 * 表示引用一个复杂类型，[]表示可以通过key进行索引，？表示值的类型是可选的
 * 其实第一个行有个注释 @flow，开始没看到~~
 */
type VNodeCache = { [key: string]: ?VNode };

/**
 * 获取组件名称：
 * 如果option中有定义name属性则直接返回
 * 否则返回tag
 */
function getComponentName (opts: ?VNodeComponentOptions): ?string {
  return opts && (opts.Ctor.options.name || opts.tag)
}

/**
 * 匹配规则
 */
function matches (pattern: string | RegExp | Array, 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 cachedNode: ?VNode = cache[key]
    if (cachedNode) {
      const name: ?string = getComponentName(cachedNode.componentOptions)
      if (name && !filter(name)) {
        pruneCacheEntry(cache, key, keys, _vnode)
      }
    }
  }
}

/**
 * 修剪缓存入口
 */
function pruneCacheEntry (
  cache: VNodeCache,
  key: string,
  keys: Array,
  current?: VNode
) {
  const cached = cache[key]
  // 主动执行某个组件的destory，触发destroy钩子，达到销毁目的，然后移除缓存中的key-value
  if (cached && (!current || cached.tag !== current.tag)) {
    cached.componentInstance.$destroy()
  }
  cache[key] = null
  remove(keys, key)
}

const patternTypes: Array = [String, RegExp, Array]

export default {
  name: 'keep-alive',
  // 抽象组件
  abstract: true,
  // 定义include、exclude及max属性
  // include - 字符串或正则表达式。只有名称匹配的组件会被缓存。
  // exclude - 字符串或正则表达式。任何名称匹配的组件都不会被缓存。
  // max - 数字。最多可以缓存多少组件实例。
  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 () {
    // 监听include和exclue，使其支持双向绑定
    this.$watch('include', val => {
      pruneCache(this, name => matches(val, name))
    })
    this.$watch('exclude', val => {
      pruneCache(this, name => !matches(val, name))
    })
  },

  render () {
    // $slots.default表示slot中的所有子组件（包括换行）
    const slot = this.$slots.default
    // 获取第一个组件（这就是为什么keep-alive中只允许渲染一个直属子组件，而不能用v-for的原因）
    const vnode: VNode = getFirstComponentChild(slot)
    const componentOptions: ?VNodeComponentOptions = vnode && vnode.componentOptions
    if (componentOptions) {
      // 获取子组件名称
      const name: ?string = getComponentName(componentOptions)
      // 验证组件名称的name是否包含在include或者不在exclude中
      const { include, exclude } = this
      if (
        // not included
        (include && (!name || !matches(include, name))) ||
        // excluded
        (exclude && name && matches(exclude, name))
      ) {
        // 不通过缓存获取，直接加载组件
        return vnode
      }

      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,
      // 如果key队友的vnode存在，则更新key值
      if (cache[key]) {
        vnode.componentInstance = cache[key].componentInstance
        // make current key freshest
        remove(keys, key)
        keys.push(key)
      } else {
        // 否则将vnode存入缓存
        cache[key] = vnode
        keys.push(key)
        // 如果超出max则将第一个缓存的vnode移除
        if (this.max && keys.length > parseInt(this.max)) {
          pruneCacheEntry(cache, keys[0], keys, this._vnode)
        }
      }

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

常用方案

• 利用include 和 exclude
• 利用beforeRouterEnter()和meta动态修改keepAlive
• 使用第三方插件vue-navigation

具体的方案就不一一介绍了，某些场景需要几个方案结合使用，麻烦大家自行度娘，熟练掌握。祝大家工作愉快