欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Vue源码学习之关于对Array的数据侦听实现

程序员文章站 2023-12-03 08:23:52
摘要 我们都知道vue的响应式是通过object.defineproperty来进行数据劫持。但是那是针对object类型可以实现, 如果是数组呢? 通过set/...

摘要

我们都知道vue的响应式是通过object.defineproperty来进行数据劫持。但是那是针对object类型可以实现, 如果是数组呢? 通过set/get方式是不行的。

但是vue作者使用了一个方式来实现array类型的监测: 拦截器。

核心思想

通过创建一个拦截器来覆盖数组本身的原型对象array.prototype。

拦截器

通过查看vue源码路径vue/src/core/observer/array.js。

/**
 * vue对数组的变化侦测
 * 思想: 通过一个拦截器来覆盖array.prototype。
 * 拦截器其实就是一个object, 它的属性与array.prototype一样。 只是对数组的变异方法进行了处理。
*/

function def (obj, key, val, enumerable) {
  object.defineproperty(obj, key, {
   value: val,
   enumerable: !!enumerable,
   writable: true,
   configurable: true
  })
}

// 数组原型对象
const arrayproto = array.prototype
// 拦截器
const arraymethods = object.create(arrayproto)

// 变异数组方法:执行后会改变原始数组的方法
const methodstopatch = [
  'push',
  'pop',
  'shift',
  'unshift',
  'splice',
  'sort',
  'reverse'
]

methodstopatch.foreach(function (method) {
  // 缓存原始的数组原型上的方法
  const original = arrayproto[method]
  // 对每个数组编译方法进行处理(拦截)
  def(arraymethods, method, function mutator (...args) {
   // 返回的value还是通过数组原型方法本身执行的结果
   const result = original.apply(this, args)
   // 每个value在被observer()时候都会打上一个__ob__属性
   const ob = this.__ob__
   // 存储调用执行变异数组方法导致数组本身值改变的数组,主要指的是原始数组增加的那部分(需要重新observer)
   let inserted
   switch (method) {
    case 'push':
    case 'unshift':
     inserted = args
     break
    case 'splice':
     inserted = args.slice(2)
     break
   }
   // 重新observe新增加的数组元素
   if (inserted) ob.observearray(inserted)
   // 发送变化通知
   ob.dep.notify()
   return result
  })
})

关于vue什么时候对data属性进行observer

如果熟悉vue源码的童鞋应该很快能找到vue的入口文件vue/src/core/instance/index.js。

function vue (options) {
 if (process.env.node_env !== 'production' &&
  !(this instanceof vue)
 ) {
  warn('vue is a constructor and should be called with the `new` keyword')
 }
 this._init(options)
}

initmixin(vue)
// 给原型绑定代理属性$props, $data
// 给vue原型绑定三个实例方法: vm.$watch,vm.$set,vm.$delete
statemixin(vue)
// 给vue原型绑定事件相关的实例方法: vm.$on, vm.$once ,vm.$off , vm.$emit
eventsmixin(vue)
// 给vue原型绑定生命周期相关的实例方法: vm.$forceupdate, vm.destroy, 以及私有方法_update
lifecyclemixin(vue)
// 给vue原型绑定生命周期相关的实例方法: vm.$nexttick, 以及私有方法_render, 以及一堆工具方法
rendermixin(vue)

export default vue

this.init()

源码路径: vue/src/core/instance/init.js。

