# vue源码 数据代理和响应式

reactivity

how does vue track changes?

# 数据驱动和变化侦测

  • UI = render(state)
    • vue = render
    • wrap it
    onstateChange(()=>{
      view = render(state )
    }) 
    
  • vue would convert your state objs to beacome reactive

# 两种代理方法

  • Object.defineProperty
    • 普通对象
      • getter/setter进行数据监听
      • 访问o.a时会触发getter的钩子,修改o.a属性时会触发setter钩子去修改返回的结果
      • getter 中收集依赖
      • setter 中通知依赖更新
    • 数组
      • 因为索引值没有预先加进数据拦截,无法拦截
    • 局限
      • 无法检测对象property的增加和删除
      • 无法检测数组的变化,索引和长度改变都检测不到
    • 其他,见js对象属性
  • proxy
    • 针对目标对象创建一个新的实例对象,并将目标对象代理到新的实例对象上
    • 所以操作心得实例就可以改变真正操控的目标对象
    • 代码
    let obj = {}
    let nobj = new proxy(obj,{
        get(target, key, receiver){
            return reflect.get(taret, key, receiver)
        },
        set(target, key, receiver){
            return reflect.set(target, key, velue, receiver)
        }
    })
    nobj.a = 'yiki'
    nobj.push(3);
    
    
  • 关于reflect
    • 将用于对象的一些内部方法放到reflect对象里

# 响应式先走个入口 initState

  • /src/core/instance/state.js
/**
 * 两件事:
 *   数据响应式的入口:分别处理 props、methods、data、computed、watch
 *   优先级:props、methods、data、computed 对象中的属性不能出现重复,优先级和列出顺序一致
 *         其中 computed 中的 key 不能和 props、data 中的 key 重复,methods 不影响
 */
export function initState (vm: Component) {
  vm._watchers = []
  const opts = vm.$options
  if (opts.props) initProps(vm, opts.props)
  // 处理 methos 对象,校验每个属性的值是否为函数、和 props 属性比对进行判重处理,最后得到 vm[key] = methods[key]
  if (opts.methods) initMethods(vm, opts.methods)
  if (opts.data) {
    initData(vm)
  } else {
    observe(vm._data = {}, true 
  }
  if (opts.computed) initComputed(vm, opts.computed)
  if (opts.watch && opts.watch !== nativeWatch) {
    initWatch(vm, opts.watch)
  }
  /**
   * computed 和 watch 在本质是没有区别的,都是通过 watcher 去实现的响应式
   * 非要说有区别,那也只是在使用方式上的区别,简单来说:
   *   1、watch:适用于当数据变化时执行异步或者开销较大的操作时使用,即需要长时间等待的操作可以放在 watch 中
   *   2、computed:其中可以使用异步方法,但是没有任何意义。所以 computed 更适合做一些同步计算
   */
}

# initProps

  • 处理 props 对象,为 props 对象的每个属性设置响应式,并将其代理到 vm 实例上
function initProps (vm: Component, propsOptions: Object) {
  const propsData = vm.$options.propsData || {}
  const props = vm._props = {}
  // 这里说的是缓存每个key为数组,性能优化,防止动态对象用枚举 歪?
  const keys = vm.$options._propKeys = []
 ...
  for (const key in propsOptions) {
    keys.push(key)
    const value = validateProp(key, propsOptions, propsData, vm)
    if (...)...{
    } else {
      defineReactive(props, key, value) // 响应式
    }
    if (!(key in vm)) {
      proxy(vm, `_props`, key)
    }
  }
}
  • proxy 可以通过vm.xx代理访问到vm._props的值
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)
}

# initData

  • 判重处理,data 对象上的属性不能和 props、methods 对象上的属性相同
  • 代理 data 对象上的属性到 vm 实例
  • 为 data 对象的上数据设置响应式
function initData (vm: Component) {
  let data = vm.$options.data
  ...
  let i = keys.length
  while (i--) {//判重
    const key = keys[i]
    ...
      if (methods && hasOwn(methods, key)) {
        warn(
          `Method "${key}" has already been defined as a data property.`,
          vm
        )
      }
    }
    if (props && hasOwn(props, key)) {//data不能和props重名
     ...
        `The data property "${key}" is already declared as a prop. ` +
   ...
    } else if (!isReserved(key)) {
      proxy(vm, `_data`, key)
    }
  }
  // observe data
  observe(data, true /* asRootData */)// 响应式
}

# initComputed

  • computed 可以是对象,也可以是函数
  • 但对象必须有 getter
  • 针对 computed 需要实例化一个 watcherwatcher 代表需要被监听的数据依赖
  • initComputed() 将每个属性设置成响应式的数据,并且也会做命名冲突检测
