从零开始实现你自己的响应式库,从零开始实现 Vue 3 响应式模块。
本文完整内容见buid-your-own-vue-next
1. 实现响应式
响应基本类型变量
首先看一下响应式预期应该是什么样的,新建一个 demo.js
文件,内容如下:
// 这种写成一行完全是为了节省空间,实际上我会一行一个变量
let a = 1, b = 2, c = a * b
console.log('c:' + c) // 2
a = 2
console.log('c:' + c) // 期望得到4
思考一下,如何才能做到当 a
变动时 c
跟着变化?
显然,我们需要做的就是重新执行一下 let c = a * b
即可,像这样:
let a = 1, b = 2, c = a * b
console.log('c:' + c) // 2
a = 2
c = a * b
console.log('c:' + c) // 期望得到4
那么,现在我们把需要重新执行的代码写成一个函数,代码如下:
let a = 1, b = 2, c = 0
let effect = () => { c = a * b }
effect() // 首次执行更新c的值
console.log('c:' + c) // 2
a = 2
console.log('c:' + c) // 期望得到4
现在仍然没有达成预期的效果,实际上我们还需要两个方法,一个用来存储所有需要依赖更新的 effect
,我们假设叫 track
,一个用来触发执行这些 effect
函数,假设叫做 trigger
。
注意: 这里我们的函数命名和 Vue 3 中保持一致,从而可以更容易理解 Vue 3 源码。
代码类似这样:
let a = 1, b = 2, c = 0
let effect = () => { c = a * b }
track() // 收集 effect
effect() // 首次执行更新c的值
console.log('c:' + c) // 2
a = 2
trigger() // a变化时,触发effect的执行
console.log('c:' + c) // 期望得到4
那么 track
和 trigger
分别做了什么,是如何实现的呢?我们暂且可以简单理解为一个“发布-订阅者模式”,track
就是不断给一个数组 dep
添加 effect
,trigger
用来遍历执行 dep
的每一项 effect
。
现在来完成这两个函数
let a = 1, b = 2, c = 0
let effect = () => { c = a * b }
let dep = new Set()
let track = () => { dep.add(effect) }
let trigger = () => { dep.forEach(effect => effect()) }
track()
effect() // 首次执行更新c的值
console.log('c:' + c) // 2
a = 2
trigger() // a变化时,触发effect的执行
console.log('c:' + c) // 期望得到4,实际得到4
注意这里我们使用 Set
来定义 dep
,原因就是 Set
本身不能添加重复的 key
,读写都非常方便。
现在代码的执行结果已经符合预期了。
c: 2
c: 4
响应对象的不同属性
通常情况,我们定义的对象都有很多的属性,每一个属性都需要有自己的 dep
(即每个属性都需要把那些依赖了自己的effect记录下来放进自己的 new Set()
中),如何来实现这样的功能呢?
有一段代码如下:
let obj = { a: 10, b: 20 }
let timesA = obj.a * 10
let divideA = obj.a / 10
let timesB = obj.b * 10
let divideB = obj.b / 10
// 100, 1, 200, 2
console.log(`${timesA}, ${divideA}, ${timesB}, ${divideB}`)
obj.a = 100
obj.b = 200
// 期望得到 1000, 10, 2000, 20
console.log(`${timesA}, ${divideA}, ${timesB}, ${divideB}`)
这段代码中,按照上文讲解的,属性a
和b
的dep
应该是如下:
let depA = [
() => { timesA = obj.a * 10 },
() => { divideA = obj.a / 10 }
]
let depB = [
() => { timesB = obj.b * 10 },
() => { divideB = obj.b / 10 }
]
如果代码还是按照前文的方式来写显然是不科学的,这里就要开始做一点点抽象了,收集依赖我们可以假想用track('a')
track('b')
这种形式分别记录对象不同key
的依赖项,那么显然我们还需要一个东西来存放这些 key
及相应的dep
。
现在我们来实现这样的 track
函数及对应的 trigger
函数,代码如下:
const depsMap = new Map() // 每一项都是一个 Set 对象
function track(key) {
let dep = depsMap.get(key)
if(!dep) {
depsMap.set(key, dep = new Set());
}
dep.add(effect)
}
function trigger(key) {
let dep = depsMap.get(key)
if(dep) {
dep.forEach(effect => effect())
}
}
这样就实现了对一个对象不同属性的依赖收集,那么现在这个代码最简单的使用方法将是下面这样:
const depsMap = new Map() // 每一项都是一个 Set 对象
function track(key) {
...
// only for usage demo
if(key === 'a'){
dep.add(effectTimesA)
dep.add(effectDivideA)
}else if(key === 'b'){
dep.add(effectTimesB)
dep.add(effectDivideB)
}
}
function trigger(key) {
...
}
let obj = { a: 10, b: 20 }
let timesA = 0
let divideA = 0
let timesB = 0
let divideB = 0
let effectTimesA = () => { timesA = obj.a * 10 }
let effectDivideA = () => { divideA = obj.a / 10 }
let effectTimesB = () => { timesB = obj.b * 10 }
let effectDivideB = () => { divideB = obj.b / 10 }
track('a')
track('b')
// 为了省事直接改成调用trigger,后文同样
trigger('a')
trigger('b')
// 100, 1, 200, 2
console.log(`${timesA}, ${divideA}, ${timesB}, ${divideB}`)
obj.a = 100
obj.b = 200
trigger('a')
trigger('b')
// 期望得到:1000, 10, 2000, 20 实际得到:1000, 10, 2000, 20
console.log(`${timesA}, ${divideA}, ${timesB}, ${divideB}`)
代码看起来仍然是臃肿无比,别着急,后面的设计会优化这个问题。
响应多个对象
我们已经实现了对一个对象的响应编程,那么要对多个对象实现响应式编程该怎么做呢?
脑袋一拍,继续往外嵌套一层对象不就可以了吗?没错,你可以用 ES6 中的 WeakMap
轻松实现,WeakMap
刚好可以(只能)把对象当作 key
。(题外话,Map 和 WeakMap 的区别)
我们假想实现后是这样的效果:
let obj1 = { a: 10, b: 20 }
let obj2 = { c: 30, d: 40 }
const targetMap = new WeakMap()
// 省略代码
// 获取 obj1 的 depsMap
// 获取 obj2 的 depsMap
targetMap.set(obj1, "obj1's depsMap")
targetMap.set(obj2, "obj2's depsMap")
这里暂且不纠结为什么叫 targetMap
,现在整体依赖关系如下:
名称 | 类型 | key | 值 |
---|---|---|---|
targetMap | WeakMap | object | depsMap |
depsMap | Map | property | dep |
dep | Set | effect |
- targetMap: 存放每个响应式对象(所有属性)的依赖项
- targetMap: 存放响应式对象每个属性对应的依赖项
- dep: 存放某个属性对应的所有依赖项(当这个对象对应属性的值发生变化时,这些依赖项函数会重新执行)
现在我们可以实现这个功能了,核心代码如下:
const targetMap = new WeakMap();
function track(target, key) {
let depsMap = targetMap.get(target)
if(!depsMap){
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) {
let depsMap = targetMap.get(target)
if(depsMap){
let dep = depsMap.get(key)
if(dep) {
dep.forEach(effect => effect())
}
}
}
那么现在这个代码最简单的使用方法将是下面这样:
const targetMap = new WeakMap();
function track(target, key) {
...
// only for usage demo
if(key === 'a'){
dep.add(effectTimesA)
dep.add(effectDivideA)
}
}
function trigger(target, key) {
...
}
let obj = { a: 10, b: 20 }
let timesA = 0
let divideA = 0
let effectTimesA = () => { timesA = obj.a * 10 }
let effectDivideA = () => { divideA = obj.a / 10 }
track(obj, 'a')
trigger(obj, 'a')
console.log(`${timesA}, ${divideA}`) // 100, 1
obj.a = 100
trigger(obj, 'a')
console.log(`${timesA}, ${divideA}`) // 1000, 10
至此,我们对响应式的基本概念有了了解,我们已经做到了收集所有响应式对象的依赖项,但是现在你可以看到代码的使用是极其繁琐的,主要是因为我们还没实现自动收集依赖项、自动触发修改。
2. Proxy 和 Reflect
上一节讲到了我们实现了基本的响应功能,但是我们目前还是手动进行依赖收集和触发更新的。
解决这个问题的方法应该是:
- 当访问(
GET
)一个属性时,我们就调用track(obj, <property>)
自动收集依赖项(存储effect
) - 当修改(
SET
)一个属性时,我们就调用trigger(obj, <property>
自动触发更新(执行存储的effect
)
那么现在问题就是,我们如何在访问或修改一个属性时做到这样的事情?也即是如何拦截这种 GET
和 SET
操作?
Vue 2中我们使用 ES5 中的 Object.defineProperty
来拦截 GET
和 SET
。
Vue 3中我们将使用 ES6 中的 Reflect
和 Proxy
。(注意:Vue 3不再支持IE浏览器,所以可以用比较多的高级特性)
我们先来看一下怎么输出一个对象的一个属性值,可以用下面这三种方法:
- 使用
.
=>obj.a
- 使用
[]
=>obj['a']
- 使用 ES6 中的
Reflect
=>Reflect.get(obj, 'a')
这三种方法都是可行的,但是 Reflect
有非常强大的能力,后面会讲到。
Proxy
我们先来看看 Proxy
,Proxy
是另一个对象的占位符,默认是对这个对象的委托。你可以在这里查看 Proxy 更详细的用法。
let obj = { a: 1}
let proxiedObj = new Proxy(obj, {})
console.log(proxiedObj.a) // 1
这个过程可以表述为,获取 proxiedObj.a
时,直接去从查找 obj.a
然后返回给 proxiedObj
,再输出 proxiedObj.a
。
Proxy
的第二个参数被称为 handler
,handler
就是包含捕捉器(trap)的占位符对象,即处理器对象,捕捉器允许我们拦截一些基本的操作,如:
- 查找属性
- 枚举
- 函数的调用
现在我们的示例代码修改为:
let obj = { a: 1}
let proxiedObj = new Proxy(obj, {
get(target, key) {
console.log('Get')
return target[key]
}
})
console.log(proxiedObj.a) // 1
这段代码中,我们直接使用 target[key]
返回值,它直接返回了原始对象的值,不做任何其它操作,这对于这个简单的示例来说没任何问题,。
现在我们看一下下面这段稍微复杂一点的代码:
let obj = {
a: 1,
get b() { return this.a }
}
let proxiedObj = new Proxy(obj, {
get(target, key, receiver) {
return target[key] // 这里的target是obj
}
})
let childObj = Object.create(proxiedObj)
childObj.a = 2
console.log(childObj.b) // 期望得到2 实际输出1
这段代码的输出结果就是错误的,这是什么情况?难道是原型继承写错了吗?我们尝试把Proxy
相关代码去掉,发现输出是正常的......
这个问题其实就出在 return target[key]
这一行:
- 当读取
childObj.b
时,childObj
上没有属性b
,因此会从原型链上查找 - 原型链是
proxiedObj
- 读取
proxiedObj.b
时,会触发Proxy
捕捉器(trap)中的get
,这直接从原始对象中返回了target[key]
- 这里
target[key]
中key
是一个getter
,因此这个getter
中的上下文this
即为target,这里的target
就是obj
,因此直接返回了1
。
参考 为什么要使用 Reflect
那么我们怎么解决这个 this
出错的问题呢?
Reflect
现在我们就可以讲讲 Reflect
了。你可以在这里查看 Reflect 更详细的用法。
捕获器 get
有第三个参数叫做 receiver
。
Proxy
中handler.get(target, prop, receiver)
中的参数receiver
:Proxy
或者继承Proxy
的对象。
Reflect.get(target, prop, receiver)
中的参数receiver
:如果target
对象中指定了getter
,receiver
则为getter
调用时的this
值。
这确保了当我们的对象从另一个对象继承了值或函数时使用 this
值的正确性。
我们修改刚才的示例如下:
let obj = {
a: 1,
get b() { return this.a }
}
let proxiedObj = new Proxy(obj, {
// 本例中这里的receiver为调用时的对象childOjb
get(target, key, receiver) {
// 这里的target是obj
// 这意思是把receiver作为this去调用target[key]
return Reflect.get(target, key, receiver)
}
})
let childObj = Object.create(proxiedObj)
childObj.a = 2;
console.log(childObj.b) // 期望得到2 实际输出1
现在我们弄清楚了为什么要结合 Reflect
来使用 Proxy
,有了这些知识,就可以继续完善我们的代码了。
实现reactive函数
现在修改我们的示例代码为:
let obj = { a: 1}
let proxiedObj = new Proxy(obj, {
get(target, key, receiver) {
console.log('Get')
return Reflect.get(target, key, receiver)
}
set(target, key, value, receiver) {
console.log('Set')
return Reflect.set(target, key, value, receiver)
}
})
console.log(proxiedObj.a) // Get 1
接下来我们要做的就是结合 Proxy
的 handler
和 之前实现了的 track
、trigger
来完成一个响应式模块。
首先,我们来封装一下 Proxy
相关代码,和Vue 3保持一致叫reactive
。
function reactive(target) {
const handler = {
get(target, key, receiver) {
return Reflect.get(target, key, receiver)
},
set(target, key, value, receiver) {
return Reflect.set(target, key, value, receiver)
}
}
return new Proxy(target, handler)
}
这里有一个问题,当我们每次调用 reactive
时都会重新定义一个 handler
的对象,为了优化这个,我们把 handler
提出去,代码如下:
const reactiveHandler = {
get(target, key, receiver) {
return Reflect.get(target, key, receiver)
},
set(target, key, value, receiver) {
return Reflect.set(target, key, value, receiver)
}
}
function reactive(target) {
return new Proxy(target, reactiveHandler)
}
现在把reactive
引入到我们的第一节中最后的示例代码中。
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let divideA = 0
let effectTimesA = () => { timesA = obj.a * 10 }
let effectDivideA = () => { divideA = obj.a / 10 }
track(obj, 'a')
trigger(obj, 'a')
console.log(`${timesA}, ${divideA}`) // 100, 1
obj.a = 100
trigger(obj, 'a')
console.log(`${timesA}, ${divideA}`) // 1000, 10
现在我们要做的是去掉示例代码中的 track
和 trigger
。
回到本节开头提出的解决方案,我们已经可以拦截 GET
和 SET
操作了,只需要在适当的时候调用 track
和 trigger
方法即可,我们修改 reactiveHandler
代码如下:
const reactiveHandler = {
get(target, key, receiver) {
const result = Reflect.get(target, key, receiver)
track(target, key)
return result
},
set(target, key, value, receiver) {
const oldVal = target[key]
const result = Reflect.set(target, key, value, receiver)
// 这里判断条件不对,result为一个布尔值
if(oldVal !== result){
trigger(target, key)
}
return result
}
}
现在我们的示例代码可以精简为这样:
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let divideA = 0
let effectTimesA = () => { timesA = obj.a * 10 }
let effectDivideA = () => { divideA = obj.a / 10 }
// 恢复调用 effect 的形式
effectTimesA()
effectDivideA()
console.log(`${timesA}, ${divideA}`) // 100, 1
obj.a = 100
console.log(`${timesA}, ${divideA}`) // 1000, 10
我们已经去掉了手动 track
和 trigger
代码,至此,我们已经实现了 reactive
函数,看起来和Vue 3源码差不多了。
但这还有点问题:
-
track
函数中的effect
现在还没处理,只能手动添加 -
reactive
现在只能作用于对象,基本类型变量怎么处理?
下一个章节我们将解决这个问题,让我们的代码更加接近Vue 3。
3. activeEffect 和 ref
首先,我们修改一下示例代码:
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let effect = () => { timesA = obj.a * 10 }
effect()
console.log(timesA) // 100
obj.a = 100
// 新增一行,使用到obj.a
console.log(obj.a)
console.log(timesA) // 1000
由上节知识可以知道,当 effect
执行时我们访问到了 obj.a
,因此会触发 track
收集该依赖 effect
。同理,console.log(obj.a)
这一行也同样触发了 track
,但这并不是响应式代码,我们预期不触发 track
。
我们想要的是只在 effect
中的代码才触发 track
。
能想到怎么来实现吗?
只响应需要依赖更新的代码(effect)
首先,我们定义一个变量 shouldTrack
,暂且认为它表示是否需要执行 track
,我们修改 track
代码,只需要增加一层判断条件,如下:
const targetMap = new WeakMap();
let shouldTrack = null
function track(target, key) {
if(shouldTrack){
let depsMap = targetMap.get(target)
if(!depsMap){
targetMap.set(target, depsMap = new Map())
}
let dep = depsMap.get(key)
if(!dep) {
depsMap.set(key, dep = new Set());
}
// 这里的 effect 为使用时定义的 effect
// shouldTrack 时应该把对应的 effect 传进来
dep.add(effect)
// 如果有多个就手写多个
// dep.add(effect1)
// ...
}
}
现在我们需要解决的就是 shouldTrack
赋值问题,当有需要响应式变动的地方,我们就写一个 effect
并赋值给 shouldTrack
,然后 effect
执行完后重置 shouldTrack
为 null
,这样结合刚才修改的 track
函数就解决了这个问题,思路如下:
let shouldTrack = null
// 这里省略 track trigger reactive 代码
...
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let effect = () => { timesA = obj.a * 10 }
shouldTrack = effect // (*)
effect()
shouldTrack = null // (*)
console.log(timesA) // 100
obj.a = 100
console.log(obj.a)
console.log(timesA) // 1000
此时,执行到 console.log(obj.a)
时,由于 shouldTrack
值为 null
,所以并不会执行 track
,完美。
完美了吗?显然不是,当有很多的 effect
时,你的代码会变成下面这样:
let effect1 = () => { timesA = obj.a * 10 }
shouldTrack = effect1 // (*)
effect1()
shouldTrack = null // (*)
let effect2 = () => { timesB = obj.a * 10 }
shouldTrack = effect1 // (*)
effect2()
shouldTrack = null // (*)
我们来优化一下这个问题,为了和Vue 3保持一致,这里我们修改 shouldTrack
为 activeEffect
,现在它表示当前运行的 effect
。
我们把这段重复使用的代码封装成函数,如下:
let activeEffect = null
// 这里省略 track trigger reactive 代码
...
function effect(eff) {
activeEffect = eff
activeEffect()
activeEffect = null
}
同时我们还需要修改一下 track
函数:
function track(target, key) {
if(activeEffect){
...
// 这里不用再根据条件手动添加不同的 effect 了!
dep.add(activeEffect)
}
}
那么现在的使用方法就变成了:
const targetMap = new WeakMap();
let activeEffect = null
function effect (eff) { ... }
function track() { ... }
function trigger() { ... }
function reactive() { ... }
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let timesB = 0
effect(() => { timesA = obj.a * 10 })
effect(() => { timesB = obj.b * 10 })
console.log(timesA) // 100
obj.a = 100
console.log(obj.a)
console.log(timesA) // 1000
现阶段完整代码
现在新建一个文件reactive.ts
,内容就是当前实现的完整响应式代码:
const targetMap = new WeakMap();
let activeEffect = null
function effect(eff) {
activeEffect = eff
activeEffect()
activeEffect = null
}
function track(target, key) {
if(activeEffect){
let depsMap = targetMap.get(target)
if(!depsMap){
targetMap.set(target, depsMap = new Map())
}
let dep = depsMap.get(key)
if(!dep) {
depsMap.set(key, dep = new Set());
}
dep.add(activeEffect)
}
}
function trigger(target, key) {
let depsMap = targetMap.get(target)
if(depsMap){
let dep = depsMap.get(key)
if(dep) {
dep.forEach(effect => effect())
}
}
}
const reactiveHandler = {
get(target, key, receiver) {
const result = Reflect.get(target, key, receiver)
track(target, key)
return result
},
set(target, key, value, receiver) {
const oldVal = target[key]
const result = Reflect.set(target, key, value, receiver)
if(oldVal !== result){
trigger(target, key)
}
return result
}
}
function reactive(target) {
return new Proxy(target, reactiveHandler)
}
现在我们已经解决了非响应式代码也触发track
的问题,同时也解决了上节中留下的问题:track
函数中的 effect
只能手动添加。
接下来我们解决上节中留下的另一个问题:reactive
现在只能作用于对象,基本类型变量怎么处理?
实现ref
修改 demo.js
代码如下:
import { effect, reactive } from "./reactive"
let obj = reactive({ a: 10, b: 20 })
let timesA = 0
let sum = 0
effect(() => { timesA = obj.a * 10 })
effect(() => { sum = timesA + obj.b })
obj.a = 100
console.log(sum) // 期望: 1020
这段代码并不能实现预期效果,因为当 timesA
正常更新时,我们希望能更新 sum
(即重新执行 () => { sum = timesA + obj.b }
),而实际上由于 timesA
并不是一个响应式对象,没有 track
其依赖,所以这一行代码并不会执行。
那我们如何才能让这段代码正常工作呢?其实我们把基本类型变量包装成一个对象去调用 reactive
即可。
看过 Vue composition API
的同学可能知道,Vue 3中用一个 ref
函数来实现把基本类型变量变成响应式对象,通过 .value
获取值,ref
返回的就是一个 reactive
对象。
实现这样的一个有 value
属性的对象有这两种方法:
- 直接给一个对象添加
value
属性
function ref(intialValue) {
return reactive({
value: intialValue
})
}
- 用
getter
和setter
来实现
function ref(raw) {
const r = {
get value() {
track(r, 'value')
return raw
},
set value(newVal) {
raw = newVal
trigger(r, 'value)
}
}
return r
}
现在我们的示例代码修改成:
import { effect, reactive } from "./reactive"
function ref(intialValue) {
return reactive({
value: intialValue
})
}
let obj = reactive({ a: 10, b: 20 })
let timesA = ref(0)
let sum = 0
effect(() => { timesA.value = obj.a * 10 })
effect(() => { sum = timesA.value + obj.b })
// 期望: timesA: 100 sum: 120 实际:timesA: 100 sum: 120
console.log(`timesA: ${timesA.value} sum: ${sum}`)
obj.a = 100
// 期望: timesA: 1000 sum: 1020 实际:timesA: 1000 sum: 1020
console.log(`timesA: ${timesA} sum: ${sum}`)
增加了 ref
处理基本类型变量后,我们的示例代码运行结果符合预期了。至此我们已经解决了遗留问题:reactive
只能作用于对象,基本类型变量怎么处理?
Vue 3中的 ref
是用第二种方法来实现的,现在我们整理一下代码,把 ref
放到 reactive.j
中。
现阶段完整代码
const targetMap = new WeakMap();
let activeEffect = null
function effect(eff) {
activeEffect = eff
activeEffect()
activeEffect = null
}
function track(target, key) {
if(activeEffect){
let depsMap = targetMap.get(target)
if(!depsMap){
targetMap.set(target, depsMap = new Map())
}
let dep = depsMap.get(key)
if(!dep) {
depsMap.set(key, dep = new Set());
}
dep.add(activeEffect)
}
}
function trigger(target, key) {
let depsMap = targetMap.get(target)
if(depsMap){
let dep = depsMap.get(key)
if(dep) {
dep.forEach(effect => effect())
}
}
}
const reactiveHandler = {
get(target, key, receiver) {
const result = Reflect.get(target, key, receiver)
track(target, key)
return result
},
set(target, key, value, receiver) {
const oldVal = target[key]
const result = Reflect.set(target, key, value, receiver)
if(oldVal !== result){
trigger(target, key)
}
return result
}
}
function reactive(target) {
return new Proxy(target, reactiveHandler)
}
function ref(raw) {
const r = {
get value() {
track(r, 'value')
return raw
},
set value(newVal) {
raw = newVal
trigger(r, 'value)
}
}
return r
}
有同学可能就要问了,为什么不直接用第一种方法实现 ref
,而是选择了比较复杂的第二种方法呢?
主要有三方面原因:
- 根据定义,
ref
应该只有一个公开的属性,即value
,如果使用了reactive
你可以给这个变量增加新的属性,这其实就破坏了ref
的设计目的,它应该只用来包装一个内部的value
而不应该作为一个通用的reactive
对象; - Vue 3中有一个
isRef
函数,用来判断一个对象是ref
对象而不是reactive
对象,这种判断在很多场景都是非常有必要的; - 性能方面考虑,Vue 3中的
reactive
做的事情远比第二种实现ref
的方法多,比如有各种检查。
4. Computed
回到上节中最后的示例代码:
import { effect, reactive, ref } from "./reactive"
let obj = reactive({ a: 10, b: 20 })
let timesA = ref(0)
let sum = 0
effect(() => { timesA.value = obj.a * 10 })
effect(() => { sum = timesA.value + obj.b })
看到 timesA
和 sum
两个变量,有同学就会说:“这不就是计算属性吗,不能像Vue 2一样用 computed
来表示吗?” 显然是可以的,看过 Vue composition API
的同学可能知道,Vue 3中提供了一个 computed
函数。
示例代码如果使用 computed
将变成这样:
import { effect, reactive, computed } from "./reactive"
let obj = reactive({ a: 10, b: 20 })
let timesA = computed(() => obj.a * 10)
let sum = computed(() => timesA.value + obj.b)
现在的问题就是如何实现 computed
?
实现computed
我们拿 timesA
前后的改动来说明,思考一下 computed
应该是什么样的?
- 返回响应式对象,也许是
ref()
- 内部需要执行
effect
函数以收集依赖
function computed(getter) {
const result = ref();
effect(() => result.value = getter())
return result
}
现在测试一下示例代码:
import { effect, reactive, ref } from "./reactive"
let obj = reactive({ a: 10, b: 20 })
let timesA = computed(() => obj.a * 10)
let sum = computed(() => timesA.value + obj.b)
// 期望: timesA: 1000 sum: 1020 实际:timesA: 1000 sum: 1020
console.log(`timesA: ${timesA.value} sum: ${sum.value}`)
obj.a = 100
// 期望: timesA: 1000 sum: 1020
console.log(`timesA: ${timesA.value} sum: ${sum.value}`)
结果符合预期。
这样实现看起来很容易,实际上Vue 3中的 computed
支持传入一个 getter
函数或传入一个有 get
和 set
的对象,并且有其它操作,这里我们不做实现,感兴趣可以去看源码。
现阶段完整代码
至此我们已经实现了一个简易版本的响应式库了,完整代码如下:
const targetMap = new WeakMap();
let activeEffect = null
function effect(eff) {
activeEffect = eff
activeEffect()
activeEffect = null
}
function track(target, key) {
if(activeEffect){
let depsMap = targetMap.get(target)
if(!depsMap){
targetMap.set(target, depsMap = new Map())
}
let dep = depsMap.get(key)
if(!dep) {
depsMap.set(key, dep = new Set());
}
dep.add(activeEffect)
}
}
function trigger(target, key) {
let depsMap = targetMap.get(target)
if(depsMap){
let dep = depsMap.get(key)
if(dep) {
dep.forEach(effect => effect())
}
}
}
const reactiveHandler = {
get(target, key, receiver) {
const result = Reflect.get(target, key, receiver)
track(target, key)
return result
},
set(target, key, value, receiver) {
const oldVal = target[key]
const result = Reflect.set(target, key, value, receiver)
if(oldVal !== result){
trigger(target, key)
}
return result
}
}
function reactive(target) {
return new Proxy(target, reactiveHandler)
}
function ref(raw) {
const r = {
get value() {
track(r, 'value')
return raw
},
set value(newVal) {
raw = newVal
trigger(r, 'value')
}
}
return r
}
function computed(getter) {
const result = ref();
effect(() => result.value = getter())
return result
}
尚存问题
我们现在的代码非常简易,有很多细节尚未实现,你都可以在源码中学习到,比如:
- 操作一些内置的属性,如
Symbol.iterator
、Array.length
等触发了track
如何处理 - 嵌套的对象,如何递归响应
- 对象某个
key
对应的value
本身是一个reactive
对象,如何处理
你也可以自己尝试着实现它们。
本文完整内容见从零开始创建你的Vue 3
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。