依赖收集

通过上一节的分析我们了解 Vue 会把普通对象变成响应式对象，响应式对象 getter 相关的逻辑就是做依赖收集，这一节我们来详细分析这个过程。

我们先来回顾一下 getter 部分的逻辑：

  1. export function defineReactive (
  2.   obj: Object,
  3.   key: string,
  4.   val: any,
  5.   customSetter?: ?Function,
  6.   shallow?: boolean
  7. ) {
  8.   const dep = new Dep()
  10.   const property = Object.getOwnPropertyDescriptor(obj, key)
  11.   if (property && property.configurable === false) {
  12.     return
  13.   }
  15.   // cater for pre-defined getter/setters
  16.   const getter = property && property.get
  17.   const setter = property && property.set
  18.   if ((!getter || setter) && arguments.length === 2) {
  19.     val = obj[key]
  20.   }
  22.   let childOb = !shallow && observe(val)
  23.   Object.defineProperty(obj, key, {
  24.     enumerable: true,
  25.     configurable: true,
  26.     get: function reactiveGetter () {
  27.       const value = getter ? getter.call(obj) : val
  28.       if (Dep.target) {
  29.         dep.depend()
  30.         if (childOb) {
  31.           childOb.dep.depend()
  32.           if (Array.isArray(value)) {
  33.             dependArray(value)
  34.           }
  35.         }
  36.       }
  37.       return value
  38.     },
  39.     // ...
  40.   })
  41. }

这段代码我们只需要关注 2 个地方，一个是 const dep = new Dep() 实例化一个 Dep 的实例，另一个是在 get 函数中通过 dep.depend 做依赖收集，这里还有个对 childObj 判断的逻辑，我们之后会介绍它的作用。

Dep

Dep 是整个 getter 依赖收集的核心，它的定义在 src/core/observer/dep.js 中：

  1. import type Watcher from './watcher'
  2. import { remove } from '../util/index'
  4. let uid = 0
  6. /**
  7.  * A dep is an observable that can have multiple
  8.  * directives subscribing to it.
  9.  */
  10. export default class Dep {
  11.   static target: ?Watcher;
  12.   id: number;
  13.   subs: Array<Watcher>;
  15.   constructor () {
  16.     this.id = uid++
  17.     this.subs = []
  18.   }
  20.   addSub (sub: Watcher) {
  21.     this.subs.push(sub)
  22.   }
  24.   removeSub (sub: Watcher) {
  25.     remove(this.subs, sub)
  26.   }
  28.   depend () {
  29.     if (Dep.target) {
  30.       Dep.target.addDep(this)
  31.     }
  32.   }
  34.   notify () {
  35.     // stabilize the subscriber list first
  36.     const subs = this.subs.slice()
  37.     for (let i = 0, l = subs.length; i < l; i++) {
  38.       subs[i].update()
  39.     }
  40.   }
  41. }
  43. // the current target watcher being evaluated.
  44. // this is globally unique because there could be only one
  45. // watcher being evaluated at any time.
  46. Dep.target = null
  47. const targetStack = []
  49. export function pushTarget (_target: ?Watcher) {
  50.   if (Dep.target) targetStack.push(Dep.target)
  51.   Dep.target = _target
  52. }
  54. export function popTarget () {
  55.   Dep.target = targetStack.pop()
  56. }

Dep 是一个 Class，它定义了一些属性和方法，这里需要特别注意的是它有一个静态属性 target，这是一个全局唯一 Watcher，这是一个非常巧妙的设计，因为在同一时间只能有一个全局的 Watcher 被计算，另外它的自身属性 subs 也是 Watcher 的数组。

Dep 实际上就是对 Watcher 的一种管理，Dep 脱离 Watcher 单独存在是没有意义的，为了完整地讲清楚依赖收集过程，我们有必要看一下 Watcher 的一些相关实现，它的定义在 src/core/observer/watcher.js 中：