function initComputed (vm: Component, computed: Object) {
  const watchers = vm._computedWatchers = Object.create(null)
  const isSSR = isServerRendering()
  for (const key in computed) { //判重
    const userDef = computed[key]
    const getter = typeof userDef === 'function' ? userDef : userDef.get
    if (process.env.NODE_ENV !== 'production' && getter == null) {//getter不能少
     ...
    }
    if (!isSSR) {
      watchers[key] = new Watcher( //给个watcher
        vm,
        getter || noop,
        noop,
        computedWatcherOptions // 默认懒加载
      )
    }
    if (!(key in vm)) {
      defineComputed(vm, key, userDef)// 代理 computed属性到vm上,可以用vm.cptkey访问到计算属性
    } else if (process.env.NODE_ENV !== 'production') {
      if (key in vm.$data) { // 重名冲突
      ...
    }
  }
}
  • defineComputed
export function defineComputed (
 ...  // 可以是对象,也可以是函数
  if (typeof userDef === 'function') {
    sharedPropertyDefinition.get = shouldCache
      ? createComputedGetter(key)
      : createGetterInvoker(userDef)
    sharedPropertyDefinition.set = noop
  } else {
    ...同上
  }
  if (process.env.NODE_ENV !== 'production' &&
      sharedPropertyDefinition.set === noop) {
    sharedPropertyDefinition.set = function () {
      warn(
        `Computed property "${key}" was assigned to but it has no setter.`,
        this
      )
    }
  }
  //拦截 target.key的访问
  Object.defineProperty(target, key, sharedPropertyDefinition)
}
  • createComputedGetter 所以要知道computed的响应式是通过watcher的
function createComputedGetter (key) {
  return function computedGetter () {
    const watcher = this._computedWatchers && this._computedWatchers[key]
    if (watcher) {
      if (watcher.dirty) { // dirty 缓存标识, 两次computed只会执行一次
        watcher.evaluate() // 这个进去就是把  dirty = false
      }
      if (Dep.target) {
        watcher.depend()
      }
      return watcher.value
    }
  }
}

# initWatch

  • 为 每个 watch.key 创建 watcher 实例,key 和 watcher 实例可能是 一对多 的关系
  • 如果设置了 immediate,则立即执行 回调函数
function initWatch (vm: Component, watch: Object) {
  for (const key in watch) {
    const handler = watch[key]
    if (Array.isArray(handler)) {
      for (let i = 0; i < handler.length; i++) {
        createWatcher(vm, key, handler[i])
      }
    } else {
      createWatcher(vm, key, handler)
    }
  }
}
  • createWatcher 兼容+调用vm.$watch
function createWatcher (
  vm: Component,
  expOrFn: string | Function,
  handler: any,
  options?: Object
) {
  if (isPlainObject(handler)) {
    options = handler
    handler = handler.handler
  }
  if (typeof handler === 'string') {
    handler = vm[handler]
  }
  return vm.$watch(expOrFn, handler, options)
}
  • $watchstateMixin
  Vue.prototype.$watch = function (
  ...
  ): Function {
    const vm: Component = this
    if (isPlainObject(cb)) { // 判断是不是对象
      return createWatcher(vm, expOrFn, cb, options)
    }
    options = options || {}
    options.user = true
    const watcher = new Watcher(vm, expOrFn, cb, options)
    if (options.immediate) { // 立即执行一次回调
      const info = `callback for immediate watcher "${watcher.expression}"`
      pushTarget()
      invokeWithErrorHandling(cb, vm, [watcher.value], vm, info)
      popTarget()
    }
    return function unwatchFn () { // 解除监听
      watcher.teardown()
    }
  }

# 三者关系

  • 这里我要说一下,new watcher出现在updatecomponent里面,也就是说每个实例都有自己的watcher,当它访问响应式数据的时候,就一定会走get去获取数据,这个时候就会把自己的watcher添加进这个响应式数据的dep[]数组里,但是这个数据肯定不止一个地方访问它,所以每个响应式数据的dep里可以有多个watcher
  • 所以set的时候,响应式数据可以通过它的dep去通知dep里面的watcher去做视图更新
  • 当然这个更新和异步队列有关,后面有写
{
  obj:{
    a:1,
    __ob__:{ //Observer 实例
        dep:{Dep 实例
            subs:[ //存放 Watcher 实例
              new Watcher(),
            ]
        }
    }
  }
}
  • 对于watcher
const obj = {
  a: 1,
  b: {
    c: 2
  }
}

new Observer(obj)
new Watcher(obj, 'a', () => {
  console.log('Watcher 回调执行')
})
obj.a='222'

# Observer

  • /core/observer/index.js
  • 观察者模式
  • Observer类本类哈哈
/**
 * 观察者类,会被附加到每个被观察的对象上,value.__ob__ = this
 * 而对象的各个属性则会被转换成 getter/setter,并收集依赖和通知更新
 */
export class Observer {
  value: any;
  dep: Dep;
  vmCount: number; // number of vms that have this object as root $data
  constructor (value: any) {
    this.value = value
    this.dep = new Dep() // 会实例化一个dep
    this.vmCount = 0
    def(value, '__ob__', this) // 给value ob标示
    if (Array.isArray(value)) { // 如果是数组,覆盖数组七个原型方法来实现响应式 
      if (hasProto) {
        protoAugment(value, arrayMethods)
      } else {
        copyAugment(value, arrayMethods, arrayKeys)
      }
      this.observeArray(value)
    } else {
      this.walk(value)
    }
  }
  • def 给value ob标示
export function def (obj: Object, key: string, val: any, enumerable?: boolean) {
  Object.defineProperty(obj, key, {
    value: val,
    enumerable: !!enumerable,
    writable: true,
    configurable: true
  })
}
  • walkobserveArray
  /**
   * 遍历对象上的每个 key,为每个 key 设置defineReactive响应式
   * 仅当值为对象时才会走这里
   */
  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]) // 给数组每一项给个观察
    }
  }
}
  • observe 将数据对象添加一个不可枚举的属性_ob_,标识为响应式对象
