Vue源码阅读 理解computed的实现

使用场景

讲实现之前,我们先简单想一下一般会在哪些地方使用到computed。一般我们比较常用的有一下几种情景:

  • 模版计算:在模版里某个或者通过一些处理,比方说时间格式化等
  • 动态求值:数据依赖多个变量变化

以上这些场景我们实际上也可以通过method以及watch监听多个数据实现。那么为什么需要computed,他有什么特性?

先贴一个官方的解释:计算属性是基于它们的响应式依赖进行缓存的,只在相关响应式依赖发生改变时它们才会重新求值

从这我们可以看到computed有两个特性

  • 值是响应式变化(区别于method)
  • 数据会进行缓存

下面我们就从源码角度分析一下,具体是怎么实现上面的两个特性的。

入口

computed的源码实现在目录src/core/instance,为了方便阅读,代码解析会省略部分代码。

// state.js
export function initState (vm: Component) {
  vm._watchers = []
  const opts = vm.$options
  if (opts.props) initProps(vm, opts.props)
  if (opts.methods) initMethods(vm, opts.methods)
  if (opts.data) {
    initData(vm)
  } else {
    observe(vm._data = {}, true /* asRootData */)
  }
  if (opts.computed) initComputed(vm, opts.computed)
  if (opts.watch && opts.watch !== nativeWatch) {
    initWatch(vm, opts.watch)
  }
}

