你想要的 vue 源码分析 · 14

思考

<div id="app" @click="changeMsg">
  {{ message }}
</div>

var app = new Vue({
  el: '#app',
  data: {
    message: 'Hello Vue!'
  },
  methods: {
    changeMsg() {
      this.message = 'Hello World!';
    }
  }
});

实现效果：点击 div，修改 dom，背后隐藏的问题

修改哪块的 dom
修改效率与性能是否最优
是否每次的数据变化都要操作 dom
是否逐项去修改 dom

响应式对象的定义

vue2.x 实现响应式的核心是用了 ES5 的 Object.defineProperty(obj, prop, descriptor)，Object.defineProperty(obj, prop, descriptor)的第三个参数提供了 set 和 get 键值，当获取对象属性时触发 getter 方法，当设置属性时触发 setter 方法，一旦对象拥有了 setter 和 getter，这个对象就可以称为响应式对象。

响应式的核心是利用 Object.defineProperty 给数据添加 setter 和 getter，如果对象的子属性是一个对象，则会递归把该对象变成响应式，目的就是读取数据的时候自动执行一些逻辑，getter 做的是依赖收集，setter 做的是派发更新。

vue 把 props 和 data 中的属性添加一个__ob__的 Observe 的指令，变成了响应式对象，Observer 是一个类，作用是给对象属性添加 getter 和 setter，用于依赖收集和派发更新，__ob__是不可枚举的

核心方法

initState

// src/core/instance/state.js
// initState方法主要是对props，methods，data，computed，watcher等属性做了初始化
export function initState(vm: Component) {
  vm._watchers = [];
  const opts = vm.$options;
  // 初始化props
  if (opts.props) initProps(vm, opts.props);
  if (opts.methods) initMethods(vm, opts.methods);
  // 初始化data
  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

// src/core/instance/state.js
// 遍历定义的props配置：主要做两件事情
//  一、调用 defineReactive 方法把每个props变成响应式，可以通过vm._props.xxx访问到定义的props中定义的属性
// 二、通过proxy把vm._props.xxx的访问代理到vm.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变成响应式，可以通过vm.props.xxx访问到定义的props中定义的属性
      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);
    }
    // 二、通过proxy把vm.props.xxx的访问代理到vm.xxx上
    if (!(key in vm)) {
      proxy(vm, `_props`, key);
    }
  }
  toggleObserving(true);
}

initData

// src/core/instance/state.js
// 遍历定义的props配置：主要做两件事情
// 一、对定义的data函数返回对象的遍历，通过proxy把每一个值vm._data.xxx都代理到vm.xxx上
// 二、调用oberve方法观测整个data的变化，把data也变成响应式，可以通过vm.data.xxx访问到定义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:\n' + '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)) {
      // 一、对定义的data函数返回对象的遍历，通过proxy把每一个值vm._data.xxx都代理到vm.xxx上
      proxy(vm, `_data`, key);
    }
  }
  // 二、调用oberve方法观测整个data的变化，把data也变成响应式，可以通过vm.data.xxx访问到定义data返回函数中对应的属性
  observe(data, true /* asRootData */);
}

Observer

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

// src/core/observer/index.js
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;
    // 先实例化Dep对象，
    this.dep = new Dep();
    this.vmCount = 0;
    // 执行def函数把自身实例添加到数据对象value的__ob__属性上
    // def是对Object.defineProperty 的封装
    // 变成不可枚举的，walk的时候不会遍历__ob__属性
    def(value, '__ob__', this);
    if (Array.isArray(value)) {
      const augment = hasProto ? protoAugment : copyAugment;
      augment(value, arrayMethods, arrayKeys);
      // 对于数据则会调用observeArray 方法
      // observeArray是遍历数组再次调用observe方法
      // observe 的作用是用来检测数据变化
      this.observeArray(value);
    } else {
      // 对纯对象调用 walk 方法
      // 遍历对象的key调用defineReactive
      // 对子对象递归调用observe 方法，保证了无论obj的子属性嵌套对象有多深，obj的子属性也能变成响应式对象，也能触发setter和getter
      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<any>) {
    for (let i = 0, l = items.length; i < l; i++) {
      observe(items[i]);
    }
  }
}

核心方法中的共用方法

proxy

代理的作用：把 props 和 data 上的属性代理到 vm 实例上

// src/core/instance/state.js
// 通过Object.defineProperty把target[source][key]读写变成了target[key]的读写，比如把vm._props.xxx读写改成了vm.xxx的读写，可以通过vm.xxx 访问到定义在 props中的 xxx 属性，同理,对 vm._data.xxx 的读写变成了对 vm.xxx 的读写，而对于 vm._data.xxx 我们可以访问到定义在 data 函数返回对象中的属性
const sharedPropertyDefinition = {
  enumerable: true,
  configurable: true,
  get: noop,
  set: noop
};

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[source][key]读写变成了target[key]的读写
  Object.defineProperty(target, key, sharedPropertyDefinition);
}

observe

oberve 的作用是给非 Vnode 对象添加一个 Observer,然后在满足一定条件下实例化一个 Observer 对象实例

// src/core/observer/index.js
// oberve的作用是给非Vnode对象添加一个Observer,然后在满足一定条件下实例化一个Observer对象实例
export function observe(value: any, asRootData: ?boolean): Observer | void {
  if (!isObject(value) || value instanceof VNode) {
    return;
  }
  let ob: Observer | void;
  // 如果已经有了__ob__，并且value.__ob__是实例Observer的私有变量，就retrun当前对象的__ob__，并且这个对象已经不可枚举了
  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;
}

def

对 Object.defineProperty 的封装

// src/core/util/lang.js
export function def(obj: Object, key: string, val: any, enumerable?: boolean) {
  Object.defineProperty(obj, key, {
    value: val,
    enumerable: !!enumerable,
    writable: true,
    configurable: true
  });
}

defineReactive

定义了一个响应式对象，给对象动态添加 getter 和 setter

// src/core/observer/index.js
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);
  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];
  }

  // 对子对象递归调用observe 方法，保证了无论obj的子属性嵌套对象有多深，obj的子属性也能变成响应式对象，也能触发setter和getter
  let childOb = !shallow && observe(val);
  // 最后利用Object.defineProperty给obj的属性key添加getter和setter
  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();
    }
  });
}