Vue3 Reactivity

本章介绍Vue中另一个非常重要的模块，响应式。介绍了基本原理（含图）简单实现以及如何阅读源码。

致谢Vue Mastery非常好的课程，可以转载，但请声明源链接：文章源链接justin3go.com(有些latex公式某些平台不能渲染可查看这个网站)

Reactivity

作用

学习Vue3的响应式原理；
提高调试能力；
使用响应式这个模块进行一些骚操作；
为Vue做贡献

Vue是如何知道更新这些模板的呢？

当price发生改变，Vue知道怎么更新这些模板。

JavaScript并不会更新！

自己实现一个响应式原理

基本思路：当价格或者数量更新时，让它再跑一次；

// effct这个函数就是让total重新计算一次；
let effect = () => {total  = price * quantity}  // 缩短上述中间代码

let dep = new Set()  // 去储藏effect，保证不会添加重复值

其中track() 函数是添加这个数据；
而trigger() 函数<触发函数>会遍历我们存的每一个effect，然后运行它们；

如何存储，让每个属性拥有自己的依赖

通常，我们的对象会有多个属性，每个属性都需要自己的dep(依赖关系)，或者说effect的Set；

dep就是一个effect集(Set)，这个effect集应该在值发生改变时重新运行；

要把这些dep储存起来，且方便我们以后再找到它们，我们需要创建有一个depsMap，它是一张存储了每个属性其dep对象的图；
使用对象的属性名作为键，比如数量和价格，值就是一个dep(effects集)
代码实现：

 const depsMap = new Map()
 function track(key) {
     // key值就是刚才的价格或者数量
     let dep = depsMap.get(key);  // 找到属性的依赖
     if (!dep){  //如果没有，就创建一个
         depsMap.set(key, (dep = new Set()))
     }
     dep.add(effect)  // 添加effect，注意dep(Set)会去重
 }

 function trigger(key) {
     let dep = depsMap.get(key) // 找到键值的依赖
     if (dep) {  // 如果存在，遍历并运行每个effect
         dep.forEach(effect => {
             effect()
         })
     }
 }

 // main
 let product = { price: 5, quantity: 2};
 let total = 0;
 let effect = () => {
     total = product.price * product.quantity;
 }
 // 存储effect
 track('quantity')
 effect()

结果：

如果我们有多个响应式对象呢？

之前的是这样：

这里depsMap是对每个属性进行存储，再上一层，我们需要对每个对象进行存储，其中每个对象包括了不同的属性，所以我们在这之上有用了一张表(Map)，来存储每个对象；

Vue3中这个图叫做targetMap，需要注意的是这个数据结构是WeakMap<就是键值为空时会被垃圾回收机制清除，就是响应式对象消失后，这里面存的相关依赖也会被自动清除>