Watcher

  1. let uid = 0
  3. /**
  4.  * A watcher parses an expression, collects dependencies,
  5.  * and fires callback when the expression value changes.
  6.  * This is used for both the $watch() api and directives.
  7.  */
  8. export default class Watcher {
  9.   vm: Component;
  10.   expression: string;
  11.   cb: Function;
  12.   id: number;
  13.   deep: boolean;
  14.   user: boolean;
  15.   computed: boolean;
  16.   sync: boolean;
  17.   dirty: boolean;
  18.   active: boolean;
  19.   dep: Dep;
  20.   deps: Array<Dep>;
  21.   newDeps: Array<Dep>;
  22.   depIds: SimpleSet;
  23.   newDepIds: SimpleSet;
  24.   before: ?Function;
  25.   getter: Function;
  26.   value: any;
  28.   constructor (
  29.     vm: Component,
  30.     expOrFn: string | Function,
  31.     cb: Function,
  32.     options?: ?Object,
  33.     isRenderWatcher?: boolean
  34.   ) {
  35.     this.vm = vm
  36.     if (isRenderWatcher) {
  37.       vm._watcher = this
  38.     }
  39.     vm._watchers.push(this)
  40.     // options
  41.     if (options) {
  42.       this.deep = !!options.deep
  43.       this.user = !!options.user
  44.       this.computed = !!options.computed
  45.       this.sync = !!options.sync
  46.       this.before = options.before
  47.     } else {
  48.       this.deep = this.user = this.computed = this.sync = false
  49.     }
  50.     this.cb = cb
  51.     this.id = ++uid // uid for batching
  52.     this.active = true
  53.     this.dirty = this.computed // for computed watchers
  54.     this.deps = []
  55.     this.newDeps = []
  56.     this.depIds = new Set()
  57.     this.newDepIds = new Set()
  58.     this.expression = process.env.NODE_ENV !== 'production'
  59.       ? expOrFn.toString()
  60.       : ''
  61.     // parse expression for getter
  62.     if (typeof expOrFn === 'function') {
  63.       this.getter = expOrFn
  64.     } else {
  65.       this.getter = parsePath(expOrFn)
  66.       if (!this.getter) {
  67.         this.getter = function () {}
  68.         process.env.NODE_ENV !== 'production' && warn(
  69.           `Failed watching path: "${expOrFn}" ` +
  70.           'Watcher only accepts simple dot-delimited paths. ' +
  71.           'For full control, use a function instead.',
  72.           vm
  73.         )
  74.       }
  75.     }
  76.     if (this.computed) {
  77.       this.value = undefined
  78.       this.dep = new Dep()
  79.     } else {
  80.       this.value = this.get()
  81.     }
  82.   }
  84.   /**
  85.    * Evaluate the getter, and re-collect dependencies.
  86.    */
  87.   get () {
  88.     pushTarget(this)
  89.     let value
  90.     const vm = this.vm
  91.     try {
  92.       value = this.getter.call(vm, vm)
  93.     } catch (e) {
  94.       if (this.user) {
  95.         handleError(e, vm, `getter for watcher "${this.expression}"`)
  96.       } else {
  97.         throw e
  98.       }
  99.     } finally {
  100.       // "touch" every property so they are all tracked as
  101.       // dependencies for deep watching
  102.       if (this.deep) {
  103.         traverse(value)
  104.       }
  105.       popTarget()
  106.       this.cleanupDeps()
  107.     }
  108.     return value
  109.   }
  111.   /**
  112.    * Add a dependency to this directive.
  113.    */
  114.   addDep (dep: Dep) {
  115.     const id = dep.id
  116.     if (!this.newDepIds.has(id)) {
  117.       this.newDepIds.add(id)
  118.       this.newDeps.push(dep)
  119.       if (!this.depIds.has(id)) {
  120.         dep.addSub(this)
  121.       }
  122.     }
  123.   }
  125.   /**
  126.    * Clean up for dependency collection.
  127.    */
  128.   cleanupDeps () {
  129.     let i = this.deps.length
  130.     while (i--) {
  131.       const dep = this.deps[i]
  132.       if (!this.newDepIds.has(dep.id)) {
  133.         dep.removeSub(this)
  134.       }
  135.     }
  136.     let tmp = this.depIds
  137.     this.depIds = this.newDepIds
  138.     this.newDepIds = tmp
  139.     this.newDepIds.clear()
  140.     tmp = this.deps
  141.     this.deps = this.newDeps
  142.     this.newDeps = tmp
  143.     this.newDeps.length = 0
  144.   }
  145.   // ...
  146. }

