vue源碼解讀（一）Observer/Dep/Watcher是如何實現數據綁定的

時間 2019-12-30

標籤 vue 源碼解讀 observer dep watcher 如何實現數據綁定欄目 Hadoop 简体版

原文原文鏈接

介紹

歡迎star個人github倉庫，共同窗習~目前vue源碼學習系列已經更新了4篇啦~

https://github.com/yisha0307/...

最近在學習vue和vuex的源碼，記錄本身的一些學習心得。主要借鑑了染陌同窗的《Vue.js 源碼解析》和DMQ的mvvm。前者對vue和vuex的源碼作了註解和詳細的中文doc，後者剖析了vue的實現原理，手動實現了mvvm。javascript

個人記錄主要是本身的一些對vue源碼的理解，若是想要看更系統的介紹，仍是推薦上面列的兩位大神的工程~html

文章中引用的代碼的英文註釋是尤大的，中文註釋一些是染陌的，一些是個人補充理解。可能有理解不對的地方，歡迎評論指出或者給個人github提issue。感謝~vue

數據綁定原理

正如尤大在vue的教程深刻響應式原理裏寫的那樣，Vue內部主要靠劫持Object.defineProperty()的getter和setter方法，在每次get數據的時候注入依賴，在set數據的時候發佈消息給訂閱者，從而實現DOM的更新。由於Object.defineProperty()沒有辦法在IE8或者更低版本的瀏覽器中實現，因此Vue是不能支持這些瀏覽器的。java

看一下官網提供的圖片：react

在組件渲染操做的時候("Touch"), 觸發Data中的getter（會保證只有用到的data纔會觸發依賴，看了源碼以後，實際上是每個Data的key對應的value都會有一個Dep, 收集一組subs<Array: Watcher>），在更新數據的時候，觸發setter, 經過Dep.notify()通知全部的subs進行更新，watcher又經過回調函數通知組件進行更新，經過virtual DOM和diff計算實現optimize, 完成re-render。git

在整個源碼當中，比較重要的幾個概念就是Observer/Dep/Watcher。下面主要分析一下這三類的處理。github

Observer

Observer的做用是對整個Data進行監聽，在initData這個初始方法裏使用observe(data),Observer類內部經過defineReactive方法劫持data的每個屬性的getter和setter。看一下源碼：vuex

export function observe (value: any, asRootData: ?boolean): Observer | void {
  /*判斷Data是不是一個對象*/
  if (!isObject(value)) {
    return
  }
  let ob: Observer | void

  /*這裏用__ob__這個屬性來判斷是否已經有Observer實例，若是沒有Observer實例則會新建一個Observer實例並賦值給__ob__這個屬性，若是已有Observer實例則直接返回該Observer實例*/
  if (hasOwn(value, '__ob__') && value.__ob__ instanceof Observer) {
    ob = value.__ob__
  } else if (
    /*這裏的判斷是爲了確保value是單純的對象，而不是函數或者是Regexp等狀況。*/
    observerState.shouldConvert &&
    !isServerRendering() &&
    (Array.isArray(value) || isPlainObject(value)) &&
    Object.isExtensible(value) &&
    !value._isVue
  ) {
    // 建立一個Observer實例，綁定data進行監聽
    ob = new Observer(value)
  }
  if (asRootData && ob) {

    /*若是是根數據則計數，後面Observer中的observe的asRootData非true*/
    ob.vmCount++
  }
  return ob
}

Vue的響應式數據都會有一個__ob__做爲標記，裏面存放了Observer實例，防止重複綁定。express

再看一下Observer類的源碼:數組

/**
 * Observer class that are attached to each observed
 * object. Once attached, the observer converts target
 * object's property keys into getter/setters that
 * collect dependencies and dispatches updates.
 */
export class  {
  value: any;
  dep: Dep; // 每個Data的屬性都會綁定一個dep，用於存放watcher arr
  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

