08_实现 reactive

目录

编写 reactive 的函数签名

前面我们已经实现了一个基础的响应式数据,但是这是一种比较简陋的方法,而且使用起来书写相对繁琐,所以我们先构造一个 reactive 的函数签名,如下:

javascript 复制代码
function get(target, key, receiver) {
	track(target, key)
	return Reflect.get(target, key, receiver)
}

function set(target, key, newVal) {
	target[key] = newVal
	trigger(target, key)
	return true
}

function reactive(value) {
  // 简单做一个基础拦截
  if (typeof value !== 'object' || value === null) {
		console.warn('value 必须是一个对象')
		return value
	}
  
	const proxy = new Proxy(value, { get, set })
	return proxy
}

const state = reactive({ name: 'zs', age: 18 })

effect(() => {
	console.log(`${state.name}今年${state.age}岁了`)
})

state.age++

上述这段代码中,我们将 get 和 set 的逻辑抽离了出去,这样代码会更优雅一点,同时简单的封装了一下 reactive,创建一个可响应的数据也方便一点。

处理对象的其他行为

这个行为具体的可以查阅文档得知:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#object_internal_methods

拦截 in 操作符

前面我们处理的只有 get 和 set,也简单的把 get 就看做是读,set 看做是写,而在响应式系统中,读是一个宽泛的概念,比如 in 操作符也是一个读的操作,例如:

javascript 复制代码
effect(()=>{
  'foo' in obj
})

而这种读的操作,在响应式系统中也应该被拦截,而如果想拦截 in 这个读的操作,就需要使用内部方法 [[HasProperty]],而这个内部方法在 Proxy 中对应的则是 has,这些在 ECMA 或者 MDN 文档中都可以找到,有兴趣的自行翻阅即可。

已经知道了对应的拦截器,那实现也就非常简单了,如下:

javascript 复制代码
function has(target, key) {
  console.log('in 被拦截了')
	track(target, key)
	return Reflect.has(target, key)
}

function reactive(value) {
	if (typeof value !== 'object' || value === null) {
		console.warn('value 必须是一个对象')
		return value
	}
	const proxy = new Proxy(value, { get, set, has })
	return proxy
}

const state = reactive({ name: 'zs', age: 18 })
effect(() => {
	'age' in state
})

我们来查看一下输出的结果,如图:

拦截 for...in 循环

for...in 循环对应的内部方法为 [[OwnPropertyKeys]],对应 Proxy 中的 ownKeys,我们先看一下实现代码,如下:

javascript 复制代码
const ITERATE_KEY = Symbol('iterate')
function ownKeys(target) {
	// 手动构造了一个 key,让其与副作用函数关联
	track(target, ITERATE_KEY)
	return Reflect.ownKeys(target)
}

在这段代码中,与之前不一样的则是,手动的创建一个 key,这是为什么呢?我们设计响应式依赖收集数据结构中,需要一个 key,而 ownKeys 方法确并没有提供 key 的参数,只有 target,为什么不提供 key 呢,合理吗?

其实是合理的,因为不同于 get/set 的操作,我们总能精准的知道,当前读取的是对象的那个属性,而 ownKeys 则是用来获取一个对象的所有属于自己的键值,这个操作是没有和任何具体的键值进行绑定,所以不提供 key 是合理的。

因此我们如果想复合我们设计的数据结构,只有手动的构造一个 key 来实现依赖的关联。

那我们来看看,是否现在可以达到我们预期的效果,代码如下:

javascript 复制代码
const state = reactive({ name: 'zs', age: 18 })
effect(() => {
	for (const key in state) {
		console.log(key)
	}
})
state.address = 'shanghai'

这段代码,我们的预期是先输出 name、age,然后添加了一个 address 时,肯定会对 for...in 循环产生印象,那么应该在输出一个 address,我们看一下执行的结果,如图:

预期中的 address 并没有出现,这是为什么呢?因为这一部分触发的其实 set,我们给 set 方法添加一句打印,如下:

javascript 复制代码
function set(target, key, newVal) {
	console.log('set: ', key)
	target[key] = newVal
	trigger(target, key)
	return true
}

查看一下运行结果,如图:

但是在 set 中触发,key 是 address,这和我们设置的 ITERATE_KEY 是一点关系都没有,所以应该如何触发呢?我们可以尝试给 ITERATE_KEY 单开一个 Set 集合在执行即可,如下:

javascript 复制代码
function trigger(target, key) {
	let depsMap = targetMap.get(target)
	if (!depsMap) return
	let deps = depsMap.get(key)
	// 取得 ITERATE_KEY 的依赖
	let iterateDeps = depsMap.get(ITERATE_KEY)

	const effetsToRun = new Set()
	deps &&
		deps.forEach(effectFn => {
			if (effectFn !== activeFn) {
				effetsToRun.add(effectFn)
			}
		})
	// 除了加入当前 key 的依赖,还要加入 ITERATE_KEY 的依赖
	iterateDeps &&
		iterateDeps.forEach(effectFn => {
			if (effectFn !== activeFn) {
				effetsToRun.add(effectFn)
			}
		})

	effetsToRun.forEach(fn => {
		if (fn.options && fn.options.scheduler) {
			fn.options.scheduler(fn)
		} else {
			fn()
		}
	})
}

