Vueソース分析の応答式オブジェクト(八)

29339 ワード

Vueの最大の特徴は、データ応答式であり、データを変更するとビューが更新されるため、データに焦点を当てるだけで、ビューを変更する方法にあまり注目する必要はありません.Vueのデータ応答は主にES 5中のObjectを通過する.defineProperty()で実装され、具体的にどのように実装されているのか、ソースコードの観点から分析してみましょう.
まず,初期化の過程でVueはdataとpropsの属性に応答式を加える.new Vueの過程でinitState(vm)関数が実行され、この関数は'core/instance/state.js'で定義されています
この関数の主な機能はprops,methods,data,computedなどを初期化することであることがわかる.ここではまず注目しましょう
export function initState (vm: Component) {
  vm._watchers = []
  const opts = vm.$options
  if (opts.props) initProps(vm, opts.props)
  if (opts.methods) initMethods(vm, opts.methods)
  if (opts.data) {
    initData(vm)
  } else {
    observe(vm._data = {}, true /* asRootData */)
  }
  if (opts.computed) initComputed(vm, opts.computed)
  if (opts.watch && opts.watch !== nativeWatch) {
    initWatch(vm, opts.watch)
  }
}

InitPropsでは、主にvmインスタンスのpropsを取得し、propsを検証します.同時にdefineReactive()関数を用いてpropsの値に応答式を実現する.最後にエージェントproxyを使用してthis.vm.xxx代理到this.xxx、ユーザーのアクセスを便利にします.
function initProps (vm: Component, propsOptions: Object) {
  const propsData = vm.$options.propsData || {}
  const props = vm._props = {}
  // cache prop keys so that future props updates can iterate using Array
  // instead of dynamic object key enumeration.
  const keys = vm.$options._propKeys = []
  const isRoot = !vm.$parent
  // root instance props should be converted
  if (!isRoot) {
    toggleObserving(false)
  }
  for (const key in propsOptions) {
    keys.push(key)
    const value = validateProp(key, propsOptions, propsData, vm)
    /* istanbul ignore else */
    if (process.env.NODE_ENV !== 'production') {
      const hyphenatedKey = hyphenate(key)
      if (isReservedAttribute(hyphenatedKey) ||
          config.isReservedAttr(hyphenatedKey)) {
        warn(
          `"${hyphenatedKey}" is a reserved attribute and cannot be used as component prop.`,
          vm
        )
      }
      defineReactive(props, key, value, () => {
        if (vm.$parent && !isUpdatingChildComponent) {
          warn(
            `Avoid mutating a prop directly since the value will be ` +
            `overwritten whenever the parent component re-renders. ` +
            `Instead, use a data or computed property based on the prop's ` +
            `value. Prop being mutated: "${key}"`,
            vm
          )
        }
      })
    } else {
      defineReactive(props, key, value)
    }
    // static props are already proxied on the component's prototype
    // during Vue.extend(). We only need to proxy props defined at
    // instantiation here.
    if (!(key in vm)) {
      proxy(vm, `_props`, key)
    }
  }
  toggleObserving(true)
}