export function initmixin (vue: class<component>) {
 vue.prototype._init = function (options?: object) {
  // 当前实例
  const vm: component = this
  // a uid
  // 实例唯一标识
  vm._uid = uid++

  let starttag, endtag
  /* istanbul ignore if */
  // 开发模式, 开启vue性能检测和支持 performance.mark api 的浏览器上。
  if (process.env.node_env !== 'production' && config.performance && mark) {
   starttag = `vue-perf-start:${vm._uid}`
   endtag = `vue-perf-end:${vm._uid}`
   // 处于组件初始化阶段开始打点
   mark(starttag)
  }

  // a flag to avoid this being observed
  // 标识为一个vue实例
  vm._isvue = true
  // merge options
  // 把我们传入的optionsmerge到$options
  if (options && options._iscomponent) {
   // optimize internal component instantiation
   // since dynamic options merging is pretty slow, and none of the
   // internal component options needs special treatment.
   initinternalcomponent(vm, options)
  } else {
   vm.$options = mergeoptions(
    resolveconstructoroptions(vm.constructor),
    options || {},
    vm
   )
  }
  /* istanbul ignore else */
  if (process.env.node_env !== 'production') {
   initproxy(vm)
  } else {
   vm._renderproxy = vm
  }
  // expose real self
  vm._self = vm
  // 初始化生命周期
  initlifecycle(vm)
  // 初始化事件中心
  initevents(vm)
  initrender(vm)
  callhook(vm, 'beforecreate')
  initinjections(vm) // resolve injections before data/props
  // 初始化state
  initstate(vm)
  initprovide(vm) // resolve provide after data/props
  callhook(vm, 'created')

  /* istanbul ignore if */
  if (process.env.node_env !== 'production' && config.performance && mark) {
   vm._name = formatcomponentname(vm, false)
   mark(endtag)
   measure(`vue ${vm._name} init`, starttag, endtag)
  }
  // 挂载
  if (vm.$options.el) {
   vm.$mount(vm.$options.el)
  }
 }
}

initstate()

源码路径:vue/src/core/instance/state.js。

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

这个时候你会发现observe出现了。

observe

源码路径: vue/src/core/observer/index.js

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) {
  // value已经是一个响应式数据就不再创建observe实例, 避免重复侦听
  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
}

使用拦截器的时机

vue的响应式系统中有个observe类。源码路径:vue/src/core/observer/index.js。

// can we use __proto__?
export const hasproto = '__proto__' in {}

const arraykeys = object.getownpropertynames(arraymethods)

function protoaugment (target, src: object) {
 /* eslint-disable no-proto */
 target.__proto__ = src
 /* eslint-enable no-proto */
}

function copyaugment (target: object, src: object, keys: array<string>) {
 // target: 需要被observe的对象
 // src: 数组代理原型对象
 // keys: const arraykeys = object.getownpropertynames(arraymethods)
 // keys: 数组代理原型对象上的几个编译方法名
 // const methodstopatch = [
 //  'push',
 //  'pop',
 //  'shift',
 //  'unshift',
 //  'splice',
 //  'sort',
 //  'reverse'
 // ]
 for (let i = 0, l = keys.length; i < l; i++) {
  const key = keys[i]
  def(target, key, src[key])
 }
}

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)) {
   if (hasproto) {
    // 如果支持__proto__属性(非标属性, 大多数浏览器支持): 直接把原型指向代理原型对象
    protoaugment(value, arraymethods)
   } else {
    // 不支持就在数组实例上挂载被加工处理过的同名的变异方法(且不可枚举)来进行原型对象方法拦截
    // 当你访问一个对象的方法时候, 只有当自身不存在时候才会去原型对象上查找
    copyaugment(value, arraymethods, arraykeys)
   }
   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])
  }
 }

 /**
  * 遍历数组每一项来进行侦听变化,即每个元素执行一遍observer()
  */
 observearray (items: array<any>) {
  for (let i = 0, l = items.length; i < l; i++) {
   observe(items[i])
  }
 }
}

如何收集依赖

vue里面真正做数据响应式处理的是definereactive()。 definereactive方法就是把对象的数据属性转为访问器属性, 即为数据属性设置get/set。

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