此时我们写一段测试代码,如下:

javascript 复制代码
const state = reactive({ name: 'zs', age: 18 })
effect(() => {
	for (const key in state) {
		console.log(key)
	}
})
console.log('*****添加******')
state.address = 'shanghai'

结果如图:

但是现在还有一个问题,就是无差别触发,比如我重新修改年龄,那么此时并不会对这个迭代行为产生影响,那么就不应该触发,所以我们需要识别 set 触发时,当前的 key 是新增的还是重新赋值,基于这点我们就可以优化一下代码,如下:

javascript 复制代码
function trigger(target, key, type) {
	let depsMap = targetMap.get(target)
	if (!depsMap) return
	let deps = depsMap.get(key)

	const effetsToRun = new Set()
	deps &&
		deps.forEach(effectFn => {
			if (effectFn !== activeFn) {
				effetsToRun.add(effectFn)
			}
		})

	// 只有添加属性才会触发 ITERATE_KEY 的副作用函数
	if (type === 'ADD') {
		let iterateDeps = depsMap.get(ITERATE_KEY)
		iterateDeps &&
			iterateDeps.forEach(effectFn => {
				if (effectFn !== activeFn) {
					effetsToRun.add(effectFn)
				}
			})
	}

	effetsToRun.forEach(fn => {
		if (fn.options && fn.options.scheduler) {
			fn.options.scheduler(fn)
		} else {
			fn()
		}
	})
}

/* ... */

function set(target, key, newVal, receiver) {
	// 根据当前对象有没有这个 key 来区分是新增还是修改
	const type = Object.prototype.hasOwnProperty.call(target, key) ? 'SET' : 'ADD'
	const result = Reflect.set(target, key, newVal, receiver)
	if (!result) return
	trigger(target, key, type)
	return result
}

/* ... */

const state = reactive({ name: 'zs', age: 18 })
effect(() => {
	for (const key in state) {
		console.log(key)
	}
})
console.log('*****修改******')
state.age++
console.log('*****添加******')
state.sex = '男'

查看一下输出的结果,如图:

此时就是符合我们预期的,修改不触发,添加才触发。

当然,为了更好的维护,我们通常会将这个维护成一个枚举值,如下:

delete 操作符

delete 在 Proxy 对应的方法则是 deleteProperty,因此我们在其中书写对应的逻辑即可,如下:

javascript 复制代码
function deleteProperty(target, key) {
	// 检测属性是否存在
	const hadKey = Object.prototype.hasOwnProperty.call(target, key)
	const result = Reflect.deleteProperty(target, key)
	// 属性存在和删除成功,则触发依赖
	if (hadKey && result) {
		trigger(target, key, TriggerType.DELETE)
	}
	return result
}

这里其他的没有特殊的地方,唯有在 trigger 的时候,我们传递了一个类型,这是因为当属性删除的时候,也会印象 for...in 的迭代行为,所以需要这个类型,如下:

javascript 复制代码
function trigger(target, key, type) {
	let depsMap = targetMap.get(target)
	if (!depsMap) return
	let deps = depsMap.get(key)

	const effetsToRun = new Set()
	deps &&
		deps.forEach(effectFn => {
			if (effectFn !== activeFn) {
				effetsToRun.add(effectFn)
			}
		})

	// 添加判断条件
	if (type === TriggerType.ADD || type === TriggerType.DELETE) {
		let iterateDeps = depsMap.get(ITERATE_KEY)
		iterateDeps &&
			iterateDeps.forEach(effectFn => {
				if (effectFn !== activeFn) {
					effetsToRun.add(effectFn)
				}
			})
	}

	effetsToRun.forEach(fn => {
		if (fn.options && fn.options.scheduler) {
			fn.options.scheduler(fn)
		} else {
			fn()
		}
	})
}

那么基于修改后的代码我们可以来测试一下,测试1,如下:

javascript 复制代码
const state = reactive({ name: 'zs', age: 18, sex: '男' })
effect(() => {
	console.log('effect', state.sex)
})

delete state.sex

结果如图:

是达到我们的预期了,在来看看第二个情况,如下:

javascript 复制代码
const state = reactive({ name: 'zs', age: 18, sex: '男' })
effect(() => {
	for (const key in state) {
		console.log('effect: ', key)
	}
})
console.log('************')
delete state.sex

结果如图:

也是符合我们的预期的,成功触发了 for...in 的迭代行为。

处理边界

新旧值发生变化时才触发依赖的情况

现在我们的只要触发了 set 就会进行依赖的派发,而在正确的逻辑中,如果新旧值不一样,则无需触发,我们写一段代码测试一下,如下:

javascript 复制代码
const state = reactive({ name: 'zs', age: 18, sex: '男' })
effect(() => {
	console.log('effect:', state.age)
})
state.age = 18

