Vue源码分析—响应式原理(二)

依赖收集 Vue会把普通对象变成响应式对象,响应式对象getter相关的逻辑就是做依赖收集,我们来详细分析这个过程。
我们先来回顾一下getter部分的逻辑:

export function defineReactive ( obj: Object, key: string, val: any, customSetter?: ?Function, shallow?: boolean ) { const dep = new Dep()const property = Object.getOwnPropertyDescriptor(obj, key) if (property && property.configurable === false) { return }// cater for pre-defined getter/setters const getter = property && property.get const setter = property && property.set if ((!getter || setter) && arguments.length === 2) { val = obj[key] }let childOb = !shallow && observe(val) Object.defineProperty(obj, key, { enumerable: true, configurable: true, get: function reactiveGetter () { const value = https://www.it610.com/article/getter ? getter.call(obj) : val if (Dep.target) { dep.depend() if (childOb) { childOb.dep.depend() if (Array.isArray(value)) { dependArray(value) } } } return value }, // ... }) }

这段代码我们只需要关注2个地方,一个是const dep = new Dep()实例化一个Dep的实例,另一个是在get函数中通过dep.depend做依赖收集,这里还有个对childOb判断的逻辑。
Dep Dep是整个getter依赖收集的核心,它的定义在src/core/observer/dep.js中:
import type Watcher from './watcher' import { remove } from '../util/index'let uid = 0/** * A dep is an observable that can have multiple * directives subscribing to it. */ export default class Dep { static target: ?Watcher; id: number; subs: Array; constructor () { this.id = uid++ this.subs = [] }addSub (sub: Watcher) { this.subs.push(sub) }removeSub (sub: Watcher) { remove(this.subs, sub) }depend () { if (Dep.target) { Dep.target.addDep(this) } }notify () { // stabilize the subscriber list first const subs = this.subs.slice() for (let i = 0, l = subs.length; i < l; i++) { subs[i].update() } } }// the current target watcher being evaluated. // this is globally unique because there could be only one // watcher being evaluated at any time. Dep.target = null const targetStack = []export function pushTarget (_target: ?Watcher) { if (Dep.target) targetStack.push(Dep.target) Dep.target = _target }export function popTarget () { Dep.target = targetStack.pop() }

Dep是一个Class,它定义了一些属性和方法,这里需要特别注意的是它有一个静态属性target,这是一个全局唯一Watcher,这是一个非常巧妙的设计,因为在同一时间只能有一个全局的Watcher被计算,另外它的自身属性subs也是Watcher的数组。
Dep实际上就是对Watcher的一种管理,Dep脱离Watcher单独存在是没有意义的,为了完整地讲清楚依赖收集过程,我们有必要看一下Watcher的一些相关实现,它的定义在src/core/observer/watcher.js中:
Watcher
let uid = 0/** * A watcher parses an expression, collects dependencies, * and fires callback when the expression value changes. * This is used for both the $watch() api and directives. */ export default class Watcher { vm: Component; expression: string; cb: Function; id: number; deep: boolean; user: boolean; computed: boolean; sync: boolean; dirty: boolean; active: boolean; dep: Dep; deps: Array; newDeps: Array; depIds: SimpleSet; newDepIds: SimpleSet; before: ?Function; getter: Function; value: any; constructor ( vm: Component, expOrFn: string | Function, cb: Function, options?: ?Object, isRenderWatcher?: boolean ) { this.vm = vm if (isRenderWatcher) { vm._watcher = this } vm._watchers.push(this) // options if (options) { this.deep = !!options.deep this.user = !!options.user this.computed = !!options.computed this.sync = !!options.sync this.before = options.before } else { this.deep = this.user = this.computed = this.sync = false } this.cb = cb this.id = ++uid // uid for batching this.active = true this.dirty = this.computed // for computed watchers this.deps = [] this.newDeps = [] this.depIds = new Set() this.newDepIds = new Set() this.expression = process.env.NODE_ENV !== 'production' ? expOrFn.toString() : '' // parse expression for getter if (typeof expOrFn === 'function') { this.getter = expOrFn } else { this.getter = parsePath(expOrFn) if (!this.getter) { this.getter = function () {} process.env.NODE_ENV !== 'production' && warn( `Failed watching path: "${expOrFn}" ` + 'Watcher only accepts simple dot-delimited paths. ' + 'For full control, use a function instead.', vm ) } } if (this.computed) { this.value = https://www.it610.com/article/undefined this.dep = new Dep() } else { this.value = this.get() } }/** * Evaluate the getter, and re-collect dependencies. */ 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 }/** * Add a dependency to this directive. */ addDep (dep: Dep) { const id = dep.id if (!this.newDepIds.has(id)) { this.newDepIds.add(id) this.newDeps.push(dep) if (!this.depIds.has(id)) { dep.addSub(this) } } }/** * Clean up for dependency collection. */ cleanupDeps () { let i = this.deps.length while (i--) { const dep = this.deps[i] if (!this.newDepIds.has(dep.id)) { dep.removeSub(this) } } let tmp = this.depIds this.depIds = this.newDepIds this.newDepIds = tmp this.newDepIds.clear() tmp = this.deps this.deps = this.newDeps this.newDeps = tmp this.newDeps.length = 0 } // ... }

Watcher是一个Class,在它的构造函数中,定义了一些和Dep相关的属性:
this.deps = [] this.newDeps = [] this.depIds = new Set() this.newDepIds = new Set()

其中,this.depsthis.newDeps表示Watcher实例持有的Dep实例的数组;而this.depIdsthis.newDepIds分别代表this.depsthis.newDepsid Set(它的实现在src/core/util/env.js中)。
Watcher还定义了一些原型的方法,和依赖收集相关的有getaddDepcleanupDeps方法。
过程分析 当对数据对象的访问会触发他们的getter方法,那么这些对象什么时候被访问呢?Vuemount过程是通过mountComponent函数,其中有一段比较重要的逻辑,大致如下:
updateComponent = () => { vm._update(vm._render(), hydrating) } new Watcher(vm, updateComponent, noop, { before () { if (vm._isMounted) { callHook(vm, 'beforeUpdate') } } }, true /* isRenderWatcher */)

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

pushTarget的定义在src/core/observer/dep.js中:
export function pushTarget (_target: Watcher) { if (Dep.target) targetStack.push(Dep.target) Dep.target = _target }

实际上就是把Dep.target赋值为当前的渲染watcher并压栈(为了恢复用)。接着又执行了:
value = https://www.it610.com/article/this.getter.call(vm, vm)

this.getter对应就是updateComponent函数,这实际上就是在执行:
vm._update(vm._render(), hydrating)

它会先执行vm._render()方法,因为之前分析过这个方法会生成渲染VNode,并且在这个过程中会对vm上的数据访问,这个时候就触发了数据对象的getter
那么每个对象值的getter都持有一个dep,在触发getter的时候会调用dep.depend()方法,也就会执行 Dep.target.addDep(this)
刚才我们提到这个时候Dep.target 已经被赋值为渲染watcher,那么就执行到addDep方法:
addDep (dep: Dep) { const id = dep.id if (!this.newDepIds.has(id)) { this.newDepIds.add(id) this.newDeps.push(dep) if (!this.depIds.has(id)) { dep.addSub(this) } } }

这时候会做一些逻辑判断(保证同一数据不会被添加多次)后执行dep.addSub(this),那么就会执行 this.subs.push(sub),也就是说把当前的 watcher 订阅到这个数据持有的depsubs中,这个目的是为后续数据变化时候能通知到哪些subs做准备。
所以在 vm._render() 过程中,会触发所有数据的getter,这样实际上已经完成了一个依赖收集的过程。那么到这里就结束了么,其实并没有,在完成依赖收集后,还有几个逻辑要执行,首先是:
if (this.deep) { traverse(value) }

这个是要递归去访问value,触发它所有子项的getter。接下来执行:
popTarget()

popTarget 的定义在src/core/observer/dep.js中:
Dep.target = targetStack.pop()

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

依赖清空的过程。
cleanupDeps () { let i = this.deps.length while (i--) { const dep = this.deps[i] if (!this.newDepIds.has(dep.id)) { dep.removeSub(this) } } let tmp = this.depIds this.depIds = this.newDepIds this.newDepIds = tmp this.newDepIds.clear() tmp = this.deps this.deps = this.newDeps this.newDeps = tmp this.newDeps.length = 0 }

考虑到Vue是数据驱动的,所以每次数据变化都会重新render,那么vm._render()方法又会再次执行,并再次触发数据的getters,所以Wathcer在构造函数中会初始化2个Dep实例数组,newDeps表示新添加的Dep实例数组,而deps表示上一次添加的Dep实例数组。
在执行cleanupDeps函数的时候,会首先遍历deps,移除对dep.subs数组中Wathcer的订阅,然后把newDepIdsdepIds交换,newDepsdeps交换,并把newDepIdsnewDeps清空。
那么为什么需要做deps订阅的移除呢,在添加deps的订阅过程,已经能通过id去重避免重复订阅了。
考虑到一种场景,我们的模板会根据v-if 去渲染不同子模板ab,当我们满足某种条件的时候渲染a的时候,会访问到a中的数据,这时候我们对a使用的数据添加了getter,做了依赖收集,那么当我们去修改a的数据的时候,理应通知到这些订阅者。那么如果我们一旦改变了条件渲染了b模板,又会对b使用的数据添加了getter,如果我们没有依赖移除的过程,那么这时候我去修改a模板的数据,会通知a数据的订阅的回调,这显然是有浪费的。
因此Vue设计了在每次添加完新的订阅,会移除掉旧的订阅,这样就保证了在我们刚才的场景中,如果渲染b模板的时候去修改a模板的数据,a数据订阅回调已经被移除了,所以不会有任何浪费。
总结 【Vue源码分析—响应式原理(二)】我们对Vue数据的依赖收集过程做了分析。收集依赖的目的是为了当这些响应式数据发生变化,触发它们的setter的时候,能知道应该通知哪些订阅者去做相应的逻辑处理,我们把这个过程叫派发更新,其实WatcherDep就是一个非常经典的观察者设计模式的实现。

    推荐阅读