vue3 源码解析（2）— ref、toRef、toRefs、shallowRef 响应式的实现

奔雷手.文泰来

已于 2024-05-14 14:56:13 修改

阅读量528

点赞数

分类专栏： Vue 源码解析文章标签： javascript 前端源码解析 vue3

于 2023-10-25 16:11:38 首次发布

本文链接：https://blog.csdn.net/AXBNMD/article/details/133919417

版权

Vue 同时被 2 个专栏收录

12 篇文章 0 订阅

订阅专栏

源码解析

7 篇文章 0 订阅

订阅专栏

前言

vue3 源码解析（1）— reactive 响应式实现

在介绍完 reactive 之后还有另外几个很重要的响应式API也需要了解下，其中包括 ref、toRef、toRefs 和 shallowRef。了解这些API可以帮助我们更好地管理和跟踪响应式数据的变化。本文还是会以举例子的形式逐一介绍这些API的使用以及背后的原理。

ref

ref 基本用法

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>ref</title>
</head>
<body>
<div id="app"></div>
<script src="../packages/reactivity/dist/reactivity.global.js"></script>
<script>
  let { ref, effect } = VueReactivity;
  let state = ref("NY");
  effect(() => {
    app.innerHTML = state.value
  });
  setTimeout(() => {
    state.value = "California";
  }, 1000);
</script>
</body>
</html>

通过例子可以看到1s之后改变数据视图也跟随变，具体如何实现，我们先从例子中的 ref 函数的实现出发。

RefImpl 源码

ref 函数接收一个内部值，然后返回一个具有响应性和可变性的 ref 对象。ref 对象有一个.value属性，该属性指向内部值。

const enum ReactiveFlags {
  RAW = '__v_raw'
}
interface Target {
  [ReactiveFlags.RAW]?: any
}

function ref (target) {
  return createRef(target)
}

// shallow 是否使用浅层响应式
function createRef (rawValue, shallow = false) {
  return new RefImpl(rawValue, shallow)
}

class RefImpl<T> {
  private readonly _v_isRef = true // 标识 ref
  private _value: T // 原始值的响应式版本
  private _rawValue: T // 原始值的副本
  constructor (value: T, public readonly __v_isShallow: boolean) {
    this._rawValue = __v_isShallow ? value : toRaw(value)
    this._value = __v_isShallow ? value : toReactive(value)
  }

  // 类的属性访问器并进行依赖收集
  get value () {
    track(this, 'get', 'value')
    return this._value
  }

  set value (newVal) {
    const useDirectValue = this.__v_isShallow
    if (hasChanged(newVal, this._value)) {
      this._rawValue = newVal
      this._value = useDirectValue ? newVal : toReactive(newVal)
      trigger(this, 'set', 'value', newVal)}
  }
}


function toRaw<T>(observed: T): T {
  const raw = observed && (observed as Target)[ReactiveFlags.RAW]
  return raw ? toRaw(raw) : observed
}

const toReactive = <T extends unknown>(value: T): T =>
  isObject(value) ? reactive(value) : value

这里重点看下 ref 函数的实现类 RefImpl 做了什么：

RefImpl 的构造函数接收两个参数，value 和 __v_isShallow。value 是要转换为 ref 对象的原始值，__v_isShallow 是一个布尔值，表示是否使用浅层响应式。RefImpl 会将 value 转换为 _rawValue 和 _value 两个属性，_rawValue 是原始值的副本，_value 是原始值的响应式版本。如果 __v_isShallow 为 true，则 _rawValue 和 _value 相同，不会进行深层响应式转换。
RefImpl 还定义了一个属性访问器 value，用来实现 ref 对象的 .value 属性。当读取 value 时，会调用 track 函数进行依赖收集；当设置 value 时，会判断新值和旧值是否有变化，如果有变化，则更新 _rawValue 和 _value，并调用 trigger 函数通知依赖更新。
RefImpl 还有一个私有属性 _v_isRef，用来标识 ref 对象。这样可以在其他地方判断一个对象是否是 ref 对象，并进行相应的处理。
toRaw 函数的作用是返回一个响应式对象的原始对象。
toReactive 函数的主要作用是将一个可能是对象的值转换为响应式对象。当我们设置 ref 对象的 .value 属性时，如果新值是一个对象，那么 toReactive 会确保这个新值是响应式的，从而使得我们可以追踪这个新值的变化。

数据更新

在这里插入图片描述

setTimeout(() => {
  state.value = "California";
}, 1000);

这里触发更新的过程与之前提到的 reactive 更新执行过程基本一样。都是从 targetMap 的子项 depsMap 中获取对应的 effect 函数执行并直接返回最新的值。

shallowRef

shallowRef 基本用法

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>shallowRef</title>
</head>
<body>
<div id="app"></div>
<script src="../packages/reactivity/dist/reactivity.global.js"></script>
<script>
  let { shallowRef, effect } = VueReactivity;
  const state = shallowRef({ city: 'NY' })
  effect(() => {
    app.innerHTML = state.value.city
  });
  setTimeout(() => {
    state.value.city = 'California'
  }, 1000);
</script>
</body>
</html>

与之前例子不同的是1s之后数据改变了但是视图却并没有更新。

RefImpl 源码

function shallowRef (target) {
  return createRef(target, true) // true 浅的响应式
}

function createRef (rawValue, shallow = false) {
  return new RefImpl(rawValue, shallow)
}

// 此处省略部分代码...