const targetMap = new WeakMap();  // 为每个响应式对象存储依赖关系
// 然后track()函数就需要首先拿到targetMap的depsMap
function track(target, key) {
    let depsMap = targetMap.get(target);  // target是响应式对象的名称，key是对象中属性的名称
    if (!depsMap){  // 不存在则为这个对象创建一个新的deps图
        targetMap.set(target, (depsMap = new Map())
    };
    let dep = depsMap.get(key);  // 获取属性的依赖对象，和之前的一致了
    if(!dep){  //同样不存在就创建一个新的
        depsMap.set(key, (dep = new Set()))
    };
    dep.add(effect);
}

function trigger(target, key){
    const depsMap = targetMap.get(target) // 检查对象是否有依赖的属性
    if(!depsMap){return}  // 如果没有则立即返回
    let dep = depsMap.get(key)  // 检查属性是否有依赖的关系
    // 如果有的话将遍历dep，运行每个effect
    if (dep){
        dep.forEach(effect => {effect()})
    }
}

// main
let product = {price: 5, quantity: 2}
let total = 0
let effect = () => {
    total = product.price * product.quantity
}
track(product, "quantity")
effect()

运行：

总结

响应式就是在每次更新值的时候重新计算一次，但是由于某些依赖什么什么的，某些对象对应的属性会导致另外的变量变化，所以需要一些数据结构去记录这些变化，就形成了下面的这些表(Map, Set)

但目前我们还没有办法让我们的effect自动重新运行，这将在后续讲到；

代理与反射

引入

上一部分我们使用track()与trigger()显式构造了响应式引擎，这部分我们希望其自动跟踪和触发；

需求：

访问了产品的属性或者说使用了get方法，就是我们想要调用track去保存effect的时候
产品的属性改变或者说使用了set方法，就是我们想要调用trigger来运行那些保存了的effect

解决：

Vue2中，使用的是ES5中的Object.defineProperty()去拦截get或set;
Vue3中，使用的是ES6中的代理和反射去实现相同的效果；

代理与反射基础

let product = {price: 5, quantity: 2};
product.quantity

product[quantity]

Reflect.get(product, ‘quantity’)

如下图所示，在打印的时候，调用顺序：它会先调用代理，简单来说就是一个对象委托，其中代理的第二个参数是一个处理函数，如下图所示我们可以在其中打印某字符串；

下面直接完全更改了get的默认行为，通常我们仅仅需要在原始行为上添加某些代码，这时候就需要反射来调用原始的行为了；

然后这里的log会调用get方法，而get方法在代理中有，所以就不会再往上找了，下图中箭头就停止了；

在代理中使用反射我们需要额外增加一个参数(receiver接收器传递到我们的Relect调用之中)，它保证了当我们的对象有继承自其他对象的值或者函数时，this指针能正确地指向；

然后，我们对set进行拦截：

运行调用：

封装

输出：

加入track和trigger

然后我们回到原来的代码，我们需要调用track和trigger：

回忆一下：

track的作用：将属性值(key)对应的effect加入到集合中；
track加入到get：<结合下下方的总体运行流程>比如我定义了一个响应式对象，其中包含单价与数量两个属性，然后后面我定义了一个变量total=product.price+product.quantity；这里就调用了get，即price与quantity的变化会影响到total这个变量，get中调用track将这个计算代码保存到集合中；
trigger的作用：把所有的effect函数重新运行一次；
trigger加入到set：在每次值变化的时候，运行对应的effect函数，比如单价变化时(执行set)，总价也会被effect函数重新计算；

总体运行流程

ActiveEffect&Ref

上一部分中的track会去遍历target<响应式对象>中的属性值，以及各种依赖，以确保当前的effect会被记录保存下来，但这并不是我们想要的，我们只应该在effect里调用追踪函数<就是只有在effect里面使用响应式对象的属性才会被保存记录下来，而不是在effect里面使用的，比如log一下就不会被记录保存，不会调用track()函数去跟踪，这是我们需要实现的效果>；

首先我们引入了一个activeEffect变量，它是现在正在运行中的effect(这也是Vue3解决这个问题的方法)

let activeEffect = null

function effect(eff){
    activeEffect = eff
    activeEffect()
    activeEffect = null
}
// 这个函数与直接调用传入的eff函数有什么区别，也就是多个activeEffect变量去保存有什么作用？<下面会用这个变量去判断一些东西>
// 配合下面的if来解决最开始的问题<避免遍历>

然后我们调用这个函数，这意味着我们不需要使用下面的effect()函数了，因为它会在上述函数中的activeEffect()步骤中被调用：

现在我们需要更新追踪函数(track function)，让它去使用这个新的activeEffect：

首先，我们只想在我们有activeEffect时运行这段代码：
当我们添加依赖时，我们要添加activeEffect

测试(添加更多的变量或对象)

当product.price = 10的时候，很明显上面的两个effect都会运行；

运行结果：

我们会发现当使用salePrice计算总数时，它会停止工作：

因为在这种情况下，当销售价格确定时，需要重新计算总数，这是不可能的，因为salePrice并不是响应式的<salePrice的变化并不会导致total重新计算>；

如何实现：

我们会发现这是一个使用Ref的好地方；

let salePrice = ref(0)

Ref接受一个值并返回一个响应的、可变的Ref对象，Ref对象只有一个“.value”属性，它指向内部的值，

现在我们考虑如何定义Ref()

1.我们可以简单的使用reactive，将键value设置为初始值：

function ref(intialValue) {
    return reactive({value: intialValue})
}

2.<Vue3中的解决方法>JavaScript中的计算属性：

这里会使用到对象访问器：对象访问器是获取或设置值的函数<getter和setter>

接下来使用对象访问器来定义Ref：

function ref(raw) {
    const r = {
        get value(){
            track(r, 'value')  // 在这里调用track函数
            return raw
        }
        set value(newVal){
            raw = newVal
            trigger(r, 'value')  // 在这里调用trigger函数
        }
    return r
    }
}

下面来测试一下是否正常：

当更新quantity时，total会变；当更新price时，total也会随着salePrice改变。

Compute&Vue3-Source

也许我们这里的销售价格和总价应该使用计算属性

我们应该如何定义计算方法呢？

计算属性或计算值和reactive与Ref是非常相似--依赖的属性变化了，结果就跟着变化...

创建一个响应式引用，称为result；
在effect中运行getter，因为我们需要监听响应值，然后把其(getter)赋值于result.value；
返回结果

下面是实际代码：

function computed(getter) {
    let result = ref()
    effect(() => (result.value = getter()))
    return result
}

测试结果如下：

对比Vue2的响应式：

在Vue2中，我们在创建了一个响应式对象之后，是无法再添加新的响应式属性，这里明显是更为强大的；

因为这个名字不是响应式的，Vue2中，get和set钩子是被添加到各个属性下的，所以当我们要增加新的属性时，还需要做其他事情：

但是，现在使用了代理，意味着我们可以添加新属性，然后它们会自动变成响应式

查看源码：

Q&A

问题一

在Vue2中，我们会调用depend去保存代码(函数)，并用notify去跑保存了的代码(函数)；但在Vue3中，我们调用的是track和trigger，原因？

根本上，它们仍然做的是同样的事；一个更大的区别是当你给它们取名字的时候，depend和notify是与所有者(Dep，一个依赖实例)相关的动词，可以说是一个依赖实例被依赖或者说它正在通知它的订阅者(subcribers)
在Vue3中，我们对依赖的关系的实现做了一点变更，从技术上讲已经没有Dep类了，deopend和notify的逻辑现在被抽离到两个独立函数(track和trigger)里，当我们调用track和trigger时，它们更像是在跟踪什么而不是什么东西被依赖(a.b-->b.call(a))

问题二

在Vue2中，我们有一个独立的Dep类；在Vue3的时候，我们只有一个Set，为什么做出这样的改变？

Vue2中的Dep类更容易让我们思考依赖关系作为一个对象有着某种行为
但在Vue3中，我们抽离depend和notify到track和trigger，现在是两个独立的功能，那么类本身就只剩下一个集合了，这时候，再用一个类去封装这个Set类本身就是没有意义的了，所以可以直接去声明它，而不是让一个对象去做；
性能的原因，这个类真的就不需要了

问题三

你是如何得到这个解决方案的(Vue3中处理响应式的方法)?

在ES5中使用getter与setter中的时候，当你遍历对象上的键时(forEach)，会自然有一个小小的闭包为属性存储关联的Dep;
在Vue3中，使用Proxy之后，Proxy的处理函数会直接接收目标和键，你并没有得到真正的闭包为每个属性存储关联依赖项；
我们需要的时给定一个目标对象和一个该对象上的键，我们如何始终找到对应的依赖实例，唯一的办法就是把它们分到两个不同等级的嵌套图；
targetMap的名字就来自于Proxy

问题四

定义Ref的时候可以，可以通过返回一个reactive去定义Ref，这种方法与Vue3源码中使用对象访问器去实现它有什么不同？

首先根据Ref的定义应该只暴露一个属性(值本身)，但是如果使用了reactive，从技术上来说，你会给他附加一些新的属性，这就违背了Ref的目的；
ref只能为包装一个内部值，不应该被当作一个一般的响应式对象；
isRef检查，返回的ref对象实际上有一些特殊的东西，让我们知道它实际上是一个Ref，而不是一个reactive，这在很多情况下是必要的；
性能问题，因为响应式做了更多的事，不仅仅是我们在Ref中做的事情，当你试图创建一个响应式对象时，我们需要检查一下是不是已经有对应符合的响应式副本，检查它是否有一个只读副本，当你创建响应式对象时，会有很多额外的工作要做，在这里使用一个对象字面量去创建一个ref会更节省性能

问题五

使用反射和代理去添加属性有什么其他的好处

当我们使用代理的时候，所谓的响应式转换会变成懒加载；
在Vue2中，当我们进行转换的时候，我们必须尽快完成转换，因为当你将对象传递给Vue2的响应式，我们必须遍历所有的键并当场转换。以后当他们被访问时，它们已经被转换了；
但是对于Vue3，当你调用reactive时，对于一个对象，我们所做的就是返回一个代理对象，仅在需要转换时嵌套对象(当你需要访问它的时候)，这就类似于懒加载；
这样，如果你的app有一个庞大的对象列表，但是对于分页，你只是渲染页面的前面10个，也就是只有前面10个必须经过响应式转换，可以为启动应用程序来说节省许多的时间；

源码

// packages\reactivity\src\baseHandlers.ts
const get = /*#__PURE__*/ createGetter()
const shallowGet = /*#__PURE__*/ createGetter(false, true)
const readonlyGet = /*#__PURE__*/ createGetter(true)
const shallowReadonlyGet = /*#__PURE__*/ createGetter(true, true)
const set = /*#__PURE__*/ createSetter()
const shallowSet = /*#__PURE__*/ createSetter(true)

createGetter

// packages\reactivity\src\baseHandlers.ts
function createGetter(isReadonly = false, shallow = false) {
    // 有isReadonly版本与shallow版本
    // isReadonly允许你只创建只读的对象，可以读取和跟踪但是不能改变
    // shallow意味着当把一个对象放进另外一个对象时作为嵌套属性，它不试图把它转换为响应式的
  return function get(target: Target, key: string | symbol, receiver: object) {
    if (key === ReactiveFlags.IS_REACTIVE) {
      return !isReadonly
    } else if (key === ReactiveFlags.IS_READONLY) {
      return isReadonly
    } else if (key === ReactiveFlags.IS_SHALLOW) {
      return shallow
    } else if (
      key === ReactiveFlags.RAW &&
      receiver ===
        (isReadonly
          ? shallow
            ? shallowReadonlyMap
            : readonlyMap
          : shallow
          ? shallowReactiveMap
          : reactiveMap
        ).get(target)
    ) {
      return target
    }
    const targetIsArray = isArray(target)
    // (1)
    if (!isReadonly && targetIsArray && hasOwn(arrayInstrumentations, key)) {
      return Reflect.get(arrayInstrumentations, key, receiver)
    }
    const res = Reflect.get(target, key, receiver)
    if (isSymbol(key) ? builtInSymbols.has(key) : isNonTrackableKeys(key)) {
      return res
    }
    if (!isReadonly) {
      track(target, TrackOpTypes.GET, key)  // 真正执行的代码
    }
    if (shallow) {
      return res
    }
  // 如果你在响应式对象中嵌套了Ref，当你访问时，它会自动拆封。
    if (isRef(res)) {
      // ref unwrapping - does not apply for Array + integer key.
      const shouldUnwrap = !targetIsArray || !isIntegerKey(key)
      return shouldUnwrap ? res.value : res
    }
  // 确保只有当它是一个对象时才转换它
    if (isObject(res)) {
      // Convert returned value into a proxy as well. we do the isObject check
      // here to avoid invalid value warning. Also need to lazy access readonly
      // and reactive here to avoid circular dependency.
      return isReadonly ? readonly(res) : reactive(res)
    }
    return res
  }
}

const arrayInstrumentations = /*#__PURE__*/ createArrayInstrumentations()
function createArrayInstrumentations() {
  const instrumentations: Record<string, Function> = {}
  // instrument identity-sensitive Array methods to account for possible reactive
  // values
  ;(['includes', 'indexOf', 'lastIndexOf'] as const).forEach(key => {
    instrumentations[key] = function (this: unknown[], ...args: unknown[]) {
      const arr = toRaw(this) as any
      for (let i = 0, l = this.length; i < l; i++) {
        track(arr, TrackOpTypes.GET, i + '')
      }
      // we run the method using the original args first (which may be reactive)
      const res = arr[key](...args)
      if (res === -1 || res === false) {
        // if that didn't work, run it again using raw values.
        return arr[key](...args.map(toRaw))
      } else {
        return res
      }
    }
  })
  // instrument length-altering mutation methods to avoid length being tracked
  // which leads to infinite loops in some cases (#2137)
  ;(['push', 'pop', 'shift', 'unshift', 'splice'] as const).forEach(key => {
    instrumentations[key] = function (this: unknown[], ...args: unknown[]) {
      pauseTracking()
      const res = (toRaw(this) as any)[key].apply(this, args)
      resetTracking()
      return res
    }
  })
  return instrumentations
}

我们有一个数组(响应式数组)，当访问嵌套在里面的东西时，得到的是原始数据的响应式版本

// 一种边缘案例
const obj = {}
const arr = reactive([obj])
const reactiveObj = arr[0]
// 比较对象与响应式对象
obj === reactiveObj  // is false

这个造成的问题就是如果使用indexOf查找obj<如果没有做数组检测仪(1)的话就会导致这个问题

const obj = {}
const arr = reactive([obj])
arr.indexOf(obj)  // -1

createSetter

// packages\reactivity\src\baseHandlers.ts
function createSetter(shallow = false) {
  return function set(
    target: object,
    key: string | symbol,
    value: unknown,
    receiver: object
  ): boolean {
    let oldValue = (target as any)[key]
    // 用户不能对只读属性进行操作
    // isRef(oldValue) && !isRef(value)检测是否在设置属性
    if (isReadonly(oldValue) && isRef(oldValue) && !isRef(value)) {
      return false
    }
    if (!shallow && !isReadonly(value)) {
      if (!isShallow(value)) {
        value = toRaw(value)
        oldValue = toRaw(oldValue)
      }
      if (!isArray(target) && isRef(oldValue) && !isRef(value)) {
        oldValue.value = value
        return true
      }
    } else {
      // in shallow mode, objects are set as-is regardless of reactive or not
    }
    const hadKey =
      isArray(target) && isIntegerKey(key)
        ? Number(key) < target.length
        : hasOwn(target, key)
    const result = Reflect.set(target, key, value, receiver)
    // don't trigger if target is something up in the prototype chain of original
    if (target === toRaw(receiver)) {
        // 如果没有键就添加
      if (!hadKey) {
        trigger(target, TriggerOpTypes.ADD, key, value)
      } else if (hasChanged(value, oldValue)) {
        trigger(target, TriggerOpTypes.SET, key, value, oldValue)
      }
    }
    return result
  }
}

使用delete去删除键：

function deleteProperty(target: object, key: string | symbol): boolean {
  const hadKey = hasOwn(target, key)
  const oldValue = (target as any)[key]
  const result = Reflect.deleteProperty(target, key)
  if (result && hadKey) {
    trigger(target, TriggerOpTypes.DELETE, key, undefined, oldValue)
  }
  return result
}

track

// packages\reactivity\src\effect.ts
export function track(target: object, type: TrackOpTypes, key: unknown) {
  if (!isTracking()) {
      // 一些内部标志，某些情况下不应该被跟踪(1)
    return
  }
  let depsMap = targetMap.get(target)
  if (!depsMap) {
    targetMap.set(target, (depsMap = new Map()))
  }
  let dep = depsMap.get(key)
  if (!dep) {
    depsMap.set(key, (dep = createDep()))
  }
  // 这个就是那个effect
  const eventInfo = __DEV__
    ? { effect: activeEffect, target, type, key }
    : undefined
  // (2)
  trackEffects(dep, eventInfo)
}

(1)

export function isTracking() {
  return shouldTrack && activeEffect !== undefined
}
// activeEffect意味着track无论怎样都会被调用，如果响应式对象刚刚被访问，没有任何当前运行的效果，但它还是会被调用

(2)

export function trackEffects(
  dep: Dep,
  debuggerEventExtraInfo?: DebuggerEventExtraInfo
) {
  let shouldTrack = false
  if (effectTrackDepth <= maxMarkerBits) {
    if (!newTracked(dep)) {
      dep.n |= trackOpBit // set newly tracked
      shouldTrack = !wasTracked(dep)
    }
  } else {
    // Full cleanup mode.
    shouldTrack = !dep.has(activeEffect!)
  }
  if (shouldTrack) {
    dep.add(activeEffect!)
    // 这是一种双向关系在dep与effect之间 is many-to-many
            //我们需要跟踪这一切做清理工作
    activeEffect!.deps.push(dep)
    if (__DEV__ && activeEffect!.onTrack) {
      activeEffect!.onTrack(
        Object.assign(
          {
            effect: activeEffect!
          },
          debuggerEventExtraInfo
        )
      )
    }
  }
}

trigger

清理集合时，必须触发(trigger)所有与之相关的effects

// packages\reactivity\src\effect.ts
export function trigger(
  target: object,
  type: TriggerOpTypes,
  key?: unknown,
  newValue?: unknown,
  oldValue?: unknown,
  oldTarget?: Map<unknown, unknown> | Set<unknown>
) {
  const depsMap = targetMap.get(target)
  if (!depsMap) {
    // never been tracked
    return
  }
  let deps: (Dep | undefined)[] = []
  if (type === TriggerOpTypes.CLEAR) {
    // collection being cleared
    // trigger all effects for target
    deps = [...depsMap.values()]
  } else if (key === 'length' && isArray(target)) {
    depsMap.forEach((dep, key) => {
      if (key === 'length' || key >= (newValue as number)) {
        deps.push(dep)
      }
    })
  } else {
    // schedule runs for SET | ADD | DELETE
    if (key !== void 0) {
      deps.push(depsMap.get(key))
    }
    // also run for iteration key on ADD | DELETE | Map.SET
    switch (type) {
      case TriggerOpTypes.ADD:
        if (!isArray(target)) {
          deps.push(depsMap.get(ITERATE_KEY))
          if (isMap(target)) {
            deps.push(depsMap.get(MAP_KEY_ITERATE_KEY))
          }
        } else if (isIntegerKey(key)) {
          // new index added to array -> length changes
          deps.push(depsMap.get('length'))
        }
        break
      case TriggerOpTypes.DELETE:
        if (!isArray(target)) {
          deps.push(depsMap.get(ITERATE_KEY))
          if (isMap(target)) {
            deps.push(depsMap.get(MAP_KEY_ITERATE_KEY))
          }
        }
        break
      case TriggerOpTypes.SET:
        if (isMap(target)) {
          deps.push(depsMap.get(ITERATE_KEY))
        }
        break
    }
  }
  const eventInfo = __DEV__
    ? { target, type, key, newValue, oldValue, oldTarget }
    : undefined
  if (deps.length === 1) {
    if (deps[0]) {
      if (__DEV__) {
        triggerEffects(deps[0], eventInfo)
      } else {
        triggerEffects(deps[0])
      }
    }
  } else {
    const effects: ReactiveEffect[] = []
    for (const dep of deps) {
      if (dep) {
        effects.push(...dep)
      }
    }
    if (__DEV__) {
      triggerEffects(createDep(effects), eventInfo)
    } else {
      triggerEffects(createDep(effects))
    }
  }
}

超详细Vue3响应式原理介绍+源码阅读