# 【vue3源码】九、ref源码解析

【vue3源码】九、ref源码解析

参考代码版本:vue 3.2.37

官方文档:https://vuejs.org/

ref接受一个内部值,返回一个响应式的、可更改的ref对象,此对象只有一个指向其内部值的property.value

使用

const count = ref(0)
console.log(count.value) // 0

count.value++
console.log(count.value) // 1

源码解析

export function ref(value?: unknown) {
  return createRef(value, false)
}

ref返回createRef函数的返回值。

createRef接收两个参数:rawValue待转换的值、shallow浅层响应式。

function createRef(rawValue: unknown, shallow: boolean) {
  if (isRef(rawValue)) {
    return rawValue
  }
  return new RefImpl(rawValue, shallow)
}

如果rawValue本就是ref类型的会立即返回rawValue,否则返回一个RefImpl实例。

RefImpl

class RefImpl<T> {
  private _value: T
  private _rawValue: T
  
  // 当前ref的依赖
  public dep?: Dep = undefined
  public readonly __v_isRef = true

  constructor(value: T, public readonly __v_isShallow: boolean) {
    this._rawValue = __v_isShallow ? value : toRaw(value)
    this._value = __v_isShallow ? value : toReactive(value)
  }

  get value() {
    trackRefValue(this)
    return this._value
  }

  set value(newVal) {
    newVal = this.__v_isShallow ? newVal : toRaw(newVal)
    if (hasChanged(newVal, this._rawValue)) {
      this._rawValue = newVal
      this._value = this.__v_isShallow ? newVal : toReactive(newVal)
      triggerRefValue(this, newVal)
    }
  }
}

RefImpl的构造器接收两个值:value__v_isShallow是否浅层响应式。

constructor(value: T, public readonly __v_isShallow: boolean) {
  // 获取原始值,如果是浅层响应式,原始值就是value;如果不是浅层响应式,原始值是value的原始值
  this._rawValue = __v_isShallow ? value : toRaw(value)
  // 响应式数据,如果是浅层响应式,是value;否则转为reactive(只有Object类型才会转为reactive)
  this._value = __v_isShallow ? value : toReactive(value)
}

当获取new RefImpl()value属性时,会调用trackRefValue进行依赖收集,并返回this._value

export function trackRefValue(ref: RefBase<any>) {
  if (shouldTrack && activeEffect) {
    ref = toRaw(ref)
    if (__DEV__) {
      trackEffects(ref.dep || (ref.dep = createDep()), {
        target: ref,
        type: TrackOpTypes.GET,
        key: 'value'
      })
    } else {
      // 收集依赖到ref.dep中
      trackEffects(ref.dep || (ref.dep = createDep()))
    }
  }
}

reactive不同,ref的依赖会被保存在ref.dep中。

当修改new RefImpl()value属性时,会调用triggerRefValue触发依赖。

set value(newVal) {
  newVal = this.__v_isShallow ? newVal : toRaw(newVal)
  // 当newVal与旧原始值不同时,触发依赖
  if (hasChanged(newVal, this._rawValue)) {
    // 更新原始值及响应式数据
    this._rawValue = newVal
    this._value = this.__v_isShallow ? newVal : toReactive(newVal)
    triggerRefValue(this, newVal)
  }
}

shallowRef

shallowRef的实现同样通过createRef函数,不过参数shallowtrue

export function shallowRef(value?: unknown) {
  return createRef(value, true)
}
const state = shallowRef({ count: 1 })

effect(() => {
  console.log(state.value.count)
})

// 不会触发副作用
state.value.count = 2

// 可以触发副作用
state.value = {
  count: 3
}

为什么state.value.count = 2不触发副作用?
state初始化时,state._value就是{ count: 1 },一个普通对象,当使用state.value.count = 2设置值时,会先触发get函数返回state._value,然后再修改state._value,因为state._value是普通对象,所以不会有副作用触发。

而当使用state.value = { count: 3 }方式进行修改时,会命中set函数,因为新的值与旧的原始值内存地址不同,所以会触发副作用。

triggerRef

强制触发ref的副作用函数。

export function triggerRef(ref: Ref) {
  triggerRefValue(ref, __DEV__ ? ref.value : void 0)
}

实现原理很简单,就是主动调用一下triggerRefValue函数。

由于深度响应式的ref会自动进行依赖的触发,所以triggerRef主要应用于shallowRef的内部值进行深度变更后,主动调用triggerRef以触发依赖。例如前面的例子:

const state = shallowRef({ count: 1 })

effect(() => {
  console.log(state.value.count)
})

// 不会触发副作用
state.value.count = 2

// 主动触发副作用
triggerRef(state)