vue在初始化的时候 会先去执行```initProps, initMethods, initData ,然后进行computed的初始化, 这里我们也就知道为什么在data初始化时,获取不到computed的值

initState的时候判断是不是有computed对象,有的话执行initComputed方法

initComputed

// state.js
const computedWatcherOptions = { lazy: true }
function initComputed (vm: Component, computed: Object) {
  const watchers = vm._computedWatchers = Object.create(null)
  // 是否是服务端渲染
  const isSSR = isServerRendering()

  for (const key in computed) {
    const userDef = computed[key]
    const getter = typeof userDef === 'function' ? userDef : userDef.get
    if (process.env.NODE_ENV !== 'production' && getter == null) {
      warn(
        `Getter is missing for computed property "${key}".`,
        vm
      )
    }

    if (!isSSR) {
      // create internal watcher for the computed property.
      watchers[key] = new Watcher(
        vm,
        getter || noop,
        noop,
        computedWatcherOptions
      )
    }
    // 如果在data或者prop有相同的名称存在的情况下,提示
    if (!(key in vm)) {
      defineComputed(vm, key, userDef)
    } else if (process.env.NODE_ENV !== 'production') {
      if (key in vm.$data) {
        warn(`The computed property "${key}" is already defined in data.`, vm)
      } else if (vm.$options.props && key in vm.$options.props) {
        warn(`The computed property "${key}" is already defined as a prop.`, vm)
      }
    }
  }
}

initComputed 做了几件事情

  • 生成一个空对象_computedWatchers,并挂载到vue实例上 (后续访问key都是直接读取这个对象)

  • 获取computed的getter, 函数形式是函数本身,对象的话必须存在get函数

  • 为computed对象的每一个key,分配一个watch实例,并添加到_computedWatchers上

  • 判断,确保不会出现于data、prop重名的字段,有重名提示,后续不执行

  • 执行defineComputed:通过Object.defineProperty 设置代理,后续访问

​ 到这里大概我们可以猜测一下,computed的缓存应该是通过生成一个对象,每个键值都绑定了一个watch实例用于依赖收集。与其他地方使用watch不同的在于它传入了配置参数{ lazy: true }, 这个的目的是让实例化的时候不回立即求值,而是在访问到它的地方才会去求值。

// src/core/observer/watcher.js

export default class Watch {
  constructor () {
    ....
    this.value = this.lazy
      ? undefined
      : this.get()
  }
}

defineComputed

既然初次实例化的时候并没有求值,那么后续取值的时候是怎么去保证能拿到最新的数据呢?这个答案在defineComputed我们能找到,接下去我们就分析一下这个方法,看一下怎么去实现求值与取值的。

export function defineComputed (
  target: any,
  key: string,
  userDef: Object | Function
) {
  const shouldCache = !isServerRendering()
  if (typeof userDef === 'function') {
    sharedPropertyDefinition.get = shouldCache
      ? createComputedGetter(key)
      : createGetterInvoker(userDef)
    sharedPropertyDefinition.set = noop
  } else {
    sharedPropertyDefinition.get = userDef.get
      ? shouldCache && userDef.cache !== false
        ? createComputedGetter(key)
        : createGetterInvoker(userDef.get)
      : noop
    sharedPropertyDefinition.set = userDef.set || noop
  }
  if (process.env.NODE_ENV !== 'production' &&
      sharedPropertyDefinition.set === noop) {
    sharedPropertyDefinition.set = function () {
      warn(
        `Computed property "${key}" was assigned to but it has no setter.`,
        this
      )
    }
  }
  Object.defineProperty(target, key, sharedPropertyDefinition)
}

defineComputed 通过 Object.defineProperty 为 computed的key值重新设置了get和set方法,对象情况下,set就是computed的set函数。通过cache判断执行的不同的get函数逻辑。

createComputedGetter

接下去看一下createComputedGetter 方法实现

function createComputedGetter (key) {
  return function computedGetter () {
    const watcher = this._computedWatchers && this._computedWatchers[key]
    if (watcher) {
      if (watcher.dirty) {
        watcher.evaluate()
      }
      if (Dep.target) {
        watcher.depend()
      }
      return watcher.value
    }
  }
}

​ 这个方法里面才是computed能实现缓存的关键。从这个函数我们可以看出基本逻辑和我们之前分析的一致,每次访问key值时,首先是从_computedWatchers 这个对象去取出对应的watch实例, 返回wathc.value就是我们要的值。

​ 这里还进行了判断了watch.dirty 也就是数据依赖变化的情况,执行wathcer.evaluate() 重新获取值

// src/core/observer/watcher.js

export default class Watch {
  constructor () {
    this.dirty = this.lazy
    ....
    this.value = this.lazy
      ? undefined
      : this.get()
  }
}
get () {
  pushTarget(this)
  let value
  const vm = this.vm
  try {
    value = this.getter.call(vm, vm)
  } catch (e) {
    if (this.user) {
      handleError(e, vm, `getter for watcher "${this.expression}"`)
    } else {
      throw e
    }
  } finally {
    // "touch" every property so they are all tracked as
    // dependencies for deep watching
    if (this.deep) {
      traverse(value)
    }
    popTarget()
    this.cleanupDeps()
  }
  return value
}
evaluate () {
  this.value = this.get()
  this.dirty = false
}
update () {
    /* istanbul ignore else */
    if (this.lazy) {
      // computed watch
      this.dirty = true
    } else if (this.sync) {
      this.run()
    } else {
      queueWatcher(this)
    }
  }

​ 初始化实例的时候dirty等于传入的配置lazy 所以在第一次访问计算属性时,他会做一次求值,执行get更改value值。然后将dirty置为false, 后续我们访问的时候就会直接返回这个值,并不会再次计算,这就是为什么computed的数据能缓存的关键所在。

computed还有一个特性就是依赖的数据变化时,会跟随变化。这块涉及到依赖收集相关的,本篇不做展开。回忆一下之前的,在为key值分配watch的时候我们会把本身的get函数传入watch实例,然后在每次访问key的时候,如果dirty为true就会执行watch.get 方法,该方法执行的就是我们传入的computed的get函数, 这个时候他内部的响应式依赖数据就会收集。后续依赖数据变化时就会执行watch.update方法, 这个时候把就会再次把dirty设置为true, 接下去我们访问计算属性就会再次执行watch.get更新数据。

以上就是computed的完整实现

小结:computed实现主要是在实例下的生成_computedWatchers对象,后续访问都是直接访问到这个对象。对象上的每个键值都是一个watch实例,访问时返回watch的value值, 通过dirty去控制是否重新计算,每次依赖变化触发watch的update方法,改变dirty的值,下一次访问的时候重新计算获取值,否则直接返回上一次的值。

以上就是个人对computed的实现,如果有什么讲的不对的,欢迎评论回复指出。

你可能感兴趣的:(Vue源码阅读 理解computed的实现)