测试结果如图:

所以我们需要对触发的新旧值进行判断,代码如下:

javascript 复制代码
function set(target, key, newVal, receiver) {
	// 获取旧值
	const oldVal = target[key]

	const type = Object.prototype.hasOwnProperty.call(target, key) ? TriggerType.SET : TriggerType.ADD
	const result = Reflect.set(target, key, newVal, receiver)
	if (!result) return

	// 新旧值不相等,则触发依赖
	if (oldVal !== newVal) {
		trigger(target, key, type)
	}

	return result
}

我们在执行一样的测试代码,如图:

现在我们使用的判断是 ===,这个方式是会存在一些问题的,我们看一段测试结果,如下:

javascript 复制代码
console.log(NaN === NaN) // false
console.log(+0 === -0) // true
console.log(Object.is(NaN, NaN)) // true
console.log(Object.is(+0, -0)) // false

一个值从 NaN 变为 NaN 不会对我们的结果产生影响,所以要看做一样的值,而 +0 和 -0 则会影响,比如在某些数学运算和函数中,+0-0 可能会产生不同的结果。例如,在某些情况下,计算 1 / +01 / -0 会得到正无穷大和负无穷大,所以应该是不一样的,因此这里需要将 === 换成 Object.is 判断,如下:

javascript 复制代码
function set(target, key, newVal, receiver) {
	const oldVal = target[key]

	const type = Object.prototype.hasOwnProperty.call(target, key) ? TriggerType.SET : TriggerType.ADD
	const result = Reflect.set(target, key, newVal, receiver)
	if (!result) return

	if (!Object.is(oldVal, newVal)) {
		trigger(target, key, type)
	}

	return result
}

处理从原型上继承属性的情况

话不多说,我们看一段测试代码,如下:

javascript 复制代码
const obj = {}
const proto = { bar: 1 }

const child = reactive(obj)
const parent = reactive(proto)
// 将 parent 作为 child 的原型
Object.setPrototypeOf(child, parent)

effect(() => {
	console.log(child.bar)
})
child.bar = 2

执行结果如图:

从结果不难发现,修改 bar 的值之后,竟然触发了两次副作用函数,这是为什么呢?让我们顺着代码的执行过程来解析一下。

首先我们知道,如果一个对象身上没有某个属性的话,会顺着原型链网上查找,这里 child.bar 实际上是 parent.bar 的值,所以输出的值是1,而这个查找的过程,第一次查找 child 时就会触发 child 的 get 拦截,此时 key 为 bar,我们的 child 时一个响应式数据,就会发生一次依赖的收集;而在 child 上没有找打,则去查找 parent,那么 parent.bar 也是一个读取行为,则也会触发 parent 的 get 拦截,且 parent 也是一个响应式数据,那么也会造成一次依赖的收集,此时就会导致收集的依赖关系如下:

javascript 复制代码
child
	|--bar
			|--effect
parent
	|--bar
			|--effect

不过这些还不足以解释为什么会触发两次,那么我们再来看 child.bar = 2 这句代码会发生什么事情。

首先设置 bar 的值时候,一定会触发一次 child 的 set 拦截,这里就可以知道次数 +1,哪还有一次从何而来呢?

关于这一段,在 ECMA 中可以找到调用内部方法 [[Set]] 时的执行过程,如图:

这一段解释的意思大概是,如果设置的属性不存在于对象上的话,则会取得其原型,并调用原型的 [[Set]] 方法,也就是 parent 的 [[Set]] 内部方法吗,而由于 parent 也是一个响应式数据,那么也会也会触发一次 set 拦截,而前面我们也分析了依赖收集的关系,parent 也收集了这个 bar 属性,看到这里就很明显了,这就是第二次执行的由来。

知道了问题之后,我们就可以思考如何解决。尽然是两次执行,我们只需要屏蔽掉其中一次即可,而具体屏蔽那一次,肯定是除第一次之后的都屏蔽掉,因为原型只要想,这个链条上可以不止两个。

那如何让其只执行第一次呢?这个我们就要把视线回到 receiver 上,我们来看一下不同时候触发的 set 的拦截里面 receiver 都是那个,我们添加一句打印,如下:

javascript 复制代码
function set(target, key, newVal, receiver) {
	console.log('set-target: ', target)
	console.log('set-receiver: ', receiver)
  
	const oldVal = target[key]

	const type = Object.prototype.hasOwnProperty.call(target, key) ? TriggerType.SET : TriggerType.ADD
	const result = Reflect.set(target, key, newVal, receiver)
	if (!result) return

	if (!Object.is(oldVal, newVal)) {
		trigger(target, key, type)
	}

	return result
}

// 为了方便查看打印,添加一个 name 属性表示
const obj = { name: 'obj' }
const proto = { bar: 1, name: 'proto' }

const child = reactive(obj)
const parent = reactive(proto)
Object.setPrototypeOf(child, parent)

effect(() => {
	console.log(child.bar)
})
child.bar = 2