InitDataでは、まずdataについて判断し、次にdataの属性がpropsやmethodsの名前と同じかどうかを比較し、ある場合は警告を投げ出す.最後にproxy関数を用いてdataをエージェントし、thisを用いる.xxxはpropsのプロパティにアクセスでき、最後にobserve関数を使用してdataのデータを観察します.
function initData (vm: Component) {
  let data = vm.$options.data
  data = vm._data = typeof data === 'function'
    ? getData(data, vm)
    : data || {}
  if (!isPlainObject(data)) {
    data = {}
    process.env.NODE_ENV !== 'production' && warn(
      'data functions should return an object:
' + 'https://vuejs.org/v2/guide/components.html#data-Must-Be-a-Function', vm ) } // proxy data on instance const keys = Object.keys(data) const props = vm.$options.props const methods = vm.$options.methods let i = keys.length while (i--) { const key = keys[i] if (process.env.NODE_ENV !== 'production') { if (methods && hasOwn(methods, key)) { warn( `Method "${key}" has already been defined as a data property.`, vm ) } } if (props && hasOwn(props, key)) { process.env.NODE_ENV !== 'production' && warn( `The data property "${key}" is already declared as a prop. ` + `Use prop default value instead.`, vm ) } else if (!isReserved(key)) { proxy(vm, `_data`, key) } } // observe data observe(data, true /* asRootData */) }

observe関数は'core/observer/indexで定義する.js'では,伝達されたvalue値に対して,まずオブジェクトかVNodeかのインスタンスを判断し,オブジェクトかVNodeかのインスタンスでなければ直接返す.
そして、その対象が'_であるか否かを判断するob__'属性およびその属性がOberserverクラスのインスタンスであるかどうか,そうであればobに割り当て,最後にobを返す.そうでない場合、valueは配列ではなく、オブジェクトではなく、valueは拡張可能ではありません.はい、Observerクラスを作成します.
export function observe (value: any, asRootData: ?boolean): Observer | void {
  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
  ) {
    ob = new Observer(value)
  }
  if (asRootData && ob) {
    ob.vmCount++
  }
  return ob
}

Observerクラスはどのような機能を果たしていますか.コンストラクション関数で属性を初期化し、def関数を使用してthis(すなわちobオブジェクト)をvalue(すなわちdataオブジェクト)に定義します.ここでなぜdef関数を使用してvalue['_ob_']=thisを直接使用しないのですか?理由は_ob__応答式ではないので、次のwalk関数でvalueのプロパティを巡回する必要はありませんので、emurableをfalse(!!undefined)に設定します.
次にvauleオブジェクトが配列であるかどうかを判断し,そうであればobserveArray関数,そうでなければwalk関数を呼び出す.
walk関数では、オブジェクト内の各属性に対してdefineReactive関数を呼び出して応答式を実現する機能が主に完了します.
observeArray関数では、配列に配列がある可能性があるため、主に配列の各値に対してobserve関数を呼び出します.
export class Observer {
  value: any;
  dep: Dep;
  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
    def(value, '__ob__', this)
    if (Array.isArray(value)) {
      const augment = hasProto
        ? protoAugment
        : copyAugment
      augment(value, arrayMethods, arrayKeys)
      this.observeArray(value)
    } else {
      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)
    for (let i = 0; i < keys.length; i++) {
      defineReactive(obj, keys[i])
    }
  }

  /**
   * Observe a list of Array items.
   */
  observeArray (items: Array) {
    for (let i = 0, l = items.length; i < l; i++) {
      observe(items[i])
    }
  }
}
export function def (obj: Object, key: string, val: any, enumerable?: boolean) {
  Object.defineProperty(obj, key, {
    value: val,
    enumerable: !!enumerable,
    writable: true,
    configurable: true
  })
}

最後にdefineReactive関数でどのような機能が完了しているかを見てみましょう.まずその属性の記述子を取得し,その属性のconfigurableがfalseであるか否かを判断し,もしそうであればそのまま返す.
次に、属性記述子のgetterとsetterが得られ、入力されたパラメータが2つしかない場合、その属性に対応する値がvalに与えられる.val呼び出しobserve関数を再帰的に観察した.プロパティのgetとsetを同時に設定し、主に依存する収集と配布の更新を完了します.具体的な内容は後で分析します.
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
  }

  // 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]
  }

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

まとめ
propsとdataを応答処理する場合,主に属性に対してdefineReactive関数を呼び出す.
dataの場合、observe関数が呼び出され、dataに属性が応答的に処理されたか否かが判断され、__が追加されるob__属性、なければObserverクラスをインスタンス化します.このクラスでは、_ob__プロパティをマウントします.また,属性値のタイプも判断し,配列であればobeserve関数を呼び出し,各値のリスニングを実現する.そうでなければ、defineReactive関数を直接呼び出します.
defindeReactive関数では、属性値に対してobserve関数も呼び出されます.どうしてですか.想像してみてください.最初はdataに対してobserve関数を直接呼び出しますが、dataはオブジェクトであり、配列ではありません.したがって、defineReactive関数は直接呼び出されますが、dataオブジェクトには配列があり、オブジェクトがある可能性があります.したがって、defineReactiveではobserve関数を呼び出して各属性を応答的に初期化します.