// 可以自动触发副作用
state.value = {
  count: 3
}

customRef

创建一个自定义的ref,显式声明对其依赖追踪和更新触发的控制方式。

如创建一个防抖ref,即只在最近一次set调用后的一段固定间隔后再调用:

import { customRef } from 'vue'

export function useDebouncedRef(value, delay = 200) {
  let timeout
  return customRef((track, trigger) => {
    return {
      get() {
        track()
        return value
      },
      set(newValue) {
        clearTimeout(timeout)
        timeout = setTimeout(() => {
          value = newValue
          trigger()
        }, delay)
      }
    }
  })
}

来看customRef的实现:

export function customRef<T>(factory: CustomRefFactory<T>): Ref<T> {
  return new CustomRefImpl(factory) as any
}

customRef返回一个CustomRefImpl实例。

class CustomRefImpl<T> {
  public dep?: Dep = undefined

  private readonly _get: ReturnType<CustomRefFactory<T>>['get']
  private readonly _set: ReturnType<CustomRefFactory<T>>['set']

  public readonly __v_isRef = true

  constructor(factory: CustomRefFactory<T>) {
    const { get, set } = factory(
      () => trackRefValue(this),
      () => triggerRefValue(this)
    )
    this._get = get
    this._set = set
  }

  get value() {
    return this._get()
  }

  set value(newVal) {
    this._set(newVal)
  }
}

CustomRefImpl的实现与RefImpl的实现差不多,都有个valuegetset函数,只不过getset在内部会调用用户自己定义的getset函数。当进行初始化时,会将收集依赖的函数与触发依赖的函数作为参数传递给factory,这样用户就可以自己控制依赖收集与触发的时机。

总结

ref的通过class实现,通过class的取值函数和存值函数进行依赖的收集与触发。

对于深度响应式的ref,会在向value属性赋值过程中,将新的值转为reactive,以达到深度响应式的效果。

3 声望
9 粉丝
0 条评论
推荐阅读
【vue3源码】十四、认识vnode中的shapeFlag和patchFlag属性
判断某个vnode的类型时可以使用vnode.shapeFlag &amp; ShapeFlags.ELEMENT的方式进行判断,或判断vnode是否同时是多种类型vnode.shapeFlag &amp; ShapeFlags.ELEMENT | ShapeFlags.ARRAY_CHILDREN

MAXLZ阅读 778

封面图
手把手教你写一份优质的前端技术简历
不知不觉一年一度的秋招又来了,你收获了哪些大厂的面试邀约,又拿了多少offer呢?你身边是不是有挺多人技术比你差,但是却拿到了很多大厂的offer呢?其实,要想面试拿offer,首先要过得了简历那一关。如果一份简...

tonychen153阅读 18k评论 5

封面图
正则表达式实例
收集在业务中经常使用的正则表达式实例,方便以后进行查找,减少工作量。常用正则表达式实例1. 校验基本日期格式 {代码...} {代码...} 2. 校验密码强度密码的强度必须是包含大小写字母和数字的组合,不能使用特殊...

寒青57阅读 8.7k评论 11

JavaScript有用的代码片段和trick
平时工作过程中可以用到的实用代码集棉。判断对象否为空 {代码...} 浮点数取整 {代码...} 注意:前三种方法只适用于32个位整数,对于负数的处理上和Math.floor是不同的。 {代码...} 生成6位数字验证码 {代码...} ...

jenemy49阅读 7.4k评论 12

再也不学AJAX了!(二)使用AJAX ① XMLHttpRequest
「再也不学 AJAX 了」是一个以 AJAX 为主题的系列文章,希望读者通过阅读本系列文章,能够对 AJAX 技术有更加深入的认识和理解,从此能够再也不用专门学习 AJAX。本篇文章为该系列的第二篇,最近更新于 2023 年 1...

libinfs42阅读 7k评论 12

封面图
CSS 绘制一只思否猫
欢迎关注我的公众号:前端侦探练习 CSS 有一个比较有趣的方式,就是发挥想象,绘制各式各样的图案,比如来绘制一只思否猫?思否猫,SegmentFault 思否的吉祥物,是一只独一无二、特立独行、热爱自由的(&gt;^ω^&lt...

XboxYan48阅读 3.4k评论 14

封面图
「多图预警」完美实现一个@功能
一天产品大大向 boss 汇报完研发成果和产品业绩产出,若有所思的走出来,劲直向我走过来,嘴角微微上扬。产品大大:boss 对我们的研发成果挺满意的,balabala...(内心 OS:不听,讲重点)产品大大:咱们的客服 I...

wuwhs32阅读 3.6k评论 5

封面图
3 声望
9 粉丝
宣传栏