打印结果如图:

通过这个打印可以看到,target 第一次是 obj 原始对象,第二次为 proto 原始对象,而反之 receiver 两次都是代理对象 child,因此我们只要添加一个判断条件,当 receiver 这个代理的原始对象等于 target 那么才触发更新,如果不是则表示是原型上的,则不派发。

有了这个思路之后,我们的问题就是,如何在代理身上得到代理的原始对象,不幸的是,原生的 proxy 并没有提供这样的属性,但是我们可以自己解决,代码如下:

javascript 复制代码
// 获取原始对象时的 key
const RAW_KEY = Symbol('raw')

function get(target, key, receiver) {
	// 只要 key 为 RAW_KEY,就返回原始对象
	if (key === RAW_KEY) {
		return target
	}

	track(target, key)
	return Reflect.get(target, key, receiver)
}

有了这个 RAW_KEY 之后,就可以在代理身上拿到其所代理的原始对象,代码如下:

javascript 复制代码
function set(target, key, newVal, receiver) {
	const oldVal = target[key]

	const type = Object.prototype.hasOwnProperty.call(target, key) ? TriggerType.SET : TriggerType.ADD
	const result = Reflect.set(target, key, newVal, receiver)
	if (!result) return

	// receiver[RAW_KEY] 表示所代理原始对象,若两者相等则表示 receiver 是 target 的代理对象
	if (receiver[RAW_KEY] === target) {
		if (!Object.is(oldVal, newVal)) {
			trigger(target, key, type)
		}
	}

	return result
}

/* ... */

const obj = {}
const proto = { bar: 1 }

const child = reactive(obj)
const parent = reactive(proto)
Object.setPrototypeOf(child, parent)

effect(() => {
	console.log(child.bar)
})
console.log('*****修改*****')
child.bar = 2

结果如图:

现在触发的次数就正常了。

处理一个对象已经是代理对象的情况

如果当一个对象已经是代理对象了,那么按照逻辑来说,就应该直接返回这个代理对象,而不需要在做一次代理,而实现这一点也很简单,可以参考设置 RAW_KEY 的方式,如下:

javascript 复制代码
// 添加是否是代理对象的标识 key
const IS_REACTIVE = Symbol('isReactive')

function reactive(value) {
	if (typeof value !== 'object' || value === null) {
		console.warn('value 必须是一个对象')
		return value
	}
  
  if()

	const proxy = new Proxy(value, { get, set, has, ownKeys, deleteProperty })

	// 给完成代理的对象添加一个标识,表示是一个代理对象
	proxy[IS_REACTIVE] = true

	return proxy
}

// 判断一个值是否是响应式对象
function isReactive(value) {
	return typeof value === 'object' && value !== null && !!value[IS_REACTIVE]
}

/* ... */

const o1 = reactive({
	name: 'zs'
})
const o2 = reactive(o1)
const o3 = reactive({
	name: 'zs'
})
console.log(o1 === o2) // true
console.log(o1 === o3) // false

o1 等于 o2 就表示了不会对本身就是一个代理对象的数据进行二次代理。

处理一个原始对象已经被代理过一次之后的情况

若一个原始对象 obj 已经被代理过一次之后,再次使用代理的时候,也不应该在进行代理,而是返回之前代理完成的对象,代码如下:

javascript 复制代码
// 缓存已经代理过的对象
const reactiveMap = new WeakMap()

function reactive(value) {
	if (typeof value !== 'object' || value === null) {
		console.warn('value 必须是一个对象')
		return value
	}

	// 以 value 为 key,从缓存中取出对应的代理对象,如果有责返回缓存的代理对象,不然进行代理
	if (reactiveMap.has(value)) {
		return reactiveMap.get(value)
	}

	if (isReactive(value)) return value

	const proxy = new Proxy(value, { get, set, has, ownKeys, deleteProperty })
	proxy[IS_REACTIVE] = true

	// 将代理好的对象缓存起来
	reactiveMap.set(value, proxy)

	return proxy
}

const obj = { name: 'zs' }
const p1 = reactive(obj)
const p2 = reactive(obj)
console.log(p1 === p2) // true

p1 与 p2 相等,则表示没有重复对同一个原始对象进行代理。

浅响应与深响应

我们来看一段示例代码:

javascript 复制代码
const obj = {
	foo: {
		bar: 1
	}
}
const p1 = reactive(obj)

effect(() => {
	console.log(p1.foo.bar)
})

console.log('*****修改******')
p1.foo.bar = 2

再来看一下输出的结果,如图:

修改 p1.foo.bar 的值并没有导致副作用函数再次执行,那么就表示目前我们的 reactive 还是一个浅响应的,foo 的值还是一个普通对象,而非代理的响应式对象,因此我们需要给它变成响应式对象。

这点我们可以在 get 拦截器中完成,当检测到 Reflect.get 返回的值是一个对象时,那么就再次进行代理,完成递归式的处理,不过我们这个行为是的,只要当用到了这个属性才会被深度代理,如下:

javascript 复制代码
function get(target, key, receiver) {
	if (key === RAW_KEY) {
		return target
	}
	track(target, key)

	// 得到本次获取的原始值
	const result = Reflect.get(target, key, receiver)
	// 若是一个对象则进行代理,否则直接返回此值
	if (typeof result === 'object' && result !== null) {
		return reactive(result)
	}
	return result
}

现在我们在运行上面的例子,查看一下结果,如图:

但是并不是是什么时候都需要进行深度响应,此时我们就需要一个方法来完成只进行浅响应,基于这个情况,shallowReactive 应运而生,基于此我们可以将 reactive 函数在做一层封装,将其抽离出来,如下:

javascript 复制代码
// 因为是抽离出来的 get,所以如果想拿到 isShallow 的值,就需要在封装一层
function baseGet(isShallow) {
	return function get(target, key, receiver) {
		if (key === RAW_KEY) {
			return target
		}
		track(target, key)

		const result = Reflect.get(target, key, receiver)

		// 如果 isShallow 为 true 表示只需要做到浅响应即可,因此直接返回 result 即可
		if (isShallow) return result

		if (typeof result === 'object' && result !== null) {
			return reactive(result)
		}
		return result
	}
}

// 深响应
function reactive(value) {
	return createReactiveObject(value)
}

// 浅响应
function shallowReactive(value) {
	return createReactiveObject(value, true)
}

// 将逻辑再做一次抽离,放入 createReactiveObject 函数中
//  - 使用 isShallow 参数来区分是深响应还是浅响应,默认为 false 表示进行深响应处理
function createReactiveObject(value, isShallow = false) {
	if (typeof value !== 'object' || value === null) {
		console.warn('value 必须是一个对象')
		return value
	}
	if (reactiveMap.has(value)) {
		return reactiveMap.get(value)
	}
	if (isReactive(value)) return value

	// 通过 baseGet 返回具体的 get 拦截回调函数
	const proxy = new Proxy(value, { get: baseGet(isShallow), set, has, ownKeys, deleteProperty })
	proxy[IS_REACTIVE] = true
	reactiveMap.set(value, proxy)
	return proxy
}

添加一段测试代码看看是否完成了浅响应,如下:

javascript 复制代码
const obj = {
	a: {
		b: 100
	}
}
const p1 = shallowReactive(obj)
effect(() => {
	console.log(p1.a.b)
})
console.log('*****修改******')
p1.a.b++

查看结果,看看是否修改值之后是否会触发更新,如图:

我们在测试一下只修改第一层的属性是否会发生更新,代码如下:

javascript 复制代码
const obj = {
	a: 1
}
const p1 = shallowReactive(obj)
effect(() => {
	console.log(p1.a)
})
console.log('*****修改******')
p1.a++

结果如图:

代理数组

JavaScript 中万物皆对象,分为常规对象和异质对象,Proxy 就是一个异质对象,而数组也是。

所以需要针对数组进行单独的处理,但是因为也是对象,所以之前大部分的实现都是可用的,如下:

javascript 复制代码
const arr = [1, 2, 3]
const a1 = reactive(arr)

effect(() => {
	console.log('effect: ', a1[0])
})

a1[0] = 4

测试结果如图:

数组的索引与 length

通过前文我们知道,通过索引访问是可以建立响应式关系的,但是如果设置的索引大于当前数组的 length,则会导致隐式的修改了 length 的值,如下:

javascript 复制代码
const arr = [1]
const a1 = reactive(arr)

effect(() => {
	console.log('effect: ', a1.length)
})

// 设置索引为1的值,则长度也变为 2
a1[1] = 4
console.log(a1.length)

但是目前这样并不会触发副作用函数的重新执行,所以我们需要自己来进行一些处理,通过这个例子我们可以知道,当设置的索引大于或者等于数组的长度的时候,就是新增的,所以操作类型,我们还需要针对数组做一层判断,如下:

javascript 复制代码
// 表示这些key忽略
const noWarnKey = [RAW_KEY, IS_REACTIVE, ITERATE_KEY]
function baseSet(isReadonly) {
	return function set(target, key, newVal, receiver) {
		const oldVal = target[key]
		const type = Array.isArray.isArray(target)
			? // 如果代理的目标是数组,则检测 key 是否小于 target.length
			  // 如果小于,则修改的是数组中已经存在的元素,触发 SET 事件,否则触发 ADD 事件
			  key < target.length
				? TriggerType.SET
				: TriggerType.ADD
			: Object.prototype.hasOwnProperty.call(target, key)
			? TriggerType.SET
			: TriggerType.ADD

		const result = Reflect.set(target, key, newVal, receiver)
		if (!result) return
		if (receiver[RAW_KEY] === target) {
			if (!Object.is(oldVal, newVal)) {
				trigger(target, key, type)
			}
		}

		return result
	}
}

当然,这里的判断只是一个粗浅的判断,只是为了讲清楚这个原理,实际的实现需要更换一下,如下:

javascript 复制代码
function baseSet(isReadonly) {
	return function set(target, key, newVal, receiver) {
		const oldLen = Array.isArray(target) ? target.length : undefined
		const oldVal = target[key]

		let type = Object.prototype.hasOwnProperty.call(target, key) ? TriggerType.SET : TriggerType.ADD

		const result = Reflect.set(target, key, newVal, receiver)
		if (!result) return

		const newLen = Array.isArray(target) ? target.length : undefined

		if (receiver[RAW_KEY] === target) {
			if (!Object.is(oldVal, newVal)) {
				// 设置时如果满足以下条件,则操作类型是 'ADD'
				// 1、target 是数组
				// 2、key 不是 length
				// 3、旧长度小于新长度
				if (Array.isArray(target) && key !== 'length' && newLen > oldLen) {
					type = TriggerType.ADD
				}
				// 派发更新
				trigger(target, key, type)
			}
		}

		return result
	}
}

而有了这个操作的类型之后,我们就可以进一步的修改 trigger 里面的代码,如下:

javascript 复制代码
function trigger(target, key, type) {
	let depsMap = targetMap.get(target)
	if (!depsMap) return
	let deps = depsMap.get(key)

	const effetsToRun = new Set()
	deps &&
		deps.forEach(effectFn => {
			if (effectFn !== activeFn) {
				effetsToRun.add(effectFn)
			}
		})

	// 如果是一个数组,且是新增元素
	if (Array.isArray(target) && type === TriggerType.ADD) {
		// 则去除 length 的依赖加入执行集合
		const lengthEffects = depsMap.get('length')
		lengthEffects &&
			lengthEffects.forEach(effectFn => {
				if (effectFn !== activeFn) {
					effetsToRun.add(effectFn)
				}
			})
	}

	if (type === TriggerType.ADD || type === TriggerType.DELETE) {
		let iterateDeps = depsMap.get(ITERATE_KEY)
		iterateDeps &&
			iterateDeps.forEach(effectFn => {
				if (effectFn !== activeFn) {
					effetsToRun.add(effectFn)
				}
			})
	}

	effetsToRun.forEach(fn => {
		if (fn.options && fn.options.scheduler) {
			fn.options.scheduler(fn)
		} else {
			fn()
		}
	})
}

此时在执行原来的测试代码,如图:

此时因为设置了索引导出数组长度隐式增加,也可以触发响应式了,解决完成这个,我们在来看看,直接修改 length 属性也会隐式的影响数组元素,例如:

javascript 复制代码
const arr = ['A']
const a1 = reactive(arr)

effect(() => {
	// 访问数组第一个元素
	console.log('effect: ', a1[0])
})

// 将数组的长度设置0,则会清空数组
a1.length = 0
console.log(a1.length)

测试结果如图:

此时并没有触发副作用函数的触发,因此不妨来猜想一些情况,假设将 length 设置为 100,那么会对 a1[0] 造成影响吗,并不会,也就说只有 length 设置的值小于或者等于当前索引,才应该去触发响应,而为了实现这一点,我们还需要给 trigger 传递第四个参数,如下:

javascript 复制代码
function trigger(target, key, type, newValue) {
	let depsMap = targetMap.get(target)
	if (!depsMap) return
	let deps = depsMap.get(key)
	const effetsToRun = new Set()
	addEffects(effetsToRun, deps)

	// 如果target是数组,并且 key 是 'length'
	if (Array.isArray(target) && key === 'length') {
		// 对于索引大于或者等于当前 length 的新值的元素,就将其取出并添加到 effetsToRun 中等待执行
		//  - 假设值原数组为 [1,2,3,4,5],设置 length 为 2
		//  - 那么新数组就会删减为 [1,2],则对于索引大于等于 2 的元素 [3,4,5] 就都被删除了,不存在了肯定也要触发依赖
		//  - 而对于索引小于 2 的元素 [1,2] 则是存在的,没有改变,所以不需要触发依赖
		depsMap.forEach((deps, key) => {
			if (key >= newValue) {
				addEffects(effetsToRun, deps)
			}
		})
	}

	if (Array.isArray(target) && type === TriggerType.ADD) {
		const lengthEffects = depsMap.get('length')
		addEffects(effetsToRun, lengthEffects)
	}

	if (type === TriggerType.ADD || type === TriggerType.DELETE) {
		let iterateDeps = depsMap.get(ITERATE_KEY)
		addEffects(effetsToRun, iterateDeps)
	}

	effetsToRun.forEach(fn => {
		if (fn.options && fn.options.scheduler) {
			fn.options.scheduler(fn)
		} else {
			fn()
		}
	})
}

// 将添加的逻辑抽离出来
function addEffects(effetsToRun, effects) {
	if (!effects) return
	effects.forEach(effectFn => {
		if (effectFn !== activeFn) {
			effetsToRun.add(effectFn)
		}
	})
}

