登录3.响应式系统基础：从发布订阅模式的角度理解 Vue2 的数据响应式原理
前言
关于 Vue2 和 Vue3 的数据响应式原理，相信 Vue 技术栈的同学或多或少都了解过，甚至在简历上写很熟悉，而且我们在第一篇中也已经基本实现过了，但大家是否真的彻底掌握了呢？
正如我们前面所说的那样，Vue2、Vue3、SolidJS、Mobx 它们的数据响应式基本原理都是一样的，具体区别只是设计理念和实现方式不一样。按以前读书时代考试做题一样，它们是同一类型的题目，也就是基于依赖收集和触发的运行时的数据响应式，如果说你只会解答其中一道题，其他的题却不会解答，则说明你并没有真正彻底掌握这一类题。
同样地基于依赖追踪和触发的响应式系统都是通过发布订阅模式进行实现的，那么你知道 Vue 的数据响应式原理中是如何运用发布订阅模式的吗？
所以我们在本篇当中将从发布订阅模式的角度来理解 Vue 的数据响应式原理，彻底掌握数据响应式的基本原理，同时也巩固我们在上一篇中所说的发布订阅模式。我们在上一篇中学习了发布订阅模式，我们都是基于一些 demo 的例子去理解，本篇则真正的把发布订阅模式在实际项目的进行运用。
温馨提示，阅读本本之前最好先阅读前一篇文章，对发布订阅模式有一定的理解。
发布订阅模式原理回顾
我们在上一篇中最后是通过 Object.defineProperty 方法对公众号对象 weChatOfficialAccount 的 article 属性进行劫持监听，然后在 getter 的时候进行订阅，在 setter 的时候进行发布。
代码如下：
// 定义公众号
const weChatOfficialAccount = {
// 订阅公众号的人的记录列表
subscribers: [],
// 文章内容
article: '',
// 添加订阅者
addDep(fn) {
// 把订阅者添加进记录列表
this.subscribers.push(fn)
},
// 广播信息
notify(title) {
// 发布信息时就是把记录列表中的订阅者全部通知一次
this.subscribers.forEach(fn => fn(this.article))
},
// 取消订阅
remove(fn) {
// 找到需要删除的订阅者
const index = this.subscribers.indexOf(fn)
// 删除订阅者
this.subscribers.splice(index, 1 )
}
}
defineReactive(weChatOfficialAccount, 'article', weChatOfficialAccount.article)
// 通过闭包把劫持的属性值进行缓存
function defineReactive(data, key, val) {
Object.defineProperty(data, key, {
get() {
// 存在订阅者就进行订阅操作
if (subscriber) weChatOfficialAccount.addDep(subscriber)
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
weChatOfficialAccount.notify()
}
})
}
我们可以看到 weChatOfficialAccount 对象上有很多属于发布订阅模式中的功能，如果说还有其他对象也需要实现这样的功能，那么也要实现一遍这些功能，很明显这样是不可接受的，我们可以通过上一篇中实现的消息代理来代替 weChatOfficialAccount 对象中的发布订阅模式的功能。
首先我们对消息代理的实现做如下修改：
class Dep {
constructor() {
// 订阅者存储中心
this.subs = []
}
// 添加订阅者
addSub(sub) {
this.subs.push(sub)
}
// 通知订阅者
notify() {
this.subs.forEach(sub => sub())
}
}
如果熟悉 Vue2 数据响应式原理的同学对上面的代码肯定很熟悉，这个就是 Vue2 源码中的 Dep 类的简易实现，所以 Vue2 源码中的 Dep 其实就是一个事件总线或者叫消息代理，但它又不仅仅是消息代理，在某些时刻它同时又是一个订阅者，这个情况就是我们在上篇当中所说的一个对象既可以是发布者也可以是订阅者，而在 Vue2 源码中 Dep 类既是消息代理中心又是订阅者，具体情况我们将下文中进行详细讲解。
接下来我们继续做如下修改：
const weChatOfficialAccount = {
// 消息代理对象
__ob__: new Dep(),
// 文章内容
article: '',
}
defineReactive(weChatOfficialAccount, 'article', weChatOfficialAccount.article)
// 通过闭包把劫持的属性值进行缓存
function defineReactive(data, key, val) {
// 获取消息代理对象
const dep = weChatOfficialAccount.__ob__
Object.defineProperty(data, key, {
get() {
// 存在订阅者就进行订阅操作
if (subscriber) dep.addSub(subscriber)
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
dep.notify()
}
})
}
我们在公众号对象中通过 __ob__ 属性来存储消息代理对象，这样公众号对象原本属于发布订阅的功能就通过 Dep 类来实现了，这样代码的功能职责就梳理得十分清晰了，也符合代码整洁之道。
我们对修改后的代码进行测试：
// 订阅者小明
let subscriber = () => {
console.log(`收到的公众号文章：${weChatOfficialAccount.article}`)
}
// 读取一次，触发 getter 进行订阅
weChatOfficialAccount.article
// 设置为 null 防止重复订阅
subscriber = null
// 公众号发布文章则直接通过给属性赋值的方式
weChatOfficialAccount.article = '通过 Object.defineProperty 方法实现订阅发布模式'
上述测试代码的测试结果将会打印：
收到的公众号文章：通过 Object.defineProperty 方法实现订阅发布模式
我们通过 Object.defineProperty 方法实现对 weChatOfficialAccount 对象的属性 article 进行监听实现发布订阅功能，然后订阅的时候需要读取一下，触发 getter 进行订阅，这个行为在上述例子中比较奇怪，我们把它改成我们容易理解的例子。
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-9" />
<title></title>
</head>
<body>
<div id='content'></div>
<script>
const weChatOfficialAccount = {
// 消息代理对象
__ob__: new Dep(),
// 文章内容
article: '文章内容',
}
// 省略 ...
// 订阅者小明
let subscriber = () => {
const el = document.getElementById('content')
el.textContent = `小明收到的公众号文章：${weChatOfficialAccount.article}`
}
// 初始化
subscriber()
subscriber = null
</script>
<body>
</html>
我们改成我们 web 应用程序中的例子就比较容易理解了。所谓订阅者小明，就是一个 HTML 更新函数，在初始化执行 subscriber() 函数的时候，会读取公众号对象 weChatOfficialAccount 的 article 属性的值，这样就会触发 getter 函数进行订阅，在后续当公众号对象 weChatOfficialAccount 的 article 属性值发生变化的时候，就会触发 setter 进行发布，也就是重新执行订阅者函数，然后网页内容发生变化。这个也是 Vue2 中的数据响应式的基本原理。
在上述例子中我们只对其中一个属性进行监听，但实际情况很有可能有其他订阅者对其他属性的进行引用。
// 订阅者郭靖
let guojingSubscriber = () => {
console.log(`郭靖收到的公众号文章作者：${weChatOfficialAccount.author}`)
}
// 订阅者杨过
let yangguoSubscriber = () => {
console.log(`杨过收到的公众号发布时间：${weChatOfficialAccount.date}`)
}
然后我们需要对公众号对象进行修改：
const weChatOfficialAccount = {
// 事件总线对象
__ob__: new Dep(),
// 文章内容
article: '文章内容',
+ author: '作者',
+ date: '日期'
}
defineReactive(weChatOfficialAccount, 'article', weChatOfficialAccount.article)
+ defineReactive(weChatOfficialAccount, 'author', weChatOfficialAccount.author)
+ defineReactive(weChatOfficialAccount, 'date', weChatOfficialAccount.date)
同时需要对 getter 中的添加订阅者部分进行修改，为了精准添加对应的订阅者，我们需要判断对应的属性：
function defineReactive(data, key, val) {
// 获取消息代理对象
const dep = weChatOfficialAccount.__ob__
Object.defineProperty(data, key, {
get() {
+ // 为了精准添加对应属性的订阅者，我们需要判断对应的属性
+ if (subscriber && key === 'article') dep.addSub(subscriber)
+ if (guojingSubscriber && key === 'author') dep.addSub(guojingSubscriber)
+ if (yangguoSubscriber && key === 'date') dep.addSub(yangguoSubscriber)
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
dep.notify()
}
})
}
我们上述代码中为了精准添加对应属性的订阅者，我们需要在 getter 中判断对应的属性，在功能简单的情况下可以，如果功能复杂，对象的属性庞大的情况下，这样肯定是不能接受的。
又因为在触发 getter 的时候，只会是在某个订阅者函数在执行的时候，也就是说在 getter 被触发的时候，这个时候的订阅者是确定的，所以我们可以采用 中间变量 形式来解决这个问题。我们设置一个全局变量 activeEffect，也就是所谓中间变量，然后在初始化执行订阅者函数之前把需要执行的订阅者函数赋值给 activeEffect，然后在 getter 里面就可以把中间变量 activeEffect 通过消息代理对象添加到订阅者记录里面了，然后在执行完该订阅者函数之后则需要把中间变量 activeEffect 设置为 null，防止重复添加。
代码修改如下：
+ // 订阅者中间变量
+ let activeEffect
function defineReactive(data, key, val) {
// 获取消息代理对象
const dep = weChatOfficialAccount.__ob__
Object.defineProperty(data, key, {
get() {
+ // 存在订阅者中间变量就进行订阅者添加
+ if (activeEffect) dep.addSub(activeEffect)
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
dep.notify()
}
})
}
+ // 初始化订阅者
+ activeEffect = subscriber
+ subscriber()
+ activeEffect = null
+ activeEffect = guojingSubscriber
+ guojingSubscriber()
+ activeEffect = null
+ activeEffect = yangguoSubscriber
+ yangguoSubscriber()
+ activeEffect = null
接着我们进行测试：
// 公众号发布文章
weChatOfficialAccount.article = '通过 Object.defineProperty 方法实现订阅发布模式'
打印结果如下：
我们就发现我们虽然只对 article 属性进行赋值，但也触发了其他属性的订阅者的执行。那么我们就需要对属性与订阅者之间进行准确关联。那么如何进行准确关联呢？我们通过第一篇文章可以知道，在通过 Object.defineProperty 对每一个属性进行劫持监听的时候，通过闭包的形式把属性值缓存下来的，所以每一个属性的消息代理也放在闭包函数 defineReactive 中。
// 通过闭包把劫持的属性值进行缓存
function defineReactive(data, key, val) {
+ // 通过闭包把每一个属性的消息代理进行缓存
+ const dep = new Dep()
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
if (activeEffect) dep.addSub(activeEffect)
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
dep.notify()
}
})
}
这时我们再进行测试的时候，就可以精准触发订阅者了。
我们上面是通过手动调用 defineReactive 函数进行对象的属性劫持的，我们可以通过获取所有对象的属性然后遍历调用 defineReactive 函数进行对象的属性劫持，同时把这个功能封装成一个工具函数 observe。我们在第一篇中也实现过的了，下面我们来重新实现一下：
function observe (data) {
Object.keys(data).forEach(key => {
defineReactive(data, key, data[key])
})
}
这样我们就可以通过 observe 函数来定义一个响应式对象了。
const weChatOfficialAccount = {
// 文章内容
article: '文章内容',
author: '作者',
date: '日期'
}
- defineReactive(weChatOfficialAccount, 'article', weChatOfficialAccount.article)
- defineReactive(weChatOfficialAccount, 'author', weChatOfficialAccount.author)
- defineReactive(weChatOfficialAccount, 'date', weChatOfficialAccount.date)
+ observe(weChatOfficialAccount)
至此我们便通过发布订阅模式初步实现了 Vue2 的响应式原理。创建一个对象，通过 observe 工具函数遍历此对象所有的 property，并使用 Object.defineProperty 把这些 property 全部转为 getter/setter，然后在 getter 的时候进行依赖收集，在 setter 的时候进行依赖触发。
从发布订阅模式的角度来说就是每一个对象的 property 都是发布者，然后它的消息代理则通过闭包的形式跟每一个 property 的值一起缓存在 defineReactive 闭包函数创建独立空间中，它们是多对多的关系。
小结
在我们一般的发布订阅模式（也叫观察者模式）中，发布者或者被观察者是很明确的，是一个具体的对象，但正如我们前一篇文章所说的那样，发布订阅模式是没有标准范式的，设计模式也是，辨别一种模式不能通过代码结构，而是代码意图。而在我们上述实现的 Vue2 响应式原理的过程中，我们发现其实每一个对象属性（property）都是一个发布者或者叫被观察者，它的发布者功能则通过消息代理中介进行实现，而这个消息代理对象则通过闭包的形式跟每个属性值一起缓存在闭包当中。我们又可以发现所谓发布订阅模式的触发条件也不是唯一的，我们一般的描述定义是，当一个对象发现变化的时候才去触发所有依赖它的订阅者，其实不然，发布订阅模式的触发条件可以是状态的变化、某个操作的变化、甚至是发布订阅者的通知也可以触发另外一个发布者进行发布操作。如果有在 Vue 中使用过事件总线的同学会很清楚，我们在组件中触发通知（emit）订阅者操作的时候并不一定是组件属性发生了变化，而有可能是某个方法触发了通知（emit）订阅者操作。
对数组进行响应式的处理
可以通过 Object.defineProperty 对数组进行监听，但监听不了数组自身的原型链方法，而 push、pop、shift、unshift、splice、sort、reverse 对数组进行操作是会改变数组的数据结构的，从发布订阅模式的角度来说数据发生变化后我们需要通知该数组对象的所有订阅者。为了实现这需求我们需要劫持数组的操作方法，即在对数组进行 push 等操作的时候我们能监听到。实现方案就是对数组的原型进行重写，重写的方法就是覆盖数组数组对象上的原型对象 __proto__。我们在第一篇当中是通过粗暴的直接覆盖的方式，但那样会把原来的一些数组方法也覆盖掉了，那样是不可取。
我们可以通过获取数组原型上的对象，然后只修改需要修改的方法即可。我们对 observe 方法修改如下：
function observe (data) {
+ // 如果是数组则重写数组上的原型
+ if (Array.isArray(data)) {
+ // 获取数组原型
+ const arrayProto = Array.prototype
+ // 通过 Object.create 创建一个原型为 arrayProto 的空对象
+ const arrayMethods = Object.create(arrayProto)
+ // 修改 push 方法
+ arrayMethods['push'] = function (...args) {
+ // 获取原始方法
+ const original = arrayProto['push']
+ // 执行原始方法
+ const result = original.apply(this, args)
+ return result
+ }
+ // 覆盖原型对象
+ data.__proto__ = arrayMethods
+ } else {
Object.keys(data).forEach(key => {
// 如果属性不是 __ob__ 则进行监听
if (key !== '__ob__') defineReactive(data, key)
})
+ }
}
上述代码我们通过 Object.create 创建一个原型为 arrayProto 的空对象：arrayMethods。然后给空对象设置 push 属性值为一个函数，最终把 arrayMethods 赋值给 data 的 __proto__。这里就涉及到了一个 JavaScript 原型链的基础知识，当我们获取一个对象的属性值的时候，我们优先从该对象的自身属性上去获取，如果找不到则沿着该对象的 __proto__ 属性上的对象上的属性去查找，如果还找不到，则继续沿着 __proto__ 上的对象去查找。
我们经过上面的代码设置之后，我们通过 observe 设置一个数组，那么这个数组的原型对象则变为了arrayMethods，当执行该数组的 push 方法，根据原型链的规则，它会先执行 arrayMethods 对象上的 push 方法，这样我们就可以对该数组的 push 方法进行了监听，我们最终还是通过原本数组上 push 方法进行操作，但我们可以捕捉到了 push 的动作，这样我们就可以在 push 操作之后，进行通知所有该数组上的订阅者了。
我们从前面的发布订阅模式的知识可以知道，一个发布者对象上需要有一个消息代理对象，所以我们需要继续迭代我们的代码：
function observe (data) {
+ // 不存在消息代理则设置消息代理对象
+ if (!data.__ob__) data.__ob__ = new Dep()
// 如果是数组则重写数组上的原型
if (Array.isArray(data)) {
// 获取数组原型
const arrayProto = Array.prototype
// 通过 Object.create 创建一个原型为 arrayProto 的空对象
const arrayMethods = Object.create(arrayProto)
// 修改 push 方法
arrayMethods['push'] = function (...args) {
// 获取原始方法
const original = arrayProto['push']
// 执行原始方法
const result = original.apply(this, args)
+ // 因为执行 push 方法，数组数据有变化所以需要通知订阅者
+ data.__ob__.notify()
// 同时对新添加的数据也进行响应式化
+ for (let i = 0, l = args.length; i < l; i++) {
+ observe(args[i])
+ }
}
// 覆盖原型对象
data.__proto__ = arrayMethods
} else {
Object.keys(data).forEach(key => {
// 如果属性不是 __ob__ 则进行监听
if (key !== '__ob__') defineReactive(data, key)
})
}
}
那么我们这个发布者对象的订阅者在哪里进行添加呢，从数据响应式的角度就是这个响应式对象的依赖在哪里收集呢？
其实不管是对象还是数组的订阅者都是在 getter 中进行添加的。
例如：{ list: [1,2,3,4] }
你要获取到 list 数组的内容，首先是通过 list 这个 property 进行获取的，所以当通过 list 这个 property 进行获取数组内容的时候，就触发了 list 这个 property 的 getter。
所以我们需要对 defineReactive 函数进行修改：
function defineReactive(data, key) {
let val = data[key]
// 获取消息代理对象
const dep = new Dep()
+ // 对获取到的属性值进行递归 observe 监听
+ const childOb = observe(val)
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
if (activeEffect){
dep.addSub(activeEffect)
+ // 如果存在 childOb 则说明属性值是一个对象，则也需要对该对象进行订阅者收集，从发布订阅模式的角度看，这是一个订阅操作
+ if (childOb) childOb.addSub(activeEffect)
}
return val
},
set(newVal) {
val = newVal
// 通知所有的订阅者
dep.notify()
}
})
}
在 getter 中会进行 property 的订阅者添加，收集到的订阅者保存在对应 property 的消息代理对象中，同时也会判断，property 的值如果是一个对象，还会对这个对象进行订阅者添加，收集到的订阅者还会保存到这个对象的消息代理对象上。
所以我们还需要对 observe 函数进行修改：
+ // 判断是否是对象
+ function isObject(obj) {
+ return obj !== null && typeof obj === 'object'
+ }
function observe (data) {
+ // 不是对象则直接返回
+ if (!isObject(data)) return
// 省略 ...
+ // 返回消息代理对象
+ return data.__ob__
}
至此我们对数组的响应式也实现了，接下来就是进行测试：
// 定义公众号
const weChatOfficialAccount = {
// 文章内容
article: '',
author: '',
date: '',
arr: ['掘金']
}
observe(weChatOfficialAccount)
// 订阅者小明
let subscriber = () => {
console.log(`收到的公众号文章：${weChatOfficialAccount.arr.join('====')}`)
}
// 初始化订阅者
activeEffect = subscriber
subscriber()
activeEffect = null
// 公众号发布文章则直接通过给属性赋值的方式
weChatOfficialAccount.arr.push('通过 Object.defineProperty 方法实现订阅发布模式')
打印结果如下：
我们可以看到正确打印了结果，也就是我们也实现了对数组的响应式。
通过重构实现 Observer 类
我们上述函数 observe 的实现其实职责是很不清晰的，也不利于后续的维护，所以我们需要对它进行重构。软件应该是“自描述”的，代码除了给机器看之外，也要给人看。我们希望写的代码更易读，让代码可以更好地表达自己的意图。
这里我们涉及到一些开发技巧，我们可以先实现具体的功能，然后再重构，在重构的时候通过封装成抽象的类或者其他函数，让代码可以更好地表达自己的意图。那么 observe 函数中可以将对数组响应式的处理，还有对对象属性循环劫持分别封装成不同的函数，然后通过函数名称可以让我们的代码意图更明显。
我们对 observe 函数进行重构，代码如下：
function observe (data) {
// 不是对象则直接返回
if (!isObject(data)) return
// 不存在消息代理则设置消息代理对象
if (!data.__ob__) data.__ob__ = new Dep()
// 如果是数组则重写数组上的原型
if (Array.isArray(data)) {
+ protoAugment(data)
} else {
+ walk(data)
}
// 返回消息代理对象
return data.__ob__
}
+ // 对数组进行响应式处理
+ function protoAugment(target) {
+ // 获取数组原型
+ const arrayProto = Array.prototype
+ // 通过 Object.create 创建一个原型为 arrayProto 的空对象
+ const arrayMethods = Object.create(arrayProto)
+ // 修改 push 方法
+ arrayMethods['push'] = function (...args) {
+ // 获取原始方法
+ const original = arrayProto['push']
+ // 执行原始方法
+ const result = original.apply(this, args)
+ // 因为执行 push 方法，数组数据有变化所以需要通知订阅者
+ target.__ob__.notify()
// 同时对新添加的数据也进行响应式化
observeArray(args)
+ }
+ // 覆盖原型对象
+ target.__proto__ = arrayMethods
+ }
+ // 对对象进行响应式处理
+ function walk(obj) {
+ const keys = Object.keys(obj)
+ keys.forEach(key => {
+ // 如果属性不是 __ob__ 则进行监听
+ if (key !== '__ob__') defineReactive(obj, key)
+ })
+ }
// 对数组的每一项元素都进行响应式处理
function observeArray (items) {
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
经过我们上面对不同的功能代码进行重构后，我们就可以通过函数名称很容易理解代码的意图了。但我们上面的功能函数还是十分的分散，而它们都是同一种功能类型的函数，都是实现对象响应式的功能函数，所以我们可以通过 OOP 的思想把响应式数据和操作封装到一个类里面，这个类我们把它命名为 Observer。
Observer 类的代码实现如下：
class Observer {
constructor(value) {
this.value = value
this.dep = new Dep()
this.value.__ob__ = this
if (Array.isArray(value)) {
// 对数组进行响应式处理
this.protoAugment(value)
// 对数组的每一项都进行响应式处理
this.observeArray(value)
} else {
// 对对象进行响应式处理
this.walk(value)
}
}
// 进行原型重写
protoAugment(target) {
// 获取数组原型
const arrayProto = Array.prototype
// 通过 Object.create 创建一个原型为 arrayProto 的空对象
const arrayMethods = Object.create(arrayProto)
// 修改 push 方法
arrayMethods['push'] = function (...args) {
const ob = this.__ob__
// 获取原始方法
const original = arrayProto['push']
// 执行原始方法
const result = original.apply(this, args)
// 因为执行 push 方法，数组数据有变化所以需要通知订阅者
ob.dep.notify()
// 同时对新添加的数据也进行响应式化
ob.observeArray(args)
}
// 覆盖原型对象
target.__proto__ = arrayMethods
}
// 对对象进行响应式处理
walk(obj) {
const keys = Object.keys(obj)
keys.forEach(key => {
// 如果属性不是 __ob__ 则进行监听
if (key !== '__ob__') defineReactive(obj, key)
})
}
// 对数组的每一项元素都进行响应式处理
observeArray (items) {
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
}
function observe (data) {
// 不是对象则直接返回
if (!isObject(data)) return
const ob = new Observer(data)
// 返回 Observer 实例对象
return ob
}
defineReactive 函数也需要进行以下修改：
function defineReactive(data, key) {
// ...
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
if (activeEffect){
dep.addSub(activeEffect)
// 如果存在 childOb 则说明属性值是一个对象，则也需要对该对象进行订阅者收集，从发布订阅模式的角度看，这是一个订阅操作
- if (childOb) childOb.addSub(activeEffect)
+ if (childOb) childOb.dep.addSub(activeEffect)
}
return val
},
set(newVal) {
// ...
}
})
}
我们修改后进行重新测试也正常打印了结果：
我们还可以进行一下性能优化，我们上述代码 protoAugment 函数部分，我们创建了数组原型对象的变量，而这些变量其实是不会变化，我们可以把它们的声明移到 protoAugment 函数外面，这样每一次调用 protoAugment 函数就不会重复重新创建这些变量了。
+ // 获取数组原型
+ const arrayProto = Array.prototype
+ // 通过 Object.create 创建一个原型为 arrayProto 的空对象
+ const arrayMethods = Object.create(arrayProto)
+ // 修改 push 方法
+ arrayMethods['push'] = function (...args) {
+ const ob = this.__ob__
+ // 获取原始方法
+ const original = arrayProto['push']
+ // 执行原始方法
+ const result = original.apply(this, args)
+ // 因为执行 push 方法，数组数据有变化所以需要通知订阅者
+ ob.dep.notify()
+ // 同时对新添加的数据也进行响应式化
+ ob.observeArray(args)
+ }
class Observer {
constructor(value) {
// 省略 ...
if (Array.isArray(value)) {
// 对数组进行响应式处理
+ this.protoAugment(value, arrayMethods)
// 对数组的每一项都进行响应式处理
this.observeArray(value)
} else {
}
}
+ protoAugment(target, src) {
+ // 覆盖原型对象
+ target.__proto__ = src
+ }
// 省略 ...
}
至此我们通过重构就实现了 Observer 类，这一节没有涉及到发布订阅模式和数据响应式相关的内容，只是一下编程技巧的内容，而之所以有这一节是为了我们的代码结构更贴近 Vue2 源码的实现。通过这一节的实现，我们也可以知道发布订阅模式是如何在 Vue2 数据响应式中实现的。
那么从发布订阅模式的角度来看所谓 Observer 类，其实是一个发布者或者叫被观察者，虽然它的类命叫 Observer 翻译过叫观察者，但从观察者模式的角度来看，它不能叫观察者，因为它并没有向哪个被观察者进行订阅操作。但它又不是一个纯粹的发布者，它主要作用是将数据对象转换为响应式对象，使得当数据发生变化时能够触发相应的更新操作，它同时通过递归遍历数据对象中的所有属性，为每个属性设置 getter 和 setter 来实现数据的劫持和监听，从功能上来看它是在观察自己的属性。
从代码结构上来看，它的发布订阅模式的实现跟传统标准的发布订阅模式的结构还是存在很大差别的，但正如我们上篇文章中所说的那样，我们并不能从代码结构上去判断是否属于什么模式，而是从代码意图去判断。
订阅者中介实现
我们知道 Vue2 中的订阅者是通过 Watcher 类来实现的，也就是我们上一篇文章中所讲的订阅者中介。
我们先实现一个订阅者中介：
class Watcher {
constructor(fn) {
// 让每个订阅者所需要做的事情通过参数的形式传进来，这样更灵活，拓展性更强
this.getter = fn
// 初始化的时候直接读取触发订阅者收集，因为这样设计符合 web 应用的特性
this.get()
}
get() {
// 通过 Dep.target 来设置当前的订阅者是谁
Dep.target = this
this.getter()
Dep.target = null
}
// 接受发布者通知的更新方法
update() {
this.getter()
}
}
我们这里设计的订阅者中介类的实现跟我们上一篇中的订阅者中介类的实现，最大的不同就是，这里的设计需要在初始化的时候就要去执行一次订阅者所传的参数函数，因为在 web 应用应用中，应用需要初始化。
我们在实例化订阅者的时候，就把该订阅者需要做的事情当成参数传进去：
new Subscriber(() => {
console.log(`郭靖收到的公众号文章：${weChatOfficialAccount.article}`)
})
同时 Dep 类的 notify 方法也需要修改一下：
class Dep {
// 通知订阅者
notify() {
- this.subs.forEach(sub => sub())
+ this.subs.forEach(sub => sub.update())
}
}
defineReactive 函数也需要修改：
- // 订阅者中间变量
- let activeEffect
// 通过闭包把劫持的属性值进行缓存
function defineReactive(data, key, val) {
// 省略 ...
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
- if (activeEffect){
+ if (Dep.target){
- dep.addSub(activeEffect)
+ dep.addSub(Dep.target)
// 如果存在 childOb 则说明属性值是一个对象，则也需要对该对象进行订阅者收集，从发布订阅模式的角度看，这是一个订阅操作
- if (childOb) childOb.dep.addSub(activeEffect)
+ if (childOb) childOb.dep.addSub(Dep.target)
}
return val
},
set(newVal) {
// 省略 ...
}
})
}
这样我们就可以很方便通过一下进行测试了：
// 定义公众号
const weChatOfficialAccount = {
// 文章内容
article: '',
author: '',
date: '',
arr: ['掘金']
}
observe(weChatOfficialAccount)
// 初始化订阅者
new Watcher(() => {
console.log(`收到的公众号文章：${weChatOfficialAccount.arr.join('====')}`)
})
// 公众号发布文章则直接通过给属性赋值的方式
weChatOfficialAccount.arr.push('通过 Object.defineProperty 方法实现订阅发布模式')
打印结果如下：
小结
Dep 和 Watcher 互为订阅者
我们通过上文知道 Dep 类其实是一个消息代理或者叫事件总线，而 Watcher 则是一个订阅者，但我们前面也留了一个引子，说它们还有一层关系，就是互为订阅者。那么既然 Dep 和 Watcher 互为订阅者，也就是说它们其实也是一个发布者的角色。所以现实系统中的应用远远要比我们所学的所谓标准模式要复杂得多。
我们知道在 Vue2 中可以通过 Options 选项设置 watcher 来实现对响应式数据的监听，其实还可以通过 this.$watcher() 来实现对响应式数据的监听，使用方法都是一样的，唯一的不同就是 this.$watcher() 会返回一个函数，这个函数的作用就是停止对响应式数据的监听。
那么要实现停止对响应式数据的监听则需要知道那些 Dep 记录了当前的 Watcher，我们就需要通知那些 Dep 取消订阅当前的 Watcher。那么要实现这个功能，就需要 Watcher 也进行记录自己订阅了哪些 Dep，当取消对响应式数据的监听的时候，就从当前 Watcher 的订阅记录里去通知那些 Dep 取消自己的订阅。
比如说我们在 Vue2 当中有这么一个功能：
const unwatch = this.$watch(function(){
return this.name + this.age + this.sex
}, function(newValue, oldValue){
console.log('新值为：', newValue)
console.log('旧值为：', oldValue)
if (newValue === 'cobyte') {
// 停止监听
unwatch()
}
})
我们接下来去实现这个功能，也就是实现 Vue2 的 $watcher() 功能。以下是 Vue2 官网对 $watcher API 的一些参数和功能的介绍。
-
[vm.$watch( expOrFn, callback, options )]
-
参数：
-
{string | Function} expOrFn -
{Function | Object} callback -
{Object} [options]{boolean} deep{boolean} immediate
-
-
返回值：
{Function} unwatch -
用法：
观察 Vue 实例上的一个表达式或者一个函数计算结果的变化。回调函数得到的参数为新值和旧值。表达式只接受简单的键路径。对于更复杂的表达式，用一个函数取代。
这个 $watcher 的功能从发布订阅模式的角度可以看成是，第一个参数是订阅者要做的事情，第二个参数是在做完事情后拿到结果再通过第二参数输出结果，而且是每次所依赖的响应式数据发生变化后都需要执行第二个参数函数，输出新的结果。
那么我们先实现下面的功能：
new Watcher(function() {
return `要做的事情，获取文章：${weChatOfficialAccount.article}`
}, function(newValue, oldValue) {
console.log(`新结果是：${newValue}，旧结果是：${oldValue}`)
})
我们对 Watcher 类做以下修改：
class Watcher {
- constructor(fn) {
+ constructor(fn, cb) {
+ this.cb = cb
// 让每个订阅者所需要做的事情通过参数的形式传进来，这样更灵活，拓展性更强
this.getter = fn
// 初始化的时候直接读取触发订阅者收集，因为这样设计符合 web 应用的特性
- this.get()
+ this.value = this.get()
}
get() {
+ let value
// 通过 Dep.target 来设置当前的订阅者是谁
Dep.target = this
+ value = this.getter()
Dep.target = null
+ return value
}
// 接受发布者通知的更新方法
update() {
// 获取新值
- this.getter()
+ const value = this.getter()
+ // 设置旧值
+ const oldValue = this.value
+ // 更新值
+ this.value = value
+ if (this.cb) {
+ // 因为是用户写的，有可能存在错误
+ try {
+ this.cb(value, oldValue)
+ } catch(err) {
+ throw err
+ }
+ }
}
}
我们进行测试：
weChatOfficialAccount.article = '第一次更新'
weChatOfficialAccount.article = '第二次更新'
测试结果如下：
我们看到正确打印了结果。
有了以上的基础功能，接下来我们就很容易实现 $watcher API，代码如下：
function $watcher(expOrFn, cb) {
const watcher = new Watcher(expOrFn, cb)
}
我们知道 $watcher API 是有很多配置选项的，也就是第三个参数，比如立即执行回调就是通过第三个参数配置 immediate 为 true 来实现的，下面我们也来实现它：
function $watcher(expOrFn, cb, options) {
// 因为 options 有可能不存在，要做兼容处理
options = options || {}
const watcher = new Watcher(expOrFn, cb, options)
// 如果 immediate 为 true 则立即执行回调函数
if (options.immediate) {
try {
cb(watcher.value)
} catch (error) {
throw new Error(error)
}
}
}
在 Vue2 中 Watcher 实例是分为系统的 Watcher 和用户的 Watcher 的，像我们在组件里面通过配置 watcher，就是用户的 Watcher，怎么体现区分呢？我们下面来设置，其实也很简单：
function $watcher(expOrFn, cb, options) {
// 因为 options 有可能不存在，要做兼容处理
options = options || {}
+ // 设置用户级的 Watcher
+ options.user = true
const watcher = new Watcher(expOrFn, cb, options)
// 如果 immediate 为 true 则立即执行回调函数
if (options.immediate) {
try {
cb(watcher.value)
} catch (error) {
throw new Error(error)
}
}
}
接着修改 Watcher 类：
class Watcher {
- constructor(fn, cb){
+ constructor(fn, cb, options) {
+ if (options) {
+ this.user = !!options.user
+ } else {
+ this.user = false
+ }
// 省略...
}
update() {
// 省略...
- if (this.cb) {
+ if (this.user) {
// 省略...
}
}
}
修改也很简单，从上面的修改可以看得出，只有用户级的 Watcher 才会在更新的时候执行回调函数。
接下来我们测试立即回调功能：
$watcher(function() {
return `要做的事情，获取文章：${weChatOfficialAccount.article}`
}, function(newValue, oldValue) {
console.log(`新结果是：${newValue}，旧结果是：${oldValue}`)
}, { immediate: true })
我们可以看到初始化的时候，就立即执行回调函数了。
立即执行，旧值为 undefined，符合如期。
实现了上面的基础部分的功能，我们就可以实现重要的功能了，取消订阅。
function $watcher(expOrFn, cb, options) {
// 省略...
+ // 返回一个可以取消订阅的函数
+ return function unwatchFn () {
+ watcher.teardown()
+ }
}
我们这里通过 Watcher 实例对象的 treardown 方法去取消订阅，其实是要去通知那些记录了该 Watcher 的 Dep 去删除其记录中的该 Watcher。那么我们怎么知道哪些 Dep 记录该 Watcher 呢？所以我们就需要在 Watcher 中记录其订阅了的 Dep。从发布订阅模式的角度来说就是 Dep 要对 Watcher 进行订阅，Dep 是订阅者，Watcher 是发布者，而我们之前是 Watcher 对相关的属性的 Dep 进行订阅，Watcher 是订阅者，相关属性的 Dep 是发布者。
我们首先对 Watcher 实现发布订阅的功能，代码迭代如下：
class Watcher {
constructor(fn, cb, options) {
// 省略...
+ this.deps = []
// 省略...
}
+ addDep(dep) {
+ this.deps.push(dep)
+ }
+ // 取消订阅
+ teardown() {
+ let i = this.deps.length
+ while (i--) {
+ this.deps[i].removeSub(this)
+ }
+ }
}
我们这里的取消订阅是通过 Watcher 所记录的 Dep 实例对象去执行 Dep 上的 removeSub 方法去把自己删除，这样将来 Dep 触发更新的时候，就通知不了自己了，也就执行不了 update 方法了。
接下来我们实现 Dep 类上的 removeSub 方法，迭代代码如下：
class Dep {
// 省略..
+ // 取消订阅
+ removeSub (sub) {
+ // 找到需要取消的订阅者
+ const index = this.subs.indexOf(sub)
+ if (index > -1) {
+ // 删除订阅者
+ this.subs.splice(index, 1)
+ }
+ }
// 省略...
}
我们可以看到 Dep 类中的取消订阅功能，跟普通发布订阅中的取消订阅功能是一样的。
我们前面已经实现了 Dep 对 Watcher 的订阅，那么接下来就是 Watcher 怎么对 Dep 进行订阅了。我们知道不管是什么数据类型都是在 getter 中进行依赖收集的，所以要实现 Watcher 对 Dep 的订阅，也要从 getter 开始。我们在 getter 里面可以通过 Dep.target 获取到当前的 Watcher，也可以获取到当前属性对应的 Dep 实例对象，那么就可以互相添加订阅者了。
代码迭代如下：
function defineReactive(data, key) {
// 省略...
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
if (Dep.target){
dep.addSub(Dep.target)
+ // 通过 Dep.target 就可以添加 Watcher 对应的 Dep 了
+ Dep.target.addDep(dep)
if (childOb){
childOb.dep.addSub(Dep.target)
+ // 通过 Dep.target 就可以添加 Watcher 对应的 Dep 了
+ Dep.target.addDep(childOb.dep)
}
}
return val
},
// 省略...
})
}
接下来我们就可以进行测试了：
const unwatch = $watcher(function(){
return weChatOfficialAccount.article + weChatOfficialAccount.author
}, function(newValue, oldValue) {
console.log('新值为：', newValue)
console.log('旧值为：', oldValue)
if (newValue === 'cobyte') {
// 停止监听
unwatch()
}
})
console.log('会打印新值旧值')
weChatOfficialAccount.article = 'co'
console.log('会打印新值旧值')
weChatOfficialAccount.author = 'byte'
console.log('不会打印新值旧值')
weChatOfficialAccount.article = 'cobyte'
我们发现如期打印了我们期待的结果：
我们上面在 getter 中对 Dep 和 Watcher 进行相互订阅的操作，还可以进行优化一下，让代码更优雅。
class Dep {
// 省略...
+ // 通过 depend 方法进行依赖收集
+ depend() {
+ if (Dep.target) {
+ // 在 Dep 中进行 Watcher
+ Dep.target.addDep(this)
+ }
+ }
// 省略...
}
接着在 Watcher 中调用 Dep 的方法添加自己
class Watcher {
// 省略...
addDep(dep) {
this.deps.push(dep)
+ // 调用 Dep 实例的添加订阅方法添加自己
+ dep.addSub(this)
}
// 省略...
}
接着我们修改 getter 中代码：
function defineReactive(data, key) {
// 省略...
Object.defineProperty(data, key, {
get() {
// 存在订阅者中间变量就进行订阅者添加
if (Dep.target){
- dep.addSub(Dep.target)
- // 通过 Dep.target 就可以添加 Watcher 对应的 Dep 了
- Dep.target.addDep(dep)
+ dep.depend()
if (childOb){
- childOb.dep.addSub(Dep.target)
- // 通过 Dep.target 就可以添加 Watcher 对应的 Dep 了
- Dep.target.addDep(childOb.dep)
+ childOb.dep.depend()
}
}
return val
},
// 省略...
})
}
经过我们的重构，getter 中的依赖收集相关代码变得清晰多了。
总结
从发布订阅模式的角度来理解 Vue 的数据响应式原理，就是发布订阅模式的具体运用的过程。
上述文章写于：2023 年，由于个人原因今年 2026 年发布。
我是程序员Cobyte，现在已转向研究 AI Agent，欢迎添加 v: icobyte，学习交流 AI Agent 应用开发。