    /*
        /vue-src/core/util/lang.js:
        function def (obj: Object, key: string, val: any, enumerable?: boolean) {
            Object.defineProperty(obj, key, {
                value: val,
                enumerable: !!enumerable,
                writable: true,
                configurable: true
            })
        }
    */
    def(value, '__ob__', this) // 這個def的意思就是把Observer實例綁定到Data的__ob__屬性上去
    if (Array.isArray(value)) {

      /*
          若是是數組，將修改後能夠截獲響應的數組方法替換掉該數組的原型中的原生方法，達到監聽數組數據變化響應的效果。
      */
      const augment = hasProto
        ? protoAugment  /*直接覆蓋原型的方法來修改目標對象*/
        : copyAugment   /*定義（覆蓋）目標對象或數組的某一個方法*/
      augment(value, arrayMethods, arrayKeys)
      /*Github:https://github.com/answershuto*/
      /*若是是數組則須要遍歷數組的每個成員進行observe*/
      this.observeArray(value)
    } else {
      /*若是是對象則直接walk進行綁定*/
      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)

    /*
    walk方法會遍歷對象的每個屬性進行defineReactive綁定
    defineReactive: 劫持data的getter和setter
    */
    for (let i = 0; i < keys.length; i++) {
      defineReactive(obj, keys[i], obj[keys[i]])
    }
  }

  /**
   * Observe a list of Array items.
   */
  observeArray (items: Array<any>) {
    /*
    數組須要遍歷每個成員進行observe
    */
    for (let i = 0, l = items.length; i < l; i++) {
      observe(items[i])
    }
  }
}

能夠看到，Observer類主要乾了如下幾件事：

給data綁定一個__ob__屬性，用來存放Observer實例，避免重複綁定
若是data是Object, 遍歷對象的每個屬性進行defineReactive綁定
若是data是Array, 則須要對每個成員進行observe。vue.js會重寫Array的push、pop、shift、unshift、splice、sort、reverse這7個方法，保證以後pop/push等操做進去的對象也有進行雙向綁定. (具體代碼參見observer/array.js)

defineReactive()

如上述源碼所示，Observer類主要是靠遍歷data的每個屬性，使用defineReactive()方法劫持getter和setter方法, 下面來具體看一下defineReactive:

export function defineReactive (
  obj: Object,
  key: string,
  val: any,
  customSetter?: Function
) {
  /*在閉包中定義一個dep對象*/
  const dep = new Dep()

  const property = Object.getOwnPropertyDescriptor(obj, key)
  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

  /*對象的子對象也會進行observe*/
  let childOb = observe(val)
  Object.defineProperty(obj, key, {
    enumerable: true,
    configurable: true,
    get: function reactiveGetter () {
      /*若是本來對象擁有getter方法則執行*/
      const value = getter ? getter.call(obj) : val
    //   Dep.target：全局屬性，用於指向某一個watcher，用完即丟
      if (Dep.target) {
        /*
        進行依賴收集
        dep.depend()內部實現addDep，往dep中添加watcher實例 (具體參考Dep.prototype.depend的代碼)
        depend的時候會根據id判斷watcher有沒有添加過，避免重複添加依賴
        */
        dep.depend()
        if (childOb) {
          /*子對象進行依賴收集，其實就是將同一個watcher觀察者實例放進了兩個depend中，一個是正在自己閉包中的depend，另外一個是子元素的depend*/
          childOb.dep.depend()
        }
        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()
      }
      if (setter) {
        /*若是本來對象擁有setter方法則執行setter*/
        setter.call(obj, newVal)
      } else {
        val = newVal
      }
      /*新的值須要從新進行observe，保證數據響應式*/
      childOb = observe(newVal)
      /*dep對象通知全部的觀察者*/
      dep.notify()
    }
  })
}

defineReactive()方法主要經過Object.defineProperty()作了如下幾件事:

在閉包裏定義一個Dep實例；
getter用來收集依賴，Dep.target是一個全局的屬性，指向的那個watcher收集到dep裏來（若是以前添加過就不會重複添加）；
setter是在更新value的時候通知全部getter時候通知全部收集的依賴進行更新（dep.notify）。這邊會作一個判斷，若是newVal和oldVal同樣，就不會有操做。