export function definereactive (
 obj: object,
 key: string,
 val: any,
 customsetter?: ?function,
 shallow?: boolean
) {
 // dep在访问器属性中闭包使用
 // 每一个数据字段都通过闭包引用着属于自己的 dep 常量
 // 每个字段的dep对象都被用来收集那些属于对应字段的依赖。
 const dep = new dep()

 // 获取该字段可能已有的属性描述对象
 const property = object.getownpropertydescriptor(obj, key)
 // 边界情况处理: 一个不可配置的属性是不能使用也没必要使用 object.defineproperty 改变其属性定义的。
 if (property && property.configurable === false) {
  return
 }

 // 由于一个对象的属性很可能已经是一个访问器属性了,所以该属性很可能已经存在 get 或 set 方法
 // 如果接下来会使用 object.defineproperty 函数重新定义属性的 setter/getter
 // 这会导致属性原有的 set 和 get 方法被覆盖,所以要将属性原有的 setter/getter 缓存
 const getter = property && property.get
 const setter = property && property.set
 // 边界情况处理
 if ((!getter || setter) && arguments.length === 2) {
  val = obj[key]
 }
 // 默认就是深度观测,引用子属性的__ob__
 // 为vue.set 或 vue.delete 方法提供触发依赖。
 let childob = !shallow && observe(val)
 object.defineproperty(obj, key, {
  enumerable: true,
  configurable: true,
  get: function reactivegetter () {
   // 如果 getter 存在那么直接调用该函数,并以该函数的返回值作为属性的值,保证属性的原有读取操作正常运作
   // 如果 getter 不存在则使用 val 作为属性的值
   const value = getter ? getter.call(obj) : val
   // dep.target的值是在对watch实例化时候赋值的
   if (dep.target) {
    // 开始收集依赖到dep
    dep.depend()
    if (childob) {
     childob.dep.depend()
     if (array.isarray(value)) {
      // 调用 dependarray 函数逐个触发数组每个元素的依赖收集
      dependarray(value)
     }
    }
   }
   // 正确地返回属性值。
   return value
  },
  set: function reactivesetter (newval) {
   // 获取原来的值
   const value = getter ? getter.call(obj) : val
   /* eslint-disable no-self-compare */
   // 比较新旧值是否相等, 考虑nan情况
   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
   // 如果数据之前有setter, 那么应该继续使用该函数来设置属性的值
   if (setter) {
    setter.call(obj, newval)
   } else {
    // 赋新值
    val = newval
   }
   // 由于属性被设置了新的值,那么假如我们为属性设置的新值是一个数组或者纯对象,
   // 那么该数组或纯对象是未被观测的,所以需要对新值进行观测
   childob = !shallow && observe(newval)
   // 通知dep中的watcher更新
   dep.notify()
  }
 })
}

存储数组依赖的列表

我们为什么需要把依赖存在observer实例上。 即

export class observer {
  constructor (value: any) {
    ...
    this.dep = new dep()
  }
}

首先我们需要在getter里面访问到observer实例

// 即上述的
let childob = !shallow && observe(val)
...
if (childob) {
 // 调用observer实例上dep的depend()方法收集依赖
 childob.dep.depend()
 if (array.isarray(value)) {
  // 调用 dependarray 函数逐个触发数组每个元素的依赖收集
  dependarray(value)
 }
}

另外我们在前面提到的拦截器中要使用observer实例。

methodstopatch.foreach(function (method) {
  ...
  // this表示当前被操作的数据
  // 但是__ob__怎么来的?
  const ob = this.__ob__
  ...
  // 重新observe新增加的数组元素
  if (inserted) ob.observearray(inserted)
  // 发送变化通知
  ob.dep.notify()
  ...
})

思考上述的this.__ob__属性来自哪里?

export class observer {
  constructor () {
    ...
    this.dep = new dep()
    // 在vue上新增一个不可枚举的__ob__属性, 这个属性的值就是observer实例
    // 因此我们就可以通过数组数据__ob__获取observer实例
    // 进而获取__ob__上的dep
    def(value, '__ob__', this)
    ...
  }
}

牢记所有的属性一旦被侦测了都会被打上一个__ob__的标记, 即表示是响应式数据。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。