Vue响应式原理之defineReactive
defineReactive
不论如何,最终响应式数据都要通过defineReactive
来实现,实际要借助ES5新增的Object.defineProperty
。
defineReactive
接受五个参数。obj
是要添加响应式数据的对象;key
是属性名,val
是属性名对应的取值;customSetter
是用户自定义的setter;会在响应式数据的setter中执行,只有开发环境可用;通过shallow
指定是否浅比较,默认深比较。
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
}
const getter = property && property.get
if (!getter && arguments.length === 2) {
val = obj[key]
}
const setter = property && property.set
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()
}
})
}
在函数内,首先实例化一个Dep实例dep
,dep
会在稍后添加为响应式数据自定义的get/set中发挥作用。接着获取属性描述符,如果属性不可配置,则无法调用Object.defineProperty
来修改setter/getter,所以返回。
如果原来已设置过setter/getter,缓存起来。当未自定义getter且arguments
长度为2(即只传入了obj
和key
)时,可以直接用方括号求值,使用闭包变量val
缓存初始值。
如果不是浅复制,执行observe(val)
,为val添加__ob__
属性并返回__ob__
指向的Observer实例。(只有数组和对象才可能是响应式,才能返回Observer实例)。
使用Object.defineProperty
为obj[key]
设置getter和setter。
在get
内,如果原来已设置过getter,则用缓存的getter求值,否则使用闭包变量val
作为返回值;同时添加依赖。此处为两个Dep实例添加依赖。dep
是闭包变量,在getter/setter中会使用到。另一个Dep实例是childOb.dep
,只用调用set/delete
更新响应式数据时,才会触发;如果value
是数组,还会遍历元素,为存在__ob__
属性的元素收集依赖。
在set
内,先获取更新前的值(逻辑和get
内第一步一样)。判断更新前后的值是否相等,相等时直接返回;不等时,如果有缓存的setter,调用缓存的setter更新,否则直接赋值。值得注意的是,NaN === NaN
是不成立的,反而NaN !== NaN
是成立的,后面的判断语句newVal !== newVal && value !== value
就是为了避免newVal/val
都是NaN
。在更新后的值newVal
上执行observe
,更新闭包变量childOb
,并调用notify。