Watcher 是一个 Class，在它的构造函数中，定义了一些和 Dep 相关的属性：

  1. this.deps = []
  2. this.newDeps = []
  3. this.depIds = new Set()
  4. this.newDepIds = new Set()

其中，this.deps 和 this.newDeps 表示 Watcher 实例持有的 Dep 实例的数组；而 this.depIds 和 this.newDepIds 分别代表 this.deps 和 this.newDeps 的 id Set（这个 Set 是 ES6 的数据结构，它的实现在 src/core/util/env.js 中）。那么这里为何需要有 2 个 Dep 实例数组呢，稍后我们会解释。

Watcher 还定义了一些原型的方法，和依赖收集相关的有 get、addDep 和 cleanupDeps 方法，单个介绍它们的实现不方便理解，我会结合整个依赖收集的过程把这几个方法讲清楚。

过程分析

之前我们介绍当对数据对象的访问会触发他们的 getter 方法，那么这些对象什么时候被访问呢？还记得之前我们介绍过 Vue 的 mount 过程是通过 mountComponent 函数，其中有一段比较重要的逻辑，大致如下：

  1. updateComponent = () => {
  2.   vm._update(vm._render(), hydrating)
  3. }
  4. new Watcher(vm, updateComponent, noop, {
  5.   before () {
  6.     if (vm._isMounted) {
  7.       callHook(vm, 'beforeUpdate')
  8.     }
  9.   }
  10. }, true /* isRenderWatcher */)

当我们去实例化一个渲染 watcher 的时候，首先进入 watcher 的构造函数逻辑，然后会执行它的 this.get() 方法，进入 get 函数，首先会执行：

  1. pushTarget(this)

pushTarget 的定义在 src/core/observer/dep.js 中：

  1. export function pushTarget (_target: Watcher) {
  2.   if (Dep.target) targetStack.push(Dep.target)
  3.   Dep.target = _target
  4. }

实际上就是把 Dep.target 赋值为当前的渲染 watcher 并压栈（为了恢复用）。接着又执行了：

  1. value = this.getter.call(vm, vm)

this.getter 对应就是 updateComponent 函数，这实际上就是在执行：

  1. vm._update(vm._render(), hydrating)

它会先执行 vm._render() 方法，因为之前分析过这个方法会生成 渲染 VNode，并且在这个过程中会对 vm 上的数据访问，这个时候就触发了数据对象的 getter。

那么每个对象值的 getter 都持有一个 dep，在触发 getter 的时候会调用 dep.depend() 方法，也就会执行 Dep.target.addDep(this)。

刚才我们提到这个时候 Dep.target 已经被赋值为渲染 watcher，那么就执行到 addDep 方法：

  1. addDep (dep: Dep) {
  2.   const id = dep.id
  3.   if (!this.newDepIds.has(id)) {
  4.     this.newDepIds.add(id)
  5.     this.newDeps.push(dep)
  6.     if (!this.depIds.has(id)) {
  7.       dep.addSub(this)
  8.     }
  9.   }
  10. }

这时候会做一些逻辑判断（保证同一数据不会被添加多次）后执行 dep.addSub(this)，那么就会执行 this.subs.push(sub)，也就是说把当前的 watcher 订阅到这个数据持有的 dep 的 subs 中，这个目的是为后续数据变化时候能通知到哪些 subs 做准备。