需要注意的是：

与之前 createRef 函数不一样的是这个函数的第二个参数 true 表示创建的引用是浅的。这意味着，如果你更改了 target 的属性，vue 不会触发任何副作用或计算属性的重新计算。
如果你省略这个参数或将其设置为 false，那么 createRef 将创建一个深度引用，即 target 的所有属性都将被转换为响应式的。

数据更新

setTimeout(() => {
  state.value.city = 'California'
}, 1000);

因为 value.city 是一个非响应式的数据，直接修改 state.value.city = 'California' 是不会触发 reactive 函数中 reactiveHandlers 中 set 拦截器。如果直接设置 state.value = { city: 'California' } 的值则会触发 RefImpl 里面的 set value 函数，也触发 vue 会触发响应。

toRef

toRef 基本用法

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>toRef</title>
</head>
<body>
<div id="app"></div>
<script src="../packages/reactivity/dist/reactivity.global.js"></script>
<script>
  // toRef 将目标对象中的属性值变成 ref
  let { reactive, toRef, effect } = VueReactivity;
  let data = reactive({ city: "NY" });
  let state = toRef(data, "city");
  effect(() => {
    app.innerHTML = state.value;
  });
  setTimeout(() => {
    state.value = "California";
  }, 1000);
</script>
</body>
</html>

运行之后，同样可以看到1s之后改变数据视图也跟随变。

ObjectRefImpl 源码

toRef 函数可以将一个响应式对象的属性转换为一个 ref 对象。这个 ref 对象会与源对象的属性保持同步，也就是说，修改源对象的属性会更新 ref 对象，反之亦然。

function toRef (target, key: string) {
  return new ObjectRefImpl(target, key)
}

// _object 源对象
// _key 属性名
class ObjectRefImpl<T extends object, K extends keyof T> {
  private readonly _v_isRef = true // 标识 ref
  constructor (public readonly  _object: T, public readonly  _key: K) {}
  get value () {
    return this._object[this._key]
  }
  set value (newValue) {
    this._object[this._key] = newValue
  }
}

ObjectRefImpl 的主要作用是创建一个引用对象，该引用对象可以访问和修改目标对象的特定属性。

数据更新

在这里插入图片描述

 setTimeout(() => {
  state.value = "California";
}, 1000);

由于初始的数据已经被处理成了响应式，所以在 effect 函数里初次执行 state.value 时等价于访问 data.city本质上相当于触发了 reactive 函数中 reactiveHandlers 中的 get 拦截器，同时由于 get 里面已经默认执行了 track 所以 get value 函数里只需要将值返回就行不需要经行额外的处理。同理执行 state.value = "California" 本质上是触发 reactive 函数中 reactiveHandlers 中 set 拦截器。由于 set 里面已经默认执行了 trigger ，所以 set value 函数只需要经行赋值就行了。之后的更新过程和之前类似这里不在赘述。

toRefs

在了解了 toRef 的原理之后 toRefs 的原理也就相对来说很简单了，只需要将源对象进行循环遍历r然后对里面的每一个值调用一遍 toRef 即可。

function toRefs (target) {
  let result = isArray(target) ? new Array(target.length): {}
  for (let key in target) {
    result[key] = toRef(target, key)
  }
  return result
}

总结

这篇文章主要介绍了 vue 3 的响应式原理，其中涉及到了 ref、toRef、toRefs、shallowRef 等函数的实现。下面是这些函数的响应式实现的总结：

ref：ref 函数用于创建一个包含响应式数据的引用对象，它接受一个基本类型或对象类型的参数，并返回一个具有 value 属性的对象。当访问或修改 value 属性时，会触发响应式更新。ref 函数会对对象类型的参数进行深度响应式转换，即递归地将对象的所有属性都转换为响应式的。
toRef：toRef 函数用于创建一个指向另一个对象属性的响应式引用，它接受一个对象和一个属性名作为参数，并返回一个具有 value 属性的对象。当访问或修改 value 属性时，会同步地访问或修改原对象的属性，并触发响应式更新。toRef 函数不会对对象类型的属性进行深度响应式转换，即只会转换第一层属性。
toRefs：toRefs 函数用于将一个响应式对象转换为一个普通对象，该普通对象的每个属性都是指向原对象相应属性的响应式引用。它接受一个响应式对象作为参数，并返回一个普通对象。当访问或修改普通对象的属性时，会同步地访问或修改原对象的属性，并触发响应式更新。toRefs 函数不会对对象类型的属性进行深度响应式转换，即只会转换第一层属性。
shallowRef：shallowRef 函数用于创建一个浅层的响应式引用，它接受一个基本类型或对象类型的参数，并返回一个具有 value 属性的对象。当访问或修改 value 属性时，会触发响应式更新。shallowRef 函数不会对对象类型的参数进行深度响应式转换，即只会转换第一层属性。

奔雷手.文泰来

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
vue3 源码解析（2）— ref、toRef、toRefs、shallowRef 响应式的实现

这篇文章主要介绍了 vue 3 的响应式原理，其中涉及到了reftoReftoRefsshallowRef等函数的实现。ref：ref 函数用于创建一个包含响应式数据的引用对象，它接受一个基本类型或对象类型的参数，并返回一个具有 value 属性的对象。当访问或修改 value 属性时，会触发响应式更新。ref 函数会对对象类型的参数进行深度响应式转换，即递归地将对象的所有属性都转换为响应式的。
复制链接

扫一扫