Dep

在上面的defineReactive中提到了Dep，因而接下來看一下Dep的源碼, dep主要是用來在數據更新的時候通知watchers進行更新：

/**
 * 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++
    // subs: Array<Watcher>
    this.subs = []
  }

  /*添加一個觀察者對象*/
  addSub (sub: Watcher) {
    this.subs.push(sub)
  }

  /*移除一個觀察者對象*/
  removeSub (sub: Watcher) {
    remove(this.subs, sub)
  }

  /*依賴收集，當存在Dep.target的時候添加觀察者對象*/
//   在defineReactive的getter中會用到dep.depend()
  depend () {
    if (Dep.target) {
        // Dep.target指向的是一個watcher
      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++) {
        // 調用每個watcher的update
      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
/*依賴收集完須要將Dep.target設爲null，防止後面重複添加依賴。*/

Dep是一個發佈者，能夠訂閱多個觀察者，依賴收集以後Dep中會有一個subs存放一個或多個觀察者，在數據變動的時候通知全部的watcher。
再複習一下，Dep和Observer的關係就是Observer監聽整個data，遍歷data的每一個屬性給每一個屬性綁定defineReactive方法劫持getter和setter, 在getter的時候往Dep類裏塞依賴（dep.depend），在setter的時候通知全部watcher進行update(dep.notify)

Watcher

watcher接受到通知以後，會經過回調函數進行更新。

接下來咱們要仔細看一下watcher的源碼。由以前的Dep代碼可知的是，watcher須要實現如下兩個做用：

dep.depend()的時候往dep裏添加本身；
dep.notify()的時候調用watcher.update()方法，對視圖進行更新；

同時要注意的是，watcher有三種：render watcher/ computed watcher/ user watcher(就是vue方法中的那個watch)

export default class Watcher {
  vm: Component;
  expression: string; // 每個DOM attr對應的string
  cb: Function; // update的時候的回調函數
  id: number;
  deep: boolean;
  user: boolean;
  lazy: boolean;
  sync: boolean;
  dirty: boolean;
  active: boolean;
  deps: Array<Dep>;
  newDeps: Array<Dep>;
  depIds: ISet;
  newDepIds: ISet;
  getter: Function;
  value: any;

  constructor (
    vm: Component,
    expOrFn: string | Function,
    cb: Function,
    options?: Object
  ) {
    this.vm = vm
    /*_watchers存放訂閱者實例*/
    vm._watchers.push(this)
    // options
    if (options) {
      this.deep = !!options.deep
      this.user = !!options.user
      this.lazy = !!options.lazy
      this.sync = !!options.sync
    } else {
      this.deep = this.user = this.lazy = this.sync = false
    }
    this.cb = cb
    this.id = ++uid // uid for batching
    this.active = true
    this.dirty = this.lazy // for lazy 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
    /*把表達式expOrFn解析成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
        )
      }
    }
    this.value = this.lazy
      ? undefined
      : this.get()
  }

  /**
   * Evaluate the getter, and re-collect dependencies.
   */
   /*得到getter的值而且從新進行依賴收集*/
  get () {
    /*將自身watcher觀察者實例設置給Dep.target，用以依賴收集。*/
    pushTarget(this)
    let value
    const vm = this.vm

    /*
      執行了getter操做，看似執行了渲染操做，實際上是執行了依賴收集。
      在將Dep.target設置爲自身觀察者實例之後，執行getter操做。
      譬如說如今的的data中可能有a、b、c三個數據，getter渲染須要依賴a跟c，
      那麼在執行getter的時候就會觸發a跟c兩個數據的getter函數，
      在getter函數中便可判斷Dep.target是否存在而後完成依賴收集，
      將該觀察者對象放入閉包中的Dep的subs中去。
    */
    if (this.user) {
        // this.user: 判斷是否是vue中那個watch方法綁定的watcher
      try {
        value = this.getter.call(vm, vm)
      } catch (e) {
        handleError(e, vm, `getter for watcher "${this.expression}"`)
      }
    } else {
      value = this.getter.call(vm, vm)
    }
    // "touch" every property so they are all tracked as
    // dependencies for deep watching
    /*若是存在deep，則觸發每一個深層對象的依賴，追蹤其變化*/
    if (this.deep) {
      /*遞歸每個對象或者數組，觸發它們的getter，使得對象或數組的每個成員都被依賴收集，造成一個「深（deep）」依賴關係*/
      traverse(value)
    }

    /*將觀察者實例從target棧中取出並設置給Dep.target*/
    popTarget()
    this.cleanupDeps()
    return value
  }

  /**
   * Add a dependency to this directive.
   */
   /*添加一個依賴關係到Deps集合中*/
 //  在dep.depend()中調用的是Dep.target.addDep()
  addDep (dep: Dep) {
    const id = dep.id
    if (!this.newDepIds.has(id)) {
        // newDepIds和newDeps記錄watcher實例所用到的dep，好比某個computed watcher其實用到了data裏的a/b/c三個屬性，那就須要記錄3個dep
      this.newDepIds.add(id)
      this.newDeps.push(dep)
      if (!this.depIds.has(id)) {
        //  做用是往dep的subs裏添加本身（Watcher實例）
        //  可是會先判斷一下id，若是subs裏有相同的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
  }

  /**
   * Subscriber interface.
   * Will be called when a dependency changes.
   */
//   dep.notify的時候會逐個調用watcher的update方法
  update () {
    /* istanbul ignore else */
    if (this.lazy) {
      this.dirty = true
    } else if (this.sync) {
      /*同步則執行run直接渲染視圖*/
      // 基本不會用到sync
      this.run()
    } else {
      /*異步推送到觀察者隊列中，由調度者調用。*/
      queueWatcher(this)
    }
  }

  /**
   * Scheduler job interface.
   * Will be called by the scheduler.
   */
   /*
      調度者工做接口，將被調度者回調。
    */
  run () {
    if (this.active) {
      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.
        /*
            即使值相同，擁有Deep屬性的觀察者以及在對象／數組上的觀察者應該被觸發更新，由於它們的值可能發生改變。
        */
        isObject(value) ||
        this.deep
      ) {
        // set new value
        const oldValue = this.value
        /*設置新的值*/
        this.value = value

        /*觸發回調渲染視圖*/
        if (this.user) {
          try {
            this.cb.call(this.vm, value, oldValue)
          } catch (e) {
            handleError(e, this.vm, `callback for watcher "${this.expression}"`)
          }
        } else {
          this.cb.call(this.vm, value, oldValue)
        }
      }
    }
  }

  /**
   * Evaluate the value of the watcher.
   * This only gets called for lazy watchers.
   */
   /*獲取觀察者的值*/
  evaluate () {
    this.value = this.get()
    this.dirty = false
  }

  /**
   * Depend on all deps collected by this watcher.
   */
   /*收集該watcher的全部deps依賴*/
  depend () {
    let i = this.deps.length
    while (i--) {
      this.deps[i].depend()
    }
  }

  /**
   * Remove self from all dependencies' subscriber list.
   */
   /*將自身從全部依賴收集訂閱列表刪除*/
  teardown () {
    if (this.active) {
      // remove self from vm's watcher list
      // this is a somewhat expensive operation so we skip it
      // if the vm is being destroyed.
      /*從vm實例的觀察者列表中將自身移除，因爲該操做比較耗費資源，因此若是vm實例正在被銷燬則跳過該步驟。*/
      if (!this.vm._isBeingDestroyed) {
        remove(this.vm._watchers, this)
      }
      let i = this.deps.length
      while (i--) {
        this.deps[i].removeSub(this)
      }
      this.active = false
    }
  }
}

要注意的是，watcher中有個sync屬性，絕大多數狀況下，watcher並非同步更新的，而是採用異步更新的方式，也就是調用queueWatcher(this)推送到觀察者隊列當中，待nextTick的時候進行調用。