function baseSet(isReadonly) {
	return function set(target, key, newVal, receiver) {
		/**/

		if (receiver[RAW_KEY] === target) {
			if (!Object.is(oldVal, newVal)) {
				if (Array.isArray(target) && key !== 'length' && newLen > oldLen) {
					type = TriggerType.ADD
				}
				// 传递第四个参数-本次修改的新值
				trigger(target, key, type, newVal)
			}
		}

		return result
	}
}

此时,我们再次运行测试代码,结果如图:

成功的触发了副作用函数,数组清空,值为 undefined 也是符合我们的预期的。

遍历数组

在日常的代码开发中,我们都会尽量避免使用 for...in 来遍历数组,但是在语法上,是支持这样遍历的,因此我们需要再之前编写的 ownKeys 方法中,在做出一些修改,之前我们为了实现 for...in 遍历一个对象,对象的属性增加或者删除都会重新触发,统一将 key 设置为了 ITERATE_KEY(Symbol('iterate')),但是这是为了适应普通对象的,所以如果是数组的话,要针对 key 做出一些处理,如下:

javascript 复制代码
function ownKeys(target) {
	// 如果是数组,则使用 length 为 key,否则使用 ITERATE_KEY
	const key = Array.isArray(target) ? 'length' : ITERATE_KEY
	track(target, key)
	return Reflect.ownKeys(target)
}

此时我们写一段测试代码测试一下:

javascript 复制代码
const arr = reactive(['A', 'B'])
effect(() => {
	console.log('effect触发')
	for (const key in arr) {
		console.log(key)
	}
})
console.log('*****修改length*****')
arr.length = 0

结果如图:

相比 for...in 来说,我们更加常用的是 for...of,而 for...of 采用的是可迭代协议,具体这块的知识在这里不做赘述,但是无需任何改动,for...of 就是可以正常工作的,因为迭代器本身就是基于数组长度和索引来迭代的,而这些在之前,我们就都已经处理好了。

不过在 for...of 会读取一次 Symbol.iterator,这个并不需要跟踪收集依赖,还需要多做一次处理,如下:

javascript 复制代码
function baseGet(isShallow, isReadonly) {
	return function get(target, key, receiver) {
		if (key === RAW_KEY) {
			return target
		}

		// 为什么直接把 symbol 去掉了呢,因为 for in 本身也不会迭代 Symbol
		if (!isReadonly && typeof key !== 'symbol') {
			track(target, key)
		}

		const result = Reflect.get(target, key, receiver)
		if (isShallow) return result

		if (typeof result === 'object' && result !== null) {
			return isReadonly ? readonly(result) : reactive(result)
		}
		return result
	}
}

测试代码如下:

javascript 复制代码
const arr = reactive(['A', 'B'])
effect(() => {
	console.log('effect触发')
	for (const item of arr) {
		console.log(item)
	}
})
console.log('*****修改length*****')
arr.length = 0

结果如图:

数组的查找方法

可以触发的部分这里就不做展示,仅展示无法触发响应的案例,如下:

javascript 复制代码
const obj = {}
const arr = reactive([obj])

console.log(arr.includes(obj)) // false

为什么存在的值,但是却表示无法找到呢?在 ECMA 规范中表明,includes 方法会通过索引获取值,而我们这里使用的是 arr,arr 是一个代理,在代理中,如果得到这个值是一个对象的话,则会对这个对象进行代理,那么这个 obj 就变为了 objProxy = Proxy(obj),这两者之间肯定是不相等的,所以这里 arr 通过 includes 查找的时候,includes 内部通过遍历取值对比,实际执行判断时 arr[0] === obj,arr[0]是objProxy ,那肯定就会返回 false,这里我们尽然说是因为再次代理的原因,是不是使用浅响应就可以找到呢,是可以的,代码如下:

javascript 复制代码
const obj = {}
const arr = shallowReactive([obj])
console.log(arr.includes(obj)) // true

// 我们也可以直接使用 arr[0] 来直接得到这个代理对象,因为之前我们处理过了,不会重复代理一个对象,所以不会得到两个代理对象,如果没有做这个,那么得到的还是 false
const obj = {}
const arr = reactive([obj])
console.log(arr.includes(arr[0])) // true

哪知道问题的原因之后应该如何解决呢?这个解决方案其实也不难,includes 内部的 this 指向的代理后的 arr,如果从这里找不到,我们从代理的原始数组里面在找一次即可,所以一次找不到,那就在找一次,也因此,我们需要重新一下 includes 方法,如下:

javascript 复制代码
// 创建对象,以重写数组方法名为 key,并绑定执行函数
const arrayInstrumentations = {}
;['includes', 'indexOf', 'lastIndexOf'].forEach(key => {
	arrayInstrumentations[key] = function (...args) {
		// this ---> proxy
		// 1、在 proxy 里面找一次
		const proxyResult = Array.prototype[key].apply(this, args)
		// 如果在代理中找到的结果为 true 或者不等于 -1,表示找到了,直接返回
		if (
			(typeof proxyResult === 'boolean' && proxyResult === true) ||
			(typeof proxyResult === 'number' && proxyResult !== -1)
		) {
			return proxyResult
		}
		// 2、在原始数组中找一次
		const rawResult = Array.prototype[key].apply(this[RAW_KEY], args)
		// 直接返回原始数组中的结果
		return rawResult
	}
})