export function observe (value: any, asRootData: ?boolean): Observer | void {
 ...
  let ob: Observer | void
  if (hasOwn(value, '__ob__') && value.__ob__ instanceof Observer) {
    ob = value.__ob__ // 已经存在的就会返回
  } else if (
   ...一些判断
  ) {
    ob = new Observer(value) // 创建观察者实例
  }
  ...
  return ob
}
  • defineReactive
    • reactive property on an Object
    • 本质 Object.defineProperty
    • 读取 get的时候依赖收集,如render生成dom的时候会有读取操作
    • 更新 set的时候设置新值并通知依赖更新
export function defineReactive (...) {
  ...
const dep = new Dep() // 一个key一个dep
const property = Object.getOwnPropertyDescriptor(obj, key)

const getter = property && property.get
const setter = property && property.set
    ...
let childOb = !shallow && observe(val) // 递归调用
// 核心!
Object.defineProperty(obj, key, {
    enumerable: true,
    configurable: true,
    get: function reactiveGetter () { // 是在getter阶段进行依赖收集
    const value = getter ? getter.call(obj) : val
    // 依赖收集 
    if (Dep.target) {
        dep.depend() //  Dep.target.addDep(this)
        if (childOb) {
        childOb.dep.depend()
        if (Array.isArray(value)) {
            dependArray(value) // 数组的时候
        }
        }
    }
    return value
    },
    set: function reactiveSetter (newVal) {
      if (getter && !setter) return //这里会比较下新老值
      if (setter) {
        setter.call(obj, newVal)
      } else {
        val = newVal //设置新值
      }
    childOb = !shallow && observe(newVal)
    dep.notify() // 派发更新
    }
})
}
  • dependArray 只能遍历然后给每个数组元素添加依赖啦
/**
 * Collect dependencies on array elements when the array is touched, since
 * we cannot intercept array element access like property getters.
 */
function dependArray (value: Array<any>) {
  for (let e, i = 0, l = value.length; i < l; i++) {
    e = value[i]
    e && e.__ob__ && e.__ob__.dep.depend()
    if (Array.isArray(e)) {
      dependArray(e)
    }
  }
}

# Dep

  • 依赖管理 /core/observer/dep.js
  • 一个value-key 对应 一个 dep, dep里面可以有多个watcher哦
/**
 * 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>;
 ...
  depend () { // 依赖收集
    if (Dep.target) { 
      Dep.target.addDep(this)
    }
  }
  notify () { //派发更新
   ...
    for (let i = 0, l = subs.length; i < l; i++) {
      subs[i].update() // 遍历后更新
    }
  }
}
// dep.target表示正在执行的watcher
Dep.target = null
const targetStack = []
export function pushTarget (target: ?Watcher) { // 通过这个完成赋值
  targetStack.push(target)
  Dep.target = target
}
export function popTarget () { //通过这个完成重置
  targetStack.pop()
  Dep.target = targetStack[targetStack.length - 1]
}

# Watcher

  • /core/observer/watcher.js
  • 一个组件/表达式一个都会有各自对应的 watcher
  • constructor
constructor (
    vm: Component,
    expOrFn: string | Function,
    cb: Function,
    options?: ?Object,
    isRenderWatcher?: boolean
  ) {
    this.vm = vm
    if (isRenderWatcher) {
      vm._watcher = this
    }
    vm._watchers.push(this)
    ...
    this.dirty = this.lazy // for lazy watchers
    this.deps = []
    this.newDeps = []
    this.depIds = new Set()
    this.newDepIds = new Set()
     ...
    }
    this.value = this.lazy // 计算属性的标志
      ? undefined
      : this.get()// 最终调用这里进行状态更新
  }
  • get() 会重新进行依赖收集
    • 为什么要重新收集依赖?
    • 因为触发更新说明有响应式数据被更新了,但是被更新的数据虽然已经经过 observe 观察了,但是却没有进行依赖收集,
    • 所以,在更新页面时,会重新执行一次 render 函数,执行期间会触发读取操作,这时候进行依赖收集
  get () {
    pushTarget(this)
    let value
    const vm = this.vm
    try {
      value = this.getter.call(vm, vm) //patch 
    } catch (e) {
     ...
      if (this.deep) {
        traverse(value)
      }
      popTarget()
      this.cleanupDeps()// 依赖清除
    }
    return value
  }
Last Updated: 2022/6/26 上午11:43:14