侦听器 API:Watch

188 阅读21分钟

watch 用法

1.侦听一个 getter 函数:

import { reactive, watch } from 'vue' 
const state = reactive({ count: 0 }) 
watch(() => state.count, (count, prevCount) => { 
  // 当 state.count 更新,会触发此回调函数 
}) 

但是它必须返回一个响应式对象,当该响应式对象更新后,会执行对应的回调函数。 2.侦听一个响应式对象:

import { ref, watch } from 'vue' 
const count = ref(0) 
watch(count, (count, prevCount) => { 
  // 当 count.value 更新,会触发此回调函数 
}) 

3.侦听多个响应式对象:

import { ref, watch } from 'vue' 
const count = ref(0) 
const count2 = ref(1) 
watch([count, count2], ([count, count2], [prevCount, prevCount2]) => { 
  // 当 count.value 或者 count2.value 更新,会触发此回调函数 
}) 

任意一个响应式对象更新后,就会执行对应的回调函数。

watch 实现原理及流程

当侦听的对象或者函数发生了变化则自动执行某个回调函数,这和副作用函数 effect 很像, 那它的内部实现是不是依赖了 effect 呢?答案:是的。 watch 函数的具体实现:

function watch(source, cb, options) { 
  if ((process.env.NODE_ENV !== 'production') && !isFunction(cb)) { 
    warn(``watch(fn, options?)` signature has been moved to a separate API. ` + 
      `Use `watchEffect(fn, options?)` instead. `watch` now only ` + 
      `supports `watch(source, cb, options?) signature.`) 
  } 
  return doWatch(source, cb, options) 
} 
function doWatch(source, cb, { immediate, deep, flush, onTrack, onTrigger } = EMPTY_OBJ) { 
  // 标准化 source 
  // 构造 applyCb 回调函数 
  // 创建 scheduler 时序执行函数 
  // 创建 effect 副作用函数 
  // 返回侦听器销毁函数 
}  

在非生产环境下判断第二个参数 cb 是不是一个函数,如果不是则会报警告以告诉用户应该使用 watchEffect(fn, options) API。 watch 内部主要是调用 doWatch 函数。

标准化 source

第一个参数 source 可以是以下格式:

  1. getter 函数
  2. 响应式对象
  3. 响应式对象数组

所以我们需要标准化 source,具体流程:

// source 不合法的时候会报警告 
const warnInvalidSource = (s) => { 
  warn(`Invalid watch source: `, s, `A watch source can only be a getter/effect function, a ref, ` + 
    `a reactive object, or an array of these types.`) 
} 
// 当前组件实例 
const instance = currentInstance 
let getter
if (isArray(source)) {
  // 数组的情况,则同理循环执行单个的逻辑
  getter = () => source.map(s => { 
    if (isRef(s)) { 
      return s.value 
    } 
    else if (isReactive(s)) { 
      return traverse(s) 
    } 
    else if (isFunction(s)) { 
      return callWithErrorHandling(s, instance, 2 /* WATCH_GETTER */) 
    } 
    else { 
      (process.env.NODE_ENV !== 'production') && warnInvalidSource(s) 
    } 
  }) 
} else if (isRef(source)) { 
  // ref 的情况
  getter = () => source.value 
} else if (isReactive(source)) {
  // reactive 的情况
  getter = () => source 
  deep = true 
} else if (isFunction(source)) {
  // 函数的情况
  if (cb) {
    // getter with cb 
    getter = () => callWithErrorHandling(source, instance, 2 /* WATCH_GETTER */) 
  } else { 
    // watchEffect 的逻辑 
  } 
} else {
  // 报错
  getter = NOOP 
  (process.env.NODE_ENV !== 'production') && warnInvalidSource(source) 
}
​
// 2.x array mutation watch compat
if (__COMPAT__ && cb && !deep) {
  const baseGetter = getter
  getter = () => {
    const val = baseGetter()
    if (
      isArray(val) &&
      checkCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance)
    ) {
      traverse(val)
    }
    return val
  }
}
​
if (cb && deep) {
  const baseGetter = getter 
  getter = () => traverse(baseGetter()) 
} 

source 标准化主要就是根据 source 的类型,将其统一变成 getter 函数 因为 source 是 reactive 对象时,会直接设置 deep 为 true 所以,接下来会对 deep 为 true 的情况进行处理(在这之前会对 vue2 的 watch api 做兼容处理) 会将生成的 getter 函数会被 traverse 函数包装一层。traverse 函数中,会通过递归的方式访问 value 的每一个子属性,将每一个子属性都收集依赖,这里的被收集的依赖是 watcher 内部创建的 effect runner。

traverse 层次过深的优化

如果一个 reactive 对象的嵌套层级过深,则递归 traverse 会有一定的性能损耗。 可做以下优化:

  1. 直接侦听 state.count.a.b
watch(state.count.a, (newVal, oldVal) => { 
  console.log(newVal) 
}) 
state.count.a.b = 2 

这样可以减少内部执行 traverse 的次数 直接侦听 state.count.a.b 可以吗? 答案是不行,因为 state.count.a.b 已经是一个基础数字类型了,不符合 source 要求的参数类型,所以会在非生产环境下报警告。

  1. 直接传入 getter 函数,使 traverse 不执行
watch(() => state.count.a.b, (newVal, oldVal) => { 
  console.log(newVal) 
}) 
state.count.a.b = 2 

这样函数内部会访问并返回 state.count.a.b,一次 traverse 都不会执行并且依然可以侦听到它的变化从而执行 watcher 的回调函数。

构造回调函数

接下来处理第二个参数 cb cb 是一个回调函数,它有三个参数:

  1. 第一个 newValue 代表新值
  2. 第二个 oldValue 代表旧值
  3. 第三个参数 onInvalidate,用来注册无效回调函数

这样的 API 设计非常好理解,即侦听一个值的变化,如果值变了就执行回调函数,回调函数里可以访问到新值和旧值。 接下来我们来看一下构造回调函数的处理逻辑:

let cleanup 
// 注册无效回调函数 
const onInvalidate = (fn) => { 
  cleanup = runner.options.onStop = () => { 
    callWithErrorHandling(fn, instance, 4 /* WATCH_CLEANUP */) 
  } 
} 
// 旧值初始值 
let oldValue = isArray(source) ? [] : INITIAL_WATCHER_VALUE /*{}*/ 
// 回调函数 
const applyCb = cb 
  ? () => { 
    // 组件销毁,则直接返回 
    if (instance && instance.isUnmounted) { 
      return 
    } 
    // 求得新值 
    const newValue = runner() 
    if (deep || hasChanged(newValue, oldValue)) { 
      // 执行清理函数 
      if (cleanup) { 
        cleanup() 
      } 
      callWithAsyncErrorHandling(cb, instance, 3 /* WATCH_CALLBACK */, [ 
        newValue, 
        // 第一次更改时传递旧值为 undefined 
        oldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue, 
        onInvalidate 
      ]) 
      // 更新旧值 
      oldValue = newValue 
    } 
  } 
  : void 0

onInvalidate 函数用来注册无效回调函数 ,我们暂时不需要关注它。

封装 applyCb

我们需要重点来看 applyCb这个函数实际上就是对 cb 做一层封装,当侦听的值发生变化时就会执行 applyCb 方法。 我们来分析一下它的实现:

  1. 首先,watch API 和组件实例相关,因为通常我们会在组件的 setup 函数中使用它,当组件销毁后,回调函数 cb 不应该被执行而是直接返回。
  2. 接着,执行 runner 求得新值,这里的 runner 是对 getter 函数的封装。实际上就是执行前面创建的 getter 函数求新值。
  3. 最后,进行判断,如果是 deep 的情况或者新旧值发生了变化,则执行回调函数 cb,传入参数 newValue 和 oldValue。注意,第一次执行的时候旧值的初始值是空数组或者 undefined。执行完回调函数 cb 后,把旧值 oldValue 再更新为 newValue,这是为了下一次的比对。

创建 scheduler

scheduler 的作用是根据某种调度的方式去执行某种函数 在 watch API 中,主要影响到的是回调函数的执行方式。 我们来看一下它的实现逻辑:

const invoke = (fn) => fn() 
let scheduler 
if (flush === 'sync') { 
	// 同步 
	scheduler = invoke // the scheduler function gets called directly
} else if (flush === 'post') {
	// 进入异步队列,在组件更新后执行 
	scheduler = () => queuePostRenderEffect(job, instance && instance.suspense)
} else {
	// default: 'pre'
	scheduler = job => { 
		if (!instance || instance.isMounted) { 
			// 如果还未创建组件,或者组件已经 mounted。则进入异步队列,确保 job 在组件更新前执行 
			queuePreFlushCb(job)
		} else {
			// 传入 pre 时,job 必须在组件 mounted 挂载前执行
			// 所以如果组件还没 mounted,则同步执行以确保在组件 mounted 挂载前执行
			job()
		} 
	} 
}

Watch API 的参数除了 source 和 cb,还支持第三个参数 options,不同的配置决定了 watcher 的不同行为。 前面我们也分析了 deep 为 true 的情况,除了 source 为 reactive 对象时会默认把 deep 设置为 true,你也可以主动传入第三个参数,把 deep 设置为 true。

这里,scheduler 的创建逻辑受到了第三个参数 options 中的 flush 属性值的影响,不同的 flush 决定了 watcher 的执行时机:

  • flush: sync,表示它是一个同步 watcher,即当数据变化时直接同步执行回调函数。
  • flush: post,那么回调函数通过 queuePostRenderEffect 的方式在组件更新之后执行(跟使用 nextTick 是一样的意思)。
  • flush: pre 或未设置 flush 时,回调函数通过 queuePreFlushCb 的方式在组件更新之前执行。如果组件创建了但还没挂载,则同步执行确保回调函数在组件 mounted 挂载之前执行。

queueJob 和 queuePostRenderEffect 在这里不是重点。 重点是,你现在要记住,watcher 的回调函数是通过一定的调度方式执行的

创建 runner effect

前面的分析我们提到了 runner,它其实就是 watcher 内部创建的 effect 副作用函数 接下来,我们来分析它的逻辑:

const runner = effect(getter, { 
	// 延时执行
	lazy: true, 
	// computed effect 可以优先于普通的 effect 先运行,比如组件渲染的 effect 
	computed: true, 
	onTrack,
	onTrigger,
	scheduler: applyCb ? () => scheduler(applyCb) : scheduler 
})

// 在组件实例中记录这个 effect 
recordInstanceBoundEffect(runner)

// 初次执行 
if (applyCb) {
	if (immediate) { 
		applyCb()
	} else {
		// 求旧值 
		oldValue = runner() 
	}
} else {
	// 没有 cb 的情况 
	runner()
} 

这块代码逻辑是整个 watcher 实现的核心部分,即通过 effect API 创建一个副作用函数 runner 我们需要关注以下几点:

  1. runner 是一个 computed effect。因为 computed effect 可以优先于普通的 effect(比如组件渲染的 effect)先运行,这样就可以实现当配置 flush 为 pre 的时候,watcher 的执行可以优先于组件更新。

    1. 任何 effect 函数都可以传入 computed: true 配置来将其变为 computed effect。
  2. runner 执行的方式。runner 是 lazy 的,它不会在创建后立刻执行。源码中会第一次通过 oldValue = runner() 手动执行 runner,也就是会执行前面的 getter 函数,访问响应式数据并做依赖收集。注意,此时 activeEffect 就是 runner,这样在后面更新响应式数据时,就可以触发 runner 执行 scheduler 函数,以一种调度的方式来执行回调函数。

  3. runner 的返回结果。手动执行 runner 就相当于执行了前面标准化的 getter 函数,getter 函数的返回值就是 watcher 计算出的值,所以我们第一次执行 runner 求得的值可以作为 oldValue。

  4. 配置了 immediate 的情况。当我们配置了 immediate,则创建完 watcher 会立刻执行 applyCb 函数,此时就不需要手动执行 runner 收集依赖了。此时则会在 applyCb 执行过程中执行 runner 进而执行前面的 getter 函数做依赖收集,求得新值。

返回销毁函数

最后,会返回侦听器销毁函数,也就是 watch API 执行后返回的函数。 我们可以通过调用它来停止 watcher 对数据的侦听。

return () => { 
	stop(runner) 
	if (instance) { 
		// 移除组件 effects 对这个 runner 的引用 
		remove(instance.effects, runner) 
	} 
} 
function stop(effect) { 
	if (effect.active) { 
		cleanup(effect) 
		if (effect.options.onStop) { 
			effect.options.onStop() 
		} 
		effect.active = false 
	} 
} 

销毁函数内部会执行 stop 方法让 runner 失活,并清理 runner 的相关依赖,这样就可以停止对数据的侦听。 并且,如果是在组件中注册的 watcher,也会移除组件 effects 对这个 runner 的引用。

🟥 流程总结

这就是整个 watch API 的流程。侦听器的内部设计很巧妙

  1. 标准化 resource:处理传入的 getter 函数
  2. 构造回调函数:创建 applyCb, scheduler, 并创建 runner effect 将它们整体包装成副作用函数
  3. 内部创建完 runner effect 之后,会首次执行 runner 做响应式数据做依赖收集,收集的依赖就是 runner(如果是 immediate 则会首次执行 applyCb,内部进而执行 runner 收集依赖)
  4. 然后在数据发生变化后,再执行 runner 求得 newValue 传入回调函数中。并以某种调度方式 scheduler 在某个时机去执行回调函数。

异步执行队列的设计

watch 的回调函数是以一种调度的方式执行的,特别是当 flush 不是 sync 时,它会把回调函数执行的任务推到一个异步队列中执行。 接下来,我们就来分析异步执行队列的设计。

为什么需要异步队列

分析之前,我们先来思考一下,为什么会需要异步队列? 看一个示例:

import { reactive, watch } from 'vue' 
const state = reactive({ count: 0 }) 
watch(() => state.count, (count, prevCount) => { 
	console.log(count) 
}) 
state.count++ 
state.count++ 
state.count++

这里,我们修改了三次 state.count,那么 watcher 的回调函数会执行三次吗? 答案是不会,实际上只输出了一次 count 的值,也就是最终计算的值 3。 这在大多数场景下都是符合预期的,因为在一个 Tick(宏任务执行的生命周期)内,即使多次修改侦听的值,它的回调函数也只执行一次。

知识延伸 组件的更新过程是异步的,我们知道更新了模板中引用的响应式对象的值时,会触发组件的重新渲染,但是在一个 Tick 内,即使你多次修改多个响应式对象的值,组件的重新渲染也只执行一次。 这是因为如果每次更新数据都触发组件重新渲染的话,那么重新渲染的次数和代价都太高了。

为了避免每次更新数据都触发渲染,所以才需要有异步任务队列,来做组件的异步更新。

异步任务队列的创建

在创建一个 watcher 时,如果配置 flush 为 pre(默认值) 或 post,那么 watcher 的回调函数就会异步执行。此时分别是通过 queuePreFlushCbqueuePostRenderEffect 把回调函数推入异步队列中的。

queuePostFlushEffect

在不涉及 suspense 的情况下,queuePostRenderEffect 相当于 queuePostFlushCb,我们来看它们的实现:

// 异步任务队列 
const queue = [] 
// 队列任务执行完后执行的回调函数队列 
const postFlushCbs = [] 
function queueJob(job) { 
	if (!queue.includes(job)) { 
		queue.push(job) 
		queueFlush() 
	} 
} 

function queuePostFlushCb(cb) { 
	if (!isArray(cb)) { 
		postFlushCbs.push(cb) 
	} else { 
		// 如果是数组,把它拍平成一维 
		postFlushCbs.push(...cb) 
	} 
	queueFlush() 
} 

Vue.js 内部维护了一个 queue 数组和一个 postFlushCbs 数组

  1. queue 数组用作异步任务队列。

    1. 执行 queueJob 时会把这个任务 job 添加到 queue 的队尾
  2. postFlushCbs 数组用作异步任务队列执行完毕后的回调函数队列。

    1. 执行 queuePostFlushCb 时,会把这个 cb 回调函数添加到 postFlushCbs 的队尾。

:::danger 什么时候执行的 queueJob? 创建组件的副作用渲染函数时 const effect = new ReactiveEffect(componentUpdateFn, () => queueJob(instance.update), instance.scope) 这里传入的第二个参数就是一个 scheduler,用于放入异步任务队列中执行 instance 的更新instance.update() 就是 effect.run.bind(effect),run 是触发依赖的副作用渲染函数的执行 :::

它们在添加完毕后都执行了 queueFlush 函数,我们看它的实现:

const p = Promise.resolve() 
// 异步任务队列是否正在执行 
let isFlushing = false 
// 异步任务队列是否等待执行 
let isFlushPending = false 

function nextTick(fn) { 
	return fn ? p.then(fn) : p 
}

function queueFlush() { 
	if (!isFlushing && !isFlushPending) { 
		isFlushPending = true 
		nextTick(flushJobs) 
	} 
} 

可以看到,Vue.js 内部还维护了 isFlushingisFlushPending 变量,用来控制异步任务的刷新逻辑。 在 queueFlush 首次执行时,isFlushing 和 isFlushPending 都是 false,此时会把 isFlushPending 设置为 true,并且调用 nextTick(flushJobs) 去执行队列里的任务。 因为 isFlushPending 的控制,这使得即使多次执行 queueFlush,也不会多次去执行 flushJobs。

nextTick 在 Vue.js 3.0 中的实现也是非常简单,就是通过 Promise.resolve().then 创建微任务去异步执行 flushJobs。 因为 JavaScript 是单线程执行的,这样的异步设计使你在一个 Tick 内,可以多次执行 queueJob 或者 queuePostFlushCb 去添加任务,也可以保证在宏任务执行完毕后的微任务阶段执行一次 flushJobs。

异步任务队列的执行

创建完任务队列后,接下来要异步执行这个队列,也就是 flushJobs

flushJobs

我们来看一下 flushJobs 的实现:

const getId = (job) => (job.id == null ? Infinity : job.id) 

function flushJobs(seen) { 
	isFlushPending = false 
	isFlushing = true 
	let job 

	if ((process.env.NODE_ENV !== 'production')) { 
		seen = seen || new Map() 
	}

	flushPreFlushCbs(seen)

	// 组件的更新是先父后子 
	// 如果一个组件在父组件更新过程中卸载,它自身的更新应该被跳过 
	queue.sort((a, b) => getId(a) - getId(b)) 

	while ((job = queue.shift()) !== undefined) { 
		if (job === null) { 
			continue 
		} 
		if ((process.env.NODE_ENV !== 'production')) { 
			checkRecursiveUpdates(seen, job) 
		}
		callWithErrorHandling(job, null, 14 /* SCHEDULER */) 
	} 

	flushIndex = 0
  queue.length = 0
	flushPostFlushCbs(seen) 
	isFlushing = false 

	// 一些 preFlushCbs 或 postFlushCb 执行过程中会再次添加异步任务,需要递归 flushJobs 会把它们都执行完毕 
	if (queue.length || preFlushCbs.length || postFlushCbs.length) { 
		flushJobs(seen) 
	} 
} 

flushJobs 函数开始执行的时候,会把 isFlushPending 重置为 false,把 isFlushing 设置为 true 来表示正在执行异步任务队列

对于异步任务队列 queue,在遍历执行它们前会先对它们做一次从小到大的排序,这是因为两个主要原因

  1. 我们创建组件的过程是由父到子,所以创建组件副作用渲染函数也是先父后子,所以父组件的副作用渲染函数的 effect id 是小于子组件的,每次更新组件也是通过 queueJob 把副作用渲染函数 effect 推入异步任务队列 queue 中的。所以为了保证先更新父组再更新子组件,要对 queue 做从小到大的排序
  2. 如果一个组件在父组件更新过程中被卸载,它自身的更新应该被跳过。所以也应该要保证先更新父组件再更新子组件,要对 queue 做从小到大的排序。

接下来就是遍历这个 queue,依次执行队列中的任务了。

在遍历过程中,注意有一个 checkRecursiveUpdates 的逻辑,它是用来在非生产环境下检测是否有循环更新的。

:::info 因为一些 preFlushCbs 或 postFlushCb 的执行过程中,可能会再次添加异步任务,所以需要继续判断如果 queue, preFlushCbs, postFlushCbs 队列中还存在任务,则递归执行 flushJobs 把它们都执行完毕。 :::

flushPostFlushCbs

遍历完 queue 后,又会进一步执行 flushPostFlushCbs 方法去遍历执行所有推入到 postFlushCbs 的回调函数:

 function flushPostFlushCbs(seen) { 
	if (postFlushCbs.length) { 
		
		// 拷贝副本 
		const cbs = [...new Set(postFlushCbs)] 
		
		postFlushCbs.length = 0 
		if ((process.env.NODE_ENV !== 'production')) { 
			seen = seen || new Map() 
		}

		// 遍历执行 postFlushCbs
		for (let i = 0; i < cbs.length; i++) { 
			if ((process.env.NODE_ENV !== 'production')) {                                                       
				checkRecursiveUpdates(seen, cbs[i]) 
			} 
			cbs[i]() 
		} 
	} 
} 

注意这里遍历前会通过 const cbs = [...new Set(postFlushCbs)] 拷贝一个 postFlushCbs 的副本,这是因为在遍历的过程中,可能某些回调函数的执行会再次修改 postFlushCbs,所以拷贝一个副本循环遍历则不会受到 postFlushCbs 修改的影响。

遍历执行完 postFlushCbs 后,会将 isFlushing 重置为 false。

这一轮的异步任务队列就执行完毕了。 这时又能进行下一轮 queueFlush 的执行了,也就是下一轮异步任务队列 flushJobs 的执行。

checkRecursiveUpdates 检测循环更新

在遍历执行异步任务和回调函数的过程中,都会在非生产环境下执行 checkRecursiveUpdates 检测是否有循环更新,它是用来解决什么问题的呢?

解决的问题

将之前的示例改写一下:

import { reactive, watch } from 'vue' 
const state = reactive({ count: 0 }) 
watch(() => state.count, (count, prevCount) => { 
	state.count++ 
	console.log(count) 
})
state.count++ 

如果去跑这个示例,你会在控制台看到输出了 101 次值,然后报了错误: Maximum recursive updates exceeded 。 这是因为我们在 watcher 的回调函数里更新了数据,这样会再一次进入回调函数,如果我们不加任何控制,那么回调函数会一直执行,直到把内存耗尽造成浏览器假死。

为了避免这种情况,Vue.js 实现了 checkRecursiveUpdates 方法

checkRecursiveUpdates 的实现

看一下 checkRecursiveUpdates 方法的实现:

const RECURSION_LIMIT = 100 

function checkRecursiveUpdates(seen, fn) { 
	if (!seen.has(fn)) { 
		seen.set(fn, 1) 
	} else { 
		const count = seen.get(fn) 
		if (count > RECURSION_LIMIT) { 
			throw new Error('Maximum recursive updates exceeded. ' + 
				"You may have code that is mutating state in your component's " + 
				'render function or updated hook or watcher source function.') 
		} else { 
			seen.set(fn, count + 1) 
		} 
	} 
} 

通过前面的代码,我们知道 flushJobs 一开始便创建了 seen,它是一个 Map 对象 然后在 checkRecursiveUpdates 的时候会把任务添加到 seen 中,seen 使用 count 记录 fn 的引用计数,初始值为 1。 我们在执行 preFlushCbs 或 postFlushCbs 时,都将 seen 作为参数传入了。此时如果 preFlushCbs 或 postFlushCbs 执行过程中再次添加了相同的任务,则引用计数 count 加 1,如果 count 大于我们定义的限制 100 ,则说明一直在添加这个相同的任务并超过了 100 次。那么,Vue.js 会抛出这个错误,因为在正常的使用中,不应该出现这种情况,而我们上述的错误示例就会触发这种报错逻辑。

异步任务队列的优化

到这里,异步队列的设计就介绍完毕了,你可能会对 isFlushPending 和 isFlushing 有些疑问,为什么需要两个变量来控制呢?

从语义上来看,isFlushPending 用于判断是否在等待 nextTick 执行 flushJobs,而 isFlushing 是判断是否正在执行任务队列。 从功能上来看,它们的作用是为了确保以下两点:

  1. 在一个 Tick 内可以多次添加任务到队列中,但是任务队列会在 nextTick 后执行;
  2. 在执行任务队列的过程中,也可以添加新的任务到队列中,并且在当前 Tick 去执行剩余的任务队列。

但实际上,这里我们可以进行优化。在我看来,这里用一个变量就足够了,我们来稍微修改一下源码:

function queueFlush() { 
	if (!isFlushing) { 
		isFlushing = true 
		nextTick(flushJobs) 
	} 
} 

function flushJobs(seen) { 
	let job 
	if ((process.env.NODE_ENV !== 'production')) { 
		seen = seen || new Map() 
	} 
	queue.sort((a, b) => getId(a) - getId(b)) 
	while ((job = queue.shift()) !== undefined) { 
		if (job === null) { 
			continue 
		} 
		if ((process.env.NODE_ENV !== 'production')) { 
			checkRecursiveUpdates(seen, job) 
		} 
		callWithErrorHandling(job, null, 14 /* SCHEDULER */) 
	} 
	flushPostFlushCbs(seen) 
	if (queue.length || postFlushCbs.length) { 
		flushJobs(seen) 
	} 
	isFlushing = false 
} 

可以看到,我们只需要一个 isFlushing 来控制就可以实现相同的功能了。 在执行 queueFlush 的时候,判断 isFlushing 为 false,则把它设置为 true,然后 nextTick 会执行 flushJobs。在 flushJobs 函数执行完成的最后,也就是所有的任务(包括后添加的)都执行完毕,再设置 isFlushing 为 false。

watchEffect 实现原理

了解完 watch API 和异步任务队列的设计后,我们再来学习侦听器提供的另一个 API—— watchEffect API watchEffect API 的作用是注册一个副作用函数,副作用函数内部可以访问到响应式对象,当内部响应式对象变化后再立即执行这个函数。

可以先来看一个示例:

import { ref, watchEffect } from 'vue' 
const count = ref(0) 
watchEffect(() => console.log(count.value)) 
count.value++

// 它的结果是依次输出 0 和 1

watchEffect API 和前面的 watch API 有哪些不同呢? 主要有三点:

  1. 侦听的源不同。watch API 可以侦听一个或多个响应式对象,也可以侦听一个 getter 函数,而 watchEffect API 侦听的是一个普通函数,只要内部访问了响应式对象即可,这个函数并不需要返回响应式对象。
  2. 没有回调函数。watchEffect API 没有回调函数,副作用函数的内部响应式对象发生变化后,会再次执行这个副作用函数。
  3. 立即执行。watchEffect API 在创建好 watcher 后,会立刻执行它的副作用函数,而 watch API 需要配置 immediate 为 true,才会立即执行回调函数。

对 watchEffect API 有大体了解后,我们来看一下在我整理的 watchEffect 场景下, doWatch 函数的简化版实现:

function watchEffect(effect, options) { 
	return doWatch(effect, null, options); 
}

function doWatch(source, cb, { immediate, deep, flush, onTrack, onTrigger } = EMPTY_OBJ) { 
	instance = currentInstance; 

	let getter; 
	if (isFunction(source)) { 
		getter = () => { 
			if (instance && instance.isUnmounted) { 
				return; 
			} 
			 // 执行清理函数 
			if (cleanup) { 
				cleanup(); 
			} 
			// 执行 source 函数,传入 onInvalidate 作为参数 
			return callWithErrorHandling(source, instance, 3 /* WATCH_CALLBACK */, [onInvalidate]); 
		}; 
	}

	let cleanup; 
	const onInvalidate = (fn) => { 
		cleanup = runner.options.onStop = () => { 
			callWithErrorHandling(fn, instance, 4 /* WATCH_CLEANUP */); 
		}; 
	}; 
	let scheduler; 
	// 创建 scheduler 
	if (flush === 'sync') { 
		scheduler = invoke; 
	} else if (flush === 'pre') { 
		scheduler = job => { 
			if (!instance || instance.isMounted) { 
				queueJob(job); 
			} else { 
				job(); 
			} 
		}; 
	} else { 
		scheduler = job => queuePostRenderEffect(job, instance && instance.suspense); 
	} 

	// 创建 runner 
	const runner = effect(getter, { 
		lazy: true, 
		computed: true, 
		onTrack, 
		onTrigger, 
		scheduler 
	}); 
	recordInstanceBoundEffect(runner); 

	// 立即执行 runner 
	runner(); 

	// 返回销毁函数 
	return () => { 
		stop(runner); 
		if (instance) { 
			remove(instance.effects, runner); 
		} 
	}; 
}
  1. 可以看到,getter 函数就是对 source 函数的简单封装,它会先判断组件实例是否已经销毁,然后每次执行 source 函数前执行 cleanup 清理函数。
  2. watchEffect 内部创建的 runner 对应的 scheduler 对象就是 scheduler 函数本身,这样它再次执行时,就会执行这个 scheduler 函数,并且传入 runner 函数作为参数,其实就是按照一定的调度方式去执行基于 source 封装的 getter 函数。
  3. 创建完 runner 后就立刻执行了 runner,其实就是内部同步执行了基于 source 封装的 getter 函数。

注册无效回调函数

在执行 source 函数的时候,会传入一个 onInvalidate 函数作为参数,接下来我们就来分析它的作用。

有些时候,watchEffect 会注册一个副作用函数,在函数内部可以做一些异步操作,但是当这个 watcher 停止后,如果我们想去对这个异步操作做一些额外事情(比如取消这个异步操作),我们可以通过 onInvalidate 参数注册一个无效函数:

import {ref, watchEffect } from 'vue' 
const id = ref(0) 

watchEffect(onInvalidate => { 
	// 执行异步操作 
	const token = performAsyncOperation(id.value) 
	onInvalidate(() => { 
		// 如果 id 发生变化或者 watcher 停止了,则执行逻辑取消前面的异步操作 
		token.cancel() 
	}) 
}) 

我们来回顾 onInvalidate 在 doWatch 中的实现:

const onInvalidate = (fn) => { 
	cleanup = runner.options.onStop = () => { 
		callWithErrorHandling(fn, instance, 4 /* WATCH_CLEANUP */); 
	}; 
};

实际上,当你执行 onInvalidate 的时候,就是注册了一个 cleanup 和 runner 的 onStop 方法,这个方法内部会执行 fn,也就是你注册的无效回调函数。 也就是说

  1. 当响应式数据发生变化,会执行 cleanup 方法
  2. 当 watcher 被停止,会执行 onStop 方法

这两者都会执行注册的无效回调函数 fn 通过这种方式,Vue.js 就很好地实现了 watcher 注册无效回调函数的需求。