function baseGet(isShallow, isReadonly) {
	return function get(target, key, receiver) {
		if (key === RAW_KEY) {
			return target
		}

		// 如果访问的是重新的数组方法,则直接使用重新的方法
		if (Array.isArray(target) && arrayInstrumentations.hasOwnProperty(key)) {
			return Reflect.get(arrayInstrumentations, key, receiver)
		}

		const noKeys = [IS_REACTIVE, RAW_KEY, Symbol.iterator]
		if (!isReadonly && !noKeys.includes(key)) {
			track(target, key)
		}

		const result = Reflect.get(target, key, receiver)
		if (isShallow) return result

		if (typeof result === 'object' && result !== null) {
			return isReadonly ? readonly(result) : reactive(result)
		}
		return result
	}
}

执行结果如图:

隐式修改数组长度的原型方法

这些方法主要是指数组的栈方法,例如:push、pop、shift、unshift。除此之外还有 splice 也会修改数组的长度。

此时我们来看一段测试代码,如下:

javascript 复制代码
const arr = reactive(['A'])
// 第一个 effect
effect(() => {
	arr.push('B')
})
// 第二个 effect
effect(() => {
	arr.push('C')
})

此时运行代码,会得到一个栈溢出的错误,如图:

我们来解读一下这个执行过程:

  • 这是因为,push 会读取 length 属性,所以当第一个 effect 执行之后,就会将 length 加入到一个依赖关系中,即进行了依赖收集
  • 而第二个 effect 执行的时候,也会读取 length 属性,除了读取之外,它还会设置 length 属性
  • 当第二个 effect 在设置 length 属性时,就会将 length 关联的副作用函数取出执行,其中就包括第一个 effect,而此时,我们的第二个 effect 还并没有执行完成,就执行起来了第一个 effect
  • 第一个 effect 又再次执行,又设置了 length 属性,触发 set,又要取出全部与 length 关联的副作用函数,此时这写函数里面就包括第二个,然后一直重复这个循环,就导致了栈溢出

解决方法也简单,问题就是不停的收集依赖导致的,只要在这些方法运行期间,暂停依赖收集,那么就算改变 length 属性也会因为停止了依赖收集而略过,等待这些方法执行完成,就可以恢复依赖收集,代码如下:

javascript 复制代码
// 是否应该收集依赖
let shouldTrack = true

// 暂停收集依赖
function pauseTracking() {
	shouldTrack = false
}

// 恢复收集依赖
function resumeTracking() {
	shouldTrack = true
}

const arrayInstrumentations = {}
// 在重写一些方法
;['push', 'pop', 'shift', 'unshift', 'splice'].forEach(key => {
	// 这些会改动数组的长度,造成额外的依赖收集,因此在这些方法运行期间,暂停依赖的收集
	arrayInstrumentations[key] = function (...args) {
		// 暂停依赖收集
		pauseTracking()
		const result = Array.prototype[key].apply(this, args)
		// 恢复依赖收集
		resumeTracking()
		return result
	}
})

function track(target, key) {
	// 停止收集依赖期间或者 activeFn 为空,则不收集
	if (!shouldTrack || !activeFn) return

	let depsMap = targetMap.get(target)
	if (!depsMap) {
		depsMap = new Map()
		targetMap.set(target, depsMap)
	}
	let deps = depsMap.get(key)
	if (!deps) {
		deps = new Set()
		depsMap.set(key, deps)
	}
	deps.add(activeFn)
	activeFn.deps.push(deps)
}

此时在运行测试案例,就不会出现栈溢出的错误了

结语

篇幅原因,这里仅展示代理对象和数组两种最为常见的数据结构,实现代理 Set 和 Map 将在后续的作为扩展章节展示

相关推荐
吃杠碰小鸡26 分钟前
commitlint校验git提交信息
前端
天天进步20151 小时前
Vue+Springboot用Websocket实现协同编辑
vue.js·spring boot·websocket
虾球xz1 小时前
游戏引擎学习第20天
前端·学习·游戏引擎
我爱李星璇1 小时前
HTML常用表格与标签
前端·html
疯狂的沙粒1 小时前
如何在Vue项目中应用TypeScript?应该注意那些点?
前端·vue.js·typescript
小镇程序员1 小时前
vue2 src_Todolist全局总线事件版本
前端·javascript·vue.js
野槐1 小时前
前端图像处理(一)
前端
程序猿阿伟2 小时前
《智能指针频繁创建销毁:程序性能的“隐形杀手”》
java·开发语言·前端
疯狂的沙粒2 小时前
对 TypeScript 中函数如何更好的理解及使用?与 JavaScript 函数有哪些区别?
前端·javascript·typescript
瑞雨溪2 小时前
AJAX的基本使用
前端·javascript·ajax