【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,以达到深度响应式的效果。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342

推荐阅读更多精彩内容