【源码】Vue3 Ref原理,套娃的艺术

前言

Vue3有个Ref API,官网文档 说明其主要的用处是:1、将一个原始类型值 (例如,一个字符串),变成响应式的。2、当解构的两个 property 的响应性都会丢失时,可以将我们的响应式对象转换为一组 ref。这些 ref 将保留与源对象的响应式关联。
下面是对应的两个例子:

import { ref } from 'vue'

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

count.value++
console.log(count.value) // 1
import { reactive, toRefs } from 'vue'

const book = reactive({
  author: 'Vue Team',
  title: 'Vue 3 Guide',
})

let { author, title } = toRefs(book)

title.value = 'Vue 3 Detailed Guide' // 我们需要使用 .value 作为标题,现在是 ref
console.log(book.title) // 'Vue 3 Detailed Guide'

由于 Proxy 只能代理对象,那么Vue3是如何代理原始类型值的呢?
Ref 源码在 packages/reactivity/src/ref.ts 下,阅读版本是v3.2.30ref.ts只有200多行代码。看一下 Ref 是怎么实现的。

正文

(1)Ref

找到ref函数,其调用路径是 ref -> createRef -> new RefImplRefImpl是一个类,其实现很简单,提供一个value属性和value的访问器getset

class RefImpl<T> {
  private _value: T

  public readonly __v_isRef = true

  constructor(private _rawValue: T, public readonly _shallow = false) {
    this._value = _shallow ? _rawValue : convert(_rawValue)
  }

  get value() {
    track(toRaw(this), TrackOpTypes.GET, 'value')
    return this._value
  }

  set value(newVal) {
    if (hasChanged(toRaw(newVal), this._rawValue)) {
      this._rawValue = newVal
      this._value = this._shallow ? newVal : convert(newVal)
      trigger(toRaw(this), TriggerOpTypes.SET, 'value', newVal)
    }
  }
}

也就是说,ref的实现,还是使用对象,将原始类型值包一层,存到对象的value属性上。这也是为什么需要用 count.value 来访问和设置属性值。最终还是要使用对象的访问器get来收集依赖(track)、set来触发更新(trigger)。我们可以自己简单实现一个ref:

image.png

打开 Vue SFC Playground: ref 可查看和运行上面的例子。

(2)toRef、toRefs

接下来看看ref.tstoReftoRefs的实现,查看这两个API的使用,发现其就是使用 ref 与源响应式对象字段的响应式关联起来。其解决的问题是,当响应式对象的属性解构到新的普通对象newObj时,响应式会丢失:

const book = reactive({
  author: 'Vue Team',
  title: 'Vue 3 Guide',
})

const newObj = {
  ...book
}

newObj.author // 收集不到依赖
newObj.author = "Team" // 触发不了更新

下面看看toRef、toRefs:

image.png

他们的实现很简单,和实现ref的原理一样,也是包一层,提供一个value字段。当getset这个ref.value时,操作的是源响应式对象。达到与源响应式对象字段的响应式关联的目的,从而解决响应式丢失问题。
打开 Vue SFC Playground: toRef、toRefs 可查看自己实现的toRef、toRefs。
image.png

(3)ref.value问题与proxyRefs

当我们使用ref时,很多人吐槽,我们总是要加一个.value,用起来太不爽了。但我们发现,我们在模板中使用ref的时候,并不需要.value,那它是怎么实现的呢?

ref.ts中还有一个 proxyRefs :

image.png

可以看到,它就是对包含 ref类型字段的对象再包一层,把普通对象newObj也转成代理对象!当访问 newObj.foo时,判断newObj.foo是不是一个ref,如果是则代理到newObj.foo.value

然后我们搜一下proxyRefs在哪里有使用,可以看到在packages/runtime-core/src/component.ts中,handleSetupResult 会将 setupResult 传入 proxyRefs!这就是我们模板中使用 ref 对象(newObj.foo)不用加.value的原因。

image.png

至此,模板中的使用问题解决了。但我们还有个问题是,在script中使用还是需要.value:

function add() {
    newObj.foo.value++
}

对于这个问题,尤大提了一个提案 Ref Sugar 的 RFC,即 ref 语法糖,目前还处理实验性的(Experimental)阶段。提案的主要内容是尤大想提供一个语法糖$ref。使用$ref,编译器编译时会自动加上.value,这样我们编写代码时就不用使用.value了:

import { $ref } from 'vue'

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

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

我们通过 Vue Playground: $ref 可以直观地感受一下。

总结

至此,ref的源码也就看得差不多了,可以看到这是一个多重代理的东西。如果我们在模板中使用一个ref属性(newObj.foo),看看其经过的代理:
newObj.foo -> newObj.foo.value -> reactiveObj.foo -> rawObj.foo

其中rawObj是我们最初的普通对象。所以标题说这真是套娃。

参考

Vue3 Ref 语法糖,告别 .value 的写法

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

推荐阅读更多精彩内容