所以在 vm._render() 过程中，会触发所有数据的 getter，这样实际上已经完成了一个依赖收集的过程。那么到这里就结束了么，其实并没有，再完成依赖收集后，还有几个逻辑要执行，首先是：

  1. if (this.deep) {
  2.   traverse(value)
  3. }

这个是要递归去访问 value，触发它所有子项的 getter，这个之后会详细讲。接下来执行：

  1. popTarget()

popTarget 的定义在 src/core/observer/dep.js 中：

  1. Dep.target = targetStack.pop()

实际上就是把 Dep.target 恢复成上一个状态，因为当前 vm 的数据依赖收集已经完成，那么对应的渲染Dep.target 也需要改变。最后执行：

  1. this.cleanupDeps()

其实很多人都分析过并了解到 Vue 有依赖收集的过程，但我几乎没有看到有人分析依赖清空的过程，其实这是大部分同学会忽视的一点，也是 Vue 考虑特别细的一点。

  1. cleanupDeps () {
  2.   let i = this.deps.length
  3.   while (i--) {
  4.     const dep = this.deps[i]
  5.     if (!this.newDepIds.has(dep.id)) {
  6.       dep.removeSub(this)
  7.     }
  8.   }
  9.   let tmp = this.depIds
  10.   this.depIds = this.newDepIds
  11.   this.newDepIds = tmp
  12.   this.newDepIds.clear()
  13.   tmp = this.deps
  14.   this.deps = this.newDeps
  15.   this.newDeps = tmp
  16.   this.newDeps.length = 0
  17. }

考虑到 Vue 是数据驱动的，所以每次数据变化都会重新 render，那么 vm._render() 方法又会再次执行，并再次触发数据的 getters，所以 Wathcer 在构造函数中会初始化 2 个 Dep 实例数组，newDeps 表示新添加的 Dep 实例数组，而 deps 表示上一次添加的 Dep 实例数组。

在执行 cleanupDeps 函数的时候，会首先遍历 deps，移除对 dep 的订阅，然后把 newDepIds 和 depIds 交换，newDeps 和 deps 交换，并把 newDepIds 和 newDeps 清空。

那么为什么需要做 deps 订阅的移除呢，在添加 deps 的订阅过程，已经能通过 id 去重避免重复订阅了。

考虑到一种场景，我们的模板会根据 v-if 去渲染不同子模板 a 和 b，当我们满足某种条件的时候渲染 a 的时候，会访问到 a 中的数据，这时候我们对 a 使用的数据添加了 getter，做了依赖收集，那么当我们去修改 a 的数据的时候，理应通知到这些订阅者。那么如果我们一旦改变了条件渲染了 b 模板，又会对 b 使用的数据添加了 getter，如果我们没有依赖移除的过程，那么这时候我去修改 a 模板的数据，会通知 a 数据的订阅的回调，这显然是有浪费的。

因此 Vue 设计了在每次添加完新的订阅，会移除掉旧的订阅，这样就保证了在我们刚才的场景中，如果渲染 b 模板的时候去修改 a 模板的数据，a 数据订阅回调已经被移除了，所以不会有任何浪费，真的是非常赞叹 Vue 对一些细节上的处理。

总结

通过这一节的分析，我们对 Vue 数据的依赖收集过程已经有了认识，并且对这其中的一些细节做了分析。收集依赖的目的是为了当这些响应式数据发送变化，触发它们的 setter 的时候，能知道应该通知哪些订阅者去做相应的逻辑处理，我们把这个过程叫派发更新，其实 Watcher 和 Dep 就是一个非常经典的观察者设计模式的实现，下一节我们来详细分析一下派发更新的过程。

原文: https://ustbhuangyi.github.io/vue-analysis/reactive/getters.html