一、深入响应式原理
-
之前都是
Vue
怎么实现数据渲染和组件化的,主要是初始化的过程,把原始的数据最终映射到DOM
中,但并没有涉及到数据变化到DOM
变化的部分。而Vue
的数据驱动除了数据渲染DOM
之外,还有一个很重要的体现就是数据的变更会触发DOM
的变化。 -
其实前端开发最重要的两个工作,一个是把数据渲染到页面,另一个是处理用户交互。
Vue
把数据渲染到页面的能力我们已经通过源码分析出其中的原理了,但是由于一些用户交互或者是其它方面导致数据发生变化重新对页面渲染的原理我们还未分析,考虑如下示例:
<div id="app" @click="changeMsg">
{{ message }}
</div>
var app = new Vue({
el: '#app',
data: {
message: 'Hello Vue!'
},
methods: {
changeMsg() {
this.message = 'Hello World!'
}
}
})
当我们去修改
this.message
的时候,模板对应的插值也会渲染成新的数据,那么这一切是怎么做到的呢?
- 在分析前,我们先直观的想一下,如果不用
Vue
的话,我们会通过最简单的方法实现这个需求:监听点击事件,修改数据,手动操作DOM
重新渲染。这个过程和使用Vue
的最大区别就是多了一步“手动操作DOM
重新渲染”。这一步看上去并不多,但它背后又潜在的几个要处理的问题:
- 我需要修改哪块的
DOM
? - 我的修改效率和性能是不是最优的?
- 我需要对数据每一次的修改都去操作
DOM
吗? - 我需要
case by case
去写修改DOM
的逻辑吗?
- 如果我们使用了
Vue
,那么上面几个问题Vue
内部就帮你做了,那么Vue
是如何在我们对数据修改后自动做这些事情呢,接下来就是Vue
响应式系统。
二、响应式对象
-
Vue.js
实现响应式的核心是利用了ES5
的Object.defineProperty
,这也是为什么Vue.js
不能兼容IE8
及以下浏览器的原因,我们先来对它有个直观的认识。 -
Object.defineProperty
,Object.defineProperty
方法会直接在一个对象上定义一个新属性,或者修改一个对象的现有属性,并返回这个对象,先来看一下它的语法:
Object.defineProperty(obj, prop, descriptor)
obj
是要在其上定义属性的对象;prop
是要定义或修改的属性的名称;descriptor
是将被定义或修改的属性描述符。
-
这里比较核心的是
descriptor
,它有很多可选键值,具体的可以去参阅它的文档。这里我们最关心的是get
和set
,get
是一个给属性提供的getter
方法,当我们访问了该属性的时候会触发getter
方法;set
是一个给属性提供的setter
方法,当我们对该属性做修改的时候会触发setter
方法。一旦对象拥有了getter
和setter
,我们可以简单地把这个对象称为响应式对象。那么Vue.js
把哪些对象变成了响应式对象了呢,接下来我们从源码层面分析。 -
initState
,在Vue
的初始化阶段,_init
方法执行的时候,会执行initState(vm)
方法,它的定义在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)
}
}
initState
方法主要是对props
、methods
、data
、computed
和wathcer
等属性做了初始化操作。这里我们重点分析props
和data
,对于其它属性的初始化我们之后再详细分析。
initProps
,如下所示:
function initProps (vm: Component, propsOptions: Object) {
const propsData = vm.$options.propsData || {}
const props = vm._props = {}
// cache prop keys so that future props updates can iterate using Array
// instead of dynamic object key enumeration.
const keys = vm.$options._propKeys = []
const isRoot = !vm.$parent
// root instance props should be converted
if (!isRoot) {
toggleObserving(false)
}
for (const key in propsOptions) {
keys.push(key)
const value = validateProp(key, propsOptions, propsData, vm)
/* istanbul ignore else */
if (process.env.NODE_ENV !== 'production') {
const hyphenatedKey = hyphenate(key)
if (isReservedAttribute(hyphenatedKey) ||
config.isReservedAttr(hyphenatedKey)) {
warn(
`"${hyphenatedKey}" is a reserved attribute and cannot be used as component prop.`,
vm
)
}
defineReactive(props, key, value, () => {
if (vm.$parent && !isUpdatingChildComponent) {
warn(
`Avoid mutating a prop directly since the value will be ` +
`overwritten whenever the parent component re-renders. ` +
`Instead, use a data or computed property based on the prop's ` +
`value. Prop being mutated: "${key}"`,
vm
)
}
})
} else {
defineReactive(props, key, value)
}
// static props are already proxied on the component's prototype
// during Vue.extend(). We only need to proxy props defined at
// instantiation here.
if (!(key in vm)) {
proxy(vm, `_props`, key)
}
}
toggleObserving(true)
}
props
的初始化主要过程,就是遍历定义的props
配置。遍历的过程主要做两件事情:一个是调用defineReactive
方法把每个prop
对应的值变成响应式,可以通过vm._props.xxx
访问到定义props
中对应的属性。对于defineReactive
方法,我们稍后会介绍;另一个是通过proxy
把vm._props.xxx
的访问代理到vm.xxx
上,我们稍后也会介绍。
initData
,如下所示:
function initData (vm: Component) {
let data = vm.$options.data
data = vm._data = typeof data === 'function'
? getData(data, vm)
: data || {}
if (!isPlainObject(data)) {
data = {}
process.env.NODE_ENV !== 'production' && warn(
'data functions should return an object:\n' +
'https://vuejs.org/v2/guide/components.html#data-Must-Be-a-Function',
vm
)
}
// proxy data on instance
const keys = Object.keys(data)
const props = vm.$options.props
const methods = vm.$options.methods
let i = keys.length
while (i--) {
const key = keys[i]
if (process.env.NODE_ENV !== 'production') {
if (methods && hasOwn(methods, key)) {
warn(
`Method "${key}" has already been defined as a data property.`,
vm
)
}
}
if (props && hasOwn(props, key)) {
process.env.NODE_ENV !== 'production' && warn(
`The data property "${key}" is already declared as a prop. ` +
`Use prop default value instead.`,
vm
)
} else if (!isReserved(key)) {
proxy(vm, `_data`, key)
}
}
// observe data
observe(data, true /* asRootData */)
}
data
的初始化主要过程也是做两件事,一个是对定义data
函数返回对象的遍历,通过proxy
把每一个值vm._data.xxx
都代理到vm.xxx
上;另一个是调用observe
方法观测整个data
的变化,把data
也变成响应式,可以通过vm._data.xxx
访问到定义data
返回函数中对应的属性,observe
后面会介绍。可以看到,无论是props
或是data
的初始化都是把它们变成响应式对象,这个过程我们接触到几个函数,接下来我们来详细分析它们。
proxy
,首先介绍一下代理,代理的作用是把props
和data
上的属性代理到vm
实例上,这也就是为什么比如我们定义了如下props
,却可以通过vm
实例访问到它,如下所示:
let comP = {
props: {
msg: 'hello'
},
methods: {
say() {
console.log(this.msg)
}
}
}
我们可以在
say
函数中通过this.msg
访问到我们定义在props
中的msg
,这个过程发生在proxy
阶段:
const sharedPropertyDefinition = {
enumerable: true,
configurable: true,
get: noop,
set: noop
}
export function proxy (target: Object, sourceKey: string, key: string) {
sharedPropertyDefinition.get = function proxyGetter () {
return this[sourceKey][key]
}
sharedPropertyDefinition.set = function proxySetter (val) {
this[sourceKey][key] = val
}
Object.defineProperty(target, key, sharedPropertyDefinition)
}
-
proxy
方法的实现很简单,通过Object.defineProperty
把target[sourceKey][key]
的读写变成了对target[key]
的读写。所以对于props
而言,对vm._props.xxx
的读写变成了vm.xxx
的读写,而对于vm._props.xxx
我们可以访问到定义在props
中的属性,所以我们就可以通过vm.xxx
访问到定义在props
中的xxx
属性了。同理,对于data
而言,对vm._data.xxxx
的读写变成了对vm.xxxx
的读写,而对于vm._data.xxxx
我们可以访问到定义在data
函数返回对象中的属性,所以我们就可以通过vm.xxxx
访问到定义在data
函数返回对象中的xxxx
属性了。 -
observe
,observe
的功能就是用来监测数据的变化,它的定义在src/core/observer/index.js
中:
/**
* Attempt to create an observer instance for a value,
* returns the new observer if successfully observed,
* or the existing observer if the value already has one.
*/
export function observe (value: any, asRootData: ?boolean): Observer | void {
if (!isObject(value) || value instanceof VNode) {
return
}
let ob: Observer | void
if (hasOwn(value, '__ob__') && value.__ob__ instanceof Observer) {
ob = value.__ob__
} else if (
shouldObserve &&
!isServerRendering() &&
(Array.isArray(value) || isPlainObject(value)) &&
Object.isExtensible(value) &&
!value._isVue
) {
ob = new Observer(value)
}
if (asRootData && ob) {
ob.vmCount++
}
return ob
}
observe
方法的作用就是给非 VNode 的对象类型数据添加一个Observer
,如果已经添加过则直接返回,否则在满足一定条件下去实例化一个Observer
对象实例。接下来我们来看一下Observer
的作用。
Observer
,Observer
是一个类,它的作用是给对象的属性添加getter
和setter
,用于依赖收集和派发更新:
/**
* Observer class that is attached to each observed
* object. Once attached, the observer converts the target
* object's property keys into getter/setters that
* collect dependencies and dispatch updates.
*/
export class Observer {
value: any;
dep: Dep;
vmCount: number; // number of vms that has this object as root $data
constructor (value: any) {
this.value = value
this.dep = new Dep()
this.vmCount = 0
def(value, '__ob__', this)
if (Array.isArray(value)) {
const augment = hasProto
? protoAugment
: copyAugment
augment(value, arrayMethods, arrayKeys)
this.observeArray(value)
} else {
this.walk(value)
}
}
/**
* Walk through each property and convert them into
* getter/setters. This method should only be called when
* value type is Object.
*/
walk (obj: Object) {
const keys = Object.keys(obj)
for (let i = 0; i < keys.length; i++) {
defineReactive(obj, keys[i])
}
}
/**
* Observe a list of Array items.
*/
observeArray (items: Array<any>) {
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
}
Observer
的构造函数逻辑很简单,首先实例化Dep
对象,这块稍后会介绍,接着通过执行def
函数把自身实例添加到数据对象value
的__ob__
属性上,def
的定义在src/core/util/lang.js
中:
/**
* Define a property.
*/
export function def (obj: Object, key: string, val: any, enumerable?: boolean) {
Object.defineProperty(obj, key, {
value: val,
enumerable: !!enumerable,
writable: true,
configurable: true
})
}
def
函数是一个非常简单的Object.defineProperty
的封装,这就是为什么我在开发中输出data
上对象类型的数据,会发现该对象多了一个__ob__
的属性。
-
回到
Observer
的构造函数,接下来会对value
做判断,对于数组会调用observeArray
方法,否则对纯对象调用walk
方法。可以看到observeArray
是遍历数组再次调用observe
方法,而walk
方法是遍历对象的 key 调用defineReactive
方法,那么我们来看一下这个方法是做什么的。 -
defineReactive
,defineReactive
的功能就是定义一个响应式对象,给对象动态添加getter
和setter
,它的定义在src/core/observer/index.js
中:
/**
* Define a reactive property on an Object.
*/
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 = getter ? getter.call(obj) : val
if (Dep.target) {
dep.depend()
if (childOb) {
childOb.dep.depend()
if (Array.isArray(value)) {
dependArray(value)
}
}
}
return value
},
set: function reactiveSetter (newVal) {
const value = getter ? getter.call(obj) : val
/* eslint-disable no-self-compare */
if (newVal === value || (newVal !== newVal && value !== value)) {
return
}
/* eslint-enable no-self-compare */
if (process.env.NODE_ENV !== 'production' && customSetter) {
customSetter()
}
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
childOb = !shallow && observe(newVal)
dep.notify()
}
})
}
-
defineReactive
函数最开始初始化Dep
对象的实例,接着拿到obj
的属性描述符,然后对子对象递归调用observe
方法,这样就保证了无论obj
的结构多复杂,它的所有子属性也能变成响应式的对象,这样我们访问或修改obj
中一个嵌套较深的属性,也能触发getter
和setter
。最后利用Object.defineProperty
去给obj
的属性key
添加getter
和setter
。 -
总结:这里介绍了响应式对象,核心就是利用
Object.defineProperty
给数据添加了getter
和setter
,目的就是为了在我们访问数据以及写数据的时候能自动执行一些逻辑:getter
做的事情是依赖收集,setter
做的事情是派发更新。
三、依赖收集
- 了解
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 = 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<Watcher>;
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<Dep>;
newDeps: Array<Dep>;
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 = 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.deps
和this.newDeps
表示Watcher
实例持有的Dep
实例的数组;而this.depIds
和this.newDepIds
分别代表this.deps
和this.newDeps
的id
Set(这个 Set 是 ES6 的数据结构,它的实现在src/core/util/env.js
中)。Watcher
还定义了一些原型的方法,和依赖收集相关的有get
、addDep
和cleanupDeps
方法。 -
过程分析,当对数据对象的访问会触发他们的
getter
方法,那么这些对象什么时候被访问呢?在Vue
的mount
过程是通过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 = 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
订阅到这个数据持有的dep
的subs
中,这个目的是为后续数据变化时候能通知到哪些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()
- 了解到
Vue
有依赖收集的过程,但分析依赖清空的过程,其实这是会忽视的一点,也是Vue
考虑特别细的一点,如下所示:
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
在构造函数中会初始化两个Dep
实例数组,newDeps
表示新添加的Dep
实例数组,而deps
表示上一次添加的Dep
实例数组。在执行cleanupDeps
函数的时候,会首先遍历deps
,移除对dep.subs
数组中Wathcer
的订阅,然后把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
数据的依赖收集过程已经有了认识,并且对这其中的一些细节做了分析。收集依赖的目的是为了当这些响应式数据发生变化,触发它们的setter
的时候,能知道应该通知哪些订阅者去做相应的逻辑处理,我们把这个过程叫派发更新,其实Watcher
和Dep
就是一个非常经典的观察者设计模式的实现。
四、派发更新
- 响应式数据依赖收集过程,收集的目的就是为了当我们修改数据的时候,可以对相关的依赖派发更新,那么详细分析这个过程,回顾一下
setter
部分的逻辑:
/**
* Define a reactive property on an Object.
*/
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,
// ...
set: function reactiveSetter (newVal) {
const value = getter ? getter.call(obj) : val
/* eslint-disable no-self-compare */
if (newVal === value || (newVal !== newVal && value !== value)) {
return
}
/* eslint-enable no-self-compare */
if (process.env.NODE_ENV !== 'production' && customSetter) {
customSetter()
}
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
childOb = !shallow && observe(newVal)
dep.notify()
}
})
}
setter 的逻辑有 2 个关键的点,一个是
childOb = !shallow && observe(newVal)
,如果shallow
为 false 的情况,会对新设置的值变成一个响应式对象;另一个是dep.notify()
,通知所有的订阅者,接下来会完整的分析整个派发更新的过程。
- 过程分析,当我们在组件中对响应的数据做了修改,就会触发
setter
的逻辑,最后调用dep.notify()
方法,
它是Dep
的一个实例方法,定义在src/core/observer/dep.js
中:
class Dep {
// ...
notify () {
// stabilize the subscriber list first
const subs = this.subs.slice()
for (let i = 0, l = subs.length; i < l; i++) {
subs[i].update()
}
}
}
这里的逻辑非常简单,遍历所有的
subs
,也就是Watcher
的实例数组,然后调用每一个watcher
的update
方法,它的定义在src/core/observer/watcher.js
中:
class Watcher {
// ...
update () {
/* istanbul ignore else */
if (this.computed) {
// A computed property watcher has two modes: lazy and activated.
// It initializes as lazy by default, and only becomes activated when
// it is depended on by at least one subscriber, which is typically
// another computed property or a component's render function.
if (this.dep.subs.length === 0) {
// In lazy mode, we don't want to perform computations until necessary,
// so we simply mark the watcher as dirty. The actual computation is
// performed just-in-time in this.evaluate() when the computed property
// is accessed.
this.dirty = true
} else {
// In activated mode, we want to proactively perform the computation
// but only notify our subscribers when the value has indeed changed.
this.getAndInvoke(() => {
this.dep.notify()
})
}
} else if (this.sync) {
this.run()
} else {
queueWatcher(this)
}
}
}
这里对于
Watcher
的不同状态,会执行不同的逻辑,computed
和sync
等状态的分析,在一般组件数据更新的场景,会走到最后一个queueWatcher(this)
的逻辑,queueWatcher
的定义在src/core/observer/scheduler.js
中:
const queue: Array<Watcher> = []
let has: { [key: number]: ?true } = {}
let waiting = false
let flushing = false
/**
* Push a watcher into the watcher queue.
* Jobs with duplicate IDs will be skipped unless it's
* pushed when the queue is being flushed.
*/
export function queueWatcher (watcher: Watcher) {
const id = watcher.id
if (has[id] == null) {
has[id] = true
if (!flushing) {
queue.push(watcher)
} else {
// if already flushing, splice the watcher based on its id
// if already past its id, it will be run next immediately.
let i = queue.length - 1
while (i > index && queue[i].id > watcher.id) {
i--
}
queue.splice(i + 1, 0, watcher)
}
// queue the flush
if (!waiting) {
waiting = true
nextTick(flushSchedulerQueue)
}
}
}
-
这里引入了一个队列的概念,这也是
Vue
在做派发更新的时候的一个优化的点,它并不会每次数据改变都触发watcher
的回调,而是把这些watcher
先添加到一个队列里,然后在nextTick
后执行flushSchedulerQueue
。这里有几个细节要注意一下,首先用has
对象保证同一个Watcher
只添加一次;接着对flushing
的判断;最后通过waiting
保证对nextTick(flushSchedulerQueue)
的调用逻辑只有一次,另外nextTick
的实现后面会分析,目前就可以理解它是在下一个tick
,也就是异步的去执行flushSchedulerQueue
。 -
接下来我们来看
flushSchedulerQueue
的实现,它的定义在src/core/observer/scheduler.js
中,如下所示:
let flushing = false
let index = 0
/**
* Flush both queues and run the watchers.
*/
function flushSchedulerQueue () {
flushing = true
let watcher, id
// Sort queue before flush.
// This ensures that:
// 1. Components are updated from parent to child. (because parent is always
// created before the child)
// 2. A component's user watchers are run before its render watcher (because
// user watchers are created before the render watcher)
// 3. If a component is destroyed during a parent component's watcher run,
// its watchers can be skipped.
queue.sort((a, b) => a.id - b.id)
// do not cache length because more watchers might be pushed
// as we run existing watchers
for (index = 0; index < queue.length; index++) {
watcher = queue[index]
if (watcher.before) {
watcher.before()
}
id = watcher.id
has[id] = null
watcher.run()
// in dev build, check and stop circular updates.
if (process.env.NODE_ENV !== 'production' && has[id] != null) {
circular[id] = (circular[id] || 0) + 1
if (circular[id] > MAX_UPDATE_COUNT) {
warn(
'You may have an infinite update loop ' + (
watcher.user
? `in watcher with expression "${watcher.expression}"`
: `in a component render function.`
),
watcher.vm
)
break
}
}
}
// keep copies of post queues before resetting state
const activatedQueue = activatedChildren.slice()
const updatedQueue = queue.slice()
resetSchedulerState()
// call component updated and activated hooks
callActivatedHooks(activatedQueue)
callUpdatedHooks(updatedQueue)
// devtool hook
/* istanbul ignore if */
if (devtools && config.devtools) {
devtools.emit('flush')
}
}
这里有几个重要的逻辑要梳理一下,对于一些分支逻辑如
keep-alive
组件相关和之前提到过的updated
钩子函数的执行会略过。
- 队列排序,
queue.sort((a, b) => a.id - b.id)
对队列做了从小到大的排序,这么做主要有以下要确保以下几点:
- 组件的更新由父到子;因为父组件的创建过程是先于子的,所以
watcher
的创建也是先父后子,执行顺序也应该保持先父后子。 - 用户的自定义
watcher
要优先于渲染watcher
执行;因为用户自定义watcher
是在渲染watcher
之前创建的。 - 如果一个组件在父组件的
watcher
执行期间被销毁,那么它对应的watcher
执行都可以被跳过,所以父组件的watcher
应该先执行。
- 队列遍历,在对
queue
排序后,接着就是要对它做遍历,拿到对应的watcher
,执行watcher.run()
。这里需要注意一个细节,在遍历的时候每次都会对queue.length
求值,因为在watcher.run()
的时候,很可能用户会再次添加新的watcher
,这样会再次执行到queueWatcher
,如下:
export function queueWatcher (watcher: Watcher) {
const id = watcher.id
if (has[id] == null) {
has[id] = true
if (!flushing) {
queue.push(watcher)
} else {
// if already flushing, splice the watcher based on its id
// if already past its id, it will be run next immediately.
let i = queue.length - 1
while (i > index && queue[i].id > watcher.id) {
i--
}
queue.splice(i + 1, 0, watcher)
}
// ...
}
}
可以看到,这时候
flushing
为 true,就会执行到 else 的逻辑,然后就会从后往前找,找到第一个待插入watcher
的 id 比当前队列中watcher
的 id 大的位置。把watcher
按照id
的插入到队列中,因此queue
的长度发生了变化。
- 状态恢复,这个过程就是执行
resetSchedulerState
函数,它的定义在src/core/observer/scheduler.js
中,如下所示:
const queue: Array<Watcher> = []
let has: { [key: number]: ?true } = {}
let circular: { [key: number]: number } = {}
let waiting = false
let flushing = false
let index = 0
/**
* Reset the scheduler's state.
*/
function resetSchedulerState () {
index = queue.length = activatedChildren.length = 0
has = {}
if (process.env.NODE_ENV !== 'production') {
circular = {}
}
waiting = flushing = false
}
逻辑非常简单,就是把这些控制流程状态的一些变量恢复到初始值,把
watcher
队列清空。
- 接下来我们继续分析
watcher.run()
的逻辑,它的定义在src/core/observer/watcher.js
中,如下所示:
class Watcher {
/**
* Scheduler job interface.
* Will be called by the scheduler.
*/
run () {
if (this.active) {
this.getAndInvoke(this.cb)
}
}
getAndInvoke (cb: Function) {
const value = this.get()
if (
value !== this.value ||
// Deep watchers and watchers on Object/Arrays should fire even
// when the value is the same, because the value may
// have mutated.
isObject(value) ||
this.deep
) {
// set new value
const oldValue = this.value
this.value = value
this.dirty = false
if (this.user) {
try {
cb.call(this.vm, value, oldValue)
} catch (e) {
handleError(e, this.vm, `callback for watcher "${this.expression}"`)
}
} else {
cb.call(this.vm, value, oldValue)
}
}
}
}
-
run
函数实际上就是执行this.getAndInvoke
方法,并传入watcher
的回调函数。getAndInvoke
函数逻辑也很简单,先通过this.get()
得到它当前的值,然后做判断,如果满足新旧值不等、新值是对象类型、deep
模式任何一个条件,则执行watcher
的回调,注意回调函数执行的时候会把第一个和第二个参数传入新值value
和旧值oldValue
,这就是当我们添加自定义watcher
的时候能在回调函数的参数中拿到新旧值的原因。 -
那么对于渲染
watcher
而言,它在执行this.get()
方法求值的时候,会执行getter
方法:
updateComponent = () => {
vm._update(vm._render(), hydrating)
}
所以这就是当我们去修改组件相关的响应式数据的时候,会触发组件重新渲染的原因,接着就会重新执行
patch
的过程,但它和首次渲染有所不同。
- 总结:对
Vue
数据修改派发更新的过程也有了认识,实际上就是当数据发生变化的时候,触发setter
逻辑,把在依赖过程中订阅的的所有观察者,也就是watcher
,都触发它们的update
过程,这个过程又利用了队列做了进一步优化,在nextTick
后执行所有watcher
的run
,最后执行它们的回调函数。nextTick
是Vue
一个比较核心的实现了。