Vue.js 源码分析三：深入响应式原理

本文分析的 Vue 源码版本是 2.6.10

上一节我们讲到了 initState,如果还不熟悉可以参考之前写的一篇文章 《Vue.js 源码分析二：initState 原理》,这一节我们重点聊一下 Vue.js 核心的响应式原理。

在 vue.js 官网上有一句话写的是:

当你把一个普通的 JavaScript 对象传入 Vue 实例作为 data 选项，Vue 将遍历此对象所有的属性，并使用 Object.defineProperty 把这些属性全部转为 getter/setter。

接下来我们了解一下 object.defineProperty

Object.defineProperty

Object.defineProperty() 方法会直接在一个对象上定义一个新属性，或者修改一个对象的现有属性， 并返回这个对象。

我们来看看它的语法：

Object.defineProperty(obj, prop, descriptor)

在这里我们只需要关心 descriptor的 get 和 set,

• get

  一个给属性提供 getter 的方法，如果没有 getter 则为 undefined。当访问该属性时，该方法会被执行，方法执行时没有参数传入，但是会传入this对象（由于继承关系，这里的this并不一定是定义该属性的对象）。

• set

  一个给属性提供 setter 的方法，如果没有 setter 则为 undefined。当属性值修改时，触发执行该方法。该方法将接受唯一参数，即该属性新的参数值。

举一个🌰：

let obj = {}
let initValue = 'hello'
Object.defineProperty(obj,"key",{
    get(){
        console.log('触发get函数')
        //当获取值的时候触发的函数
        return initValue;    
    },
    set(val){
        console.log('触发set函数:',val)
        //当设置值的时候触发的函数,设置的新值通过参数value拿到
        initValue = val;
    }
});
//获取值
console.log( obj.key );  //hello

//设置值
obj.key = 'change value';

console.log( obj.key ); //change value

现在我们了解了 object.defineProperty 的 get 是一个给属性提供 getter 方法 ，当我们访问该属性时会触发getter方法;set是给属性提供一个 setter 方法，当我们修改该属性时会触发 setter 方法。

下面我们从源码的角度分析 vue 的响应式原理。

observe

在 Vue 实例化过程中， 在 initData 方法中调用了 observe(data, true /* asRootData */)

function initData (vm: Component) {
  ...
  // observe data
  observe(data, true /* asRootData */)
}

src/core/observer/index.js中：

export function observe (value: any, asRootData: ?boolean): Observer | void {
  // 如果传入的参数不是对象或者是VNode，直接返回
  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
  ) {
    // 实例化 Observer 对象
    ob = new Observer(value)
  }
  if (asRootData && ob) {
    ob.vmCount++
  }
  return ob
}

observe 方法的作用就是给非 VNode 的对象类型数据添加一个 Observer，如果已经添加过则直接返回，否则在满足一定条件下去实例化一个 Observer 对象实例。接下来我们来看一下 Observer 的作用。

Observer

Observer 是一个类，它的作用是给对象的属性添加 getter 和 setter，用于依赖收集和派发更新。

src/core/observer/index.js中：

/**
 * 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 have 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)) {
      // 如过有原型 __proto__
      if (hasProto) {
        protoAugment(value, arrayMethods)
      } else {
        copyAugment(value, arrayMethods, arrayKeys)
      }
      // observe 数组
      this.observeArray(value)
    } else {
      this.walk(value)
    }
  }

  /**
   * Walk through all properties 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函数把自身实例（this）添加到数据对象 value 和 __ob__属性上
• 判断 value类型 ，对数组调用 observeArray（遍历数组再次调用observe） 方法，对纯对象调用 walk方法。
• walk调用 definReactive方法

接下来我们一起看一下 def 和 definReactive 背后发生了什么？

def

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
  })
}

defineReactive

defineReactive 的作用是给对象定义响应式属性。

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
) {
  // 创建 Dep 实例，用来收集依赖
  const dep = new Dep()
	
  // 获取 obj 对象的属性描述
  const property = Object.getOwnPropertyDescriptor(obj, key)
  // 如果 obj 对象属性描述不可更改
  if (property && property.configurable === false) {
    return
  }
	
	// 如果之前该对象已经预设了getter以及setter函数则将其取出来，新定义的getter/setter中会将其执行，保证不会覆盖之前已经定义的getter/setter
  // 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]
  }
  
  // 对象的子对象递归进行observe并返回子节点的Observer对象
  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()
        if (childOb) {
          // 子对象进行依赖收集
          childOb.dep.depend()
          // 如果 val 值是数组
          if (Array.isArray(value)) {
            // 对数组每一个值都进行依赖收集
            dependArray(value)
          }
        }
      }
      return value
    },
    set: function reactiveSetter (newVal) {
      // 通过 getter 方法获取当前值，与新值进行比较，一致则不需要执行下面的操作
      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()
      }
      // #7981: for accessor properties without setter
      if (getter && !setter) return
      if (setter) {
        // 如果 obj 原本拥有 setter 方法则执行原本 setter
        setter.call(obj, newVal)
      } else {
        val = newVal
      }
			// 新的值需要重新进行observe，保证数据响应式
      childOb = !shallow && observe(newVal)
      // 通知所有订阅者，内部调用 watcher 的 update 方法
      dep.notify()
    }
  })
}

defineReactive 函数最开始初始化 Dep 对象的实例，接着拿到 obj 的属性描述符，然后对子对象递归调用 observe 方法，这样就保证了无论 obj 的结构多复杂，它的所有子属性也能变成响应式的对象，这样我们访问或修改 obj 中一个嵌套较深的属性，也能触发 getter 和 setter。最后利用 Object.defineProperty 去给 obj 的属性 key 添加 getter 和 setter。

其中 getter 方法：

1. 先为每个 data 声明一个 Dep 实例对象，被用于 getter 时执行 dep.depend() 进行收集相关的依赖

2. 根据 Dep.target 来判断是否收集依赖，还是普通取值

其中 setter 方法中:

1. 获取新的值并且进行 observe，保证数据响应式
2. 执行 dep.notify() 通知所有订阅者更新数据，从而达到响应式

总结

响应式对象核心就是利用 Object.defineProperty 给数据添加了 getter 和 setter，目的就是为了在我们访问数据以及写数据的时候能自动执行一些逻辑：getter 做的事情是依赖收集，setter 做的事情是派发更新