// 闭包存储的值
// dep 值的观察者集合
// getter/setter 值原先具有的 get/set
// val 传入的初始化值,或者原先的值,如果值默认带有 getter,但没有 setter 则为 undefined
// childOb 如果值还有子集合且当前环境支持深度挟持,则为子集的 observe
export function defineReactive (
obj: Object,
key: string,
val: any,
customSetter?: ?Function,
shallow?: boolean
) {
// 初始化依赖项,闭包存储
const dep = new Dep()
// 如果该值无法被修改则直接 return,configurable 代表这个值是否能被改变
const property = Object.getOwnPropertyDescriptor(obj, key)
if (property && property.configurable === false) {
return
}
// 获取该值上原有的 getter/setter,防止被覆盖导致失效,闭包存储
const getter = property && property.get
const setter = property && property.set
// (!getter || setter) 当有自定义 getter 并且没有 setter 的时候不对其进行深度响应式,
// 与下面 set 中的 if (getter && !setter) return 呼应。
// 没有传 val 则手动获取
if ((!getter || setter) && arguments.length === 2) {
val = obj[key]
}
// 如说是非深度响应式则值响应到这一层,反之默认向下递归,非深度响应式比如 $attrs、$listeners
// childOb 是指向的子集的 __ob__,主要用于 $set/$delete
let childOb = !shallow && observe(val) // 递归 observe
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
// 如果值没有发生实际变化或者前后值都为 NaN,则直接返回,不触发依赖更新(|| 后面的判断是为了兼容 NaN !== NaN 的情况)
if (newVal === value || (newVal !== newVal && value !== value)) {
return
}
// 如果在非生产且有自定义 setter,则触发,因为自定义 setter 往往是非法报错之类的信息,所以仅在非生产执行。
if (process.env.NODE_ENV !== 'production' && customSetter) {
customSetter()
}
// 只读的值不进行值的修改,开发者给一个值只设置了 getter,没设置 setter 的时候
// #7981: for accessor properties without setter
if (getter && !setter) return
// 如果有自定义 setter,则使用自定义 set,反之用默认的方式修改值
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
// 深度响应式的情况下,如果重新赋了一个新的子集则重新使其具备响应式
childOb = !shallow && observe(newVal)
// 通知依赖项
dep.notify()
}
})
}