台州网站建设解决方案厂房网络推广平台
watch
的作用是监听数据的变化,当数据发生变化时,执行一个回调函数,它的实现依赖于 Vue 的响应式系统(reactive
和ref
)
案例
通过以下案例来理解,首先引入reactive
、effect
、watch
三个函数,声明obj
响应式数据,接着执行watch
函数,第一个参数为监听数据,第二个参数为监听回调,最后两秒后修改obj
的name
值
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Document</title><script src="../../dist/vue.global.js"></script></head><body><div id="app"></div><script>const { reactive, effect, watch } = Vue// 1. reactive 构建响应性数据const obj = reactive({name: 'jc'})// 2. 执行了 watch 函数watch(obj, (value, oldValue) => {console.log('watch 触发了')console.log(value)})// 3. 两秒后触发 setter 行为setTimeout(() => {obj.name = 'cc'}, 2000)</script></body>
</html>
doWatch
方法
watch
函数定义在packages/runtime-core/src/apiWatch.ts
文件下:
该函数实际执行的是doWatch
方法,它会根据传入的参数( source
和 cb
)生成一个监听器
1)根据 source
的类型生成 getter
getter
是一个函数,用于获取监听数据的值,根据source
的类型:
reactive
类型,直接返回source
ref
类型,返回source.value
- 如果
source
是一个函数,getter
会执行这个函数
2)定义 job
函数
job
是watch
的核心逻辑,它会在数据变化时执行,它的主要任务是:
- 获取新的值
newValue
- 检查新值和旧值是否不同
- 如果不同,执行回调函数
cb
3)调度器 scheduler
scheduler
决定了job
的执行时机,Vue 提供了三种调度方式:
sync
:同步执行post
:在渲染后执行pre
:在渲染前执行(默认)
function doWatch(source: WatchSource | WatchSource[] | WatchEffect | object,cb: WatchCallback | null,{ immediate, deep, flush, onTrack, onTrigger }: WatchOptions = EMPTY_OBJ
): WatchStopHandle {// 省略const instance = currentInstancelet getter: () => anylet forceTrigger = falselet isMultiSource = falseif (isRef(source)) {// 是否 ref 类型getter = () => source.valueforceTrigger = isShallow(source)} else if (isReactive(source)) {// 是否 reactive 类型getter = () => sourcedeep = true // 主动开启 深度监听} else if (isArray(source)) {isMultiSource = trueforceTrigger = source.some(s => isReactive(s) || isShallow(s))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, ErrorCodes.WATCH_GETTER)} else {__DEV__ && warnInvalidSource(s)}})} else if (isFunction(source)) {if (cb) {// getter with cbgetter = () =>callWithErrorHandling(source, instance, ErrorCodes.WATCH_GETTER)} else {// no cb -> simple effectgetter = () => {if (instance && instance.isUnmounted) {return}if (cleanup) {cleanup()}return callWithAsyncErrorHandling(source,instance,ErrorCodes.WATCH_CALLBACK,[onCleanup])}}} else {getter = NOOP__DEV__ && warnInvalidSource(source)}// 省略if (cb && deep) {const baseGetter = getter // getter 为 () => sourcegetter = () => traverse(baseGetter())}// 省略// 定义 oldValue isMultiSource 是否有多个源 [value1, value2] 需要监听let oldValue = isMultiSource ? [] : INITIAL_WATCHER_VALUE// job 核心逻辑const job: SchedulerJob = () => {if (!effect.active) {return}if (cb) {// watch(source, cb)const newValue = effect.run()if (deep ||forceTrigger ||(isMultiSource? (newValue as any[]).some((v, i) =>hasChanged(v, (oldValue as any[])[i])): hasChanged(newValue, oldValue)) ||(__COMPAT__ &&isArray(newValue) &&isCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance))) {// cleanup before running cb againif (cleanup) {cleanup()}callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [newValue,// pass undefined as the old value when it's changed for the first timeoldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue,onCleanup])oldValue = newValue}} else {// watchEffecteffect.run()}}// important: mark the job as a watcher callback so that scheduler knows// it is allowed to self-trigger (#1727)job.allowRecurse = !!cblet scheduler: EffectSchedulerif (flush === 'sync') {scheduler = job as any // the scheduler function gets called directly} else if (flush === 'post') {scheduler = () => queuePostRenderEffect(job, instance && instance.suspense)} else {// default: 'pre'scheduler = () => queuePreFlushCb(job) // 调度器赋值 也是核心逻辑}const effect = new ReactiveEffect(getter, scheduler)if (__DEV__) {effect.onTrack = onTrackeffect.onTrigger = onTrigger}// initial runif (cb) {if (immediate) {// 默认自动执行 watch 一次job() // job 触发意味着 watch 被立即执行一次} else {oldValue = effect.run() // 等于执行 fn 函数 即 () => traverse(baseGetter()) 即 () => source 即 传入的监听数据}} else if (flush === 'post') {queuePostRenderEffect(effect.run.bind(effect),instance && instance.suspense)} else {effect.run()}return () => {effect.stop() // 监听停止if (instance && instance.scope) {remove(instance.scope.effects!, effect)}}
}
根据传入source
监听数据类型不同走不同逻辑,当前source
为reactive
类型,所以getter
直接赋值为() => source
,另外还可以看到类型为reactive
时,默认开启深度监听 deep = true
由于存在cb
监听回调和deep
,所以baseGetter
等于getter
,即() => source
, getter
赋值为() => traverse(baseGetter())
之后又定义了oldValue
值,默认为空对象,也是回调函数中的oldValue
。接着定义了一个 job
函数,这是 watch
的核心逻辑,后面再分析
然后又创建了一个调度器scheduler
,在computed
中提到过,在依赖触发时,会执行该方法。此时scheduler
被赋值为() => queuePreFlushCb(job)
,将job
函数传入到queuePreFlushCb
方法中,该逻辑之后来分析
接着又创建了一个ReactiveEffect
实例,将赋值后的getter
和scheduler
传入
由于存在cb
回调函数,根据判断配置中immediate
存在时,就执行job
方法,我们可以理解为job
的触发watch
被立即执行一次。否则执行effect.run
即执行fn
方法
当前fn
为getter
即() => traverse(baseGetter())
,就是执行() => source
,结果为传入的监听对象source
:
此时watch
函数执行完毕,两秒后触发obj
的setter
行为,依赖触发trigger
执行,当前effects
为:
之后再遍历执行每个 effect
,此时存在 scheduler
调度器,执行scheduler
方法。当前scheduler
为之前赋值的() => queuePreFlushCb(job)
,再来看下queuePreFlushCb
方法,该方法定义在packages/runtime-core/src/scheduler.ts
文件中:
export function queuePreFlushCb(cb: SchedulerJob) {queueCb(cb, activePreFlushCbs, pendingPreFlushCbs, preFlushIndex)
}
queueCb
方法
实际执行的是queueCb
方法:
该方法定义了一个 pendingQueue
队列数组,插入传入的cb
回调即传入的job
函数,执行queueFlush
方法:
function queueFlush() {if (!isFlushing && !isFlushPending) {isFlushPending = truecurrentFlushPromise = resolvedPromise.then(flushJobs)}
}
可以看出watch
的job
执行都是一个微任务
,当前同步任务执行完毕后,执行微任务,之后执行flushJobs
方法:
function flushJobs(seen?: CountMap) {isFlushPending = falseisFlushing = trueif (__DEV__) {seen = seen || new Map()}flushPreFlushCbs(seen)// Sort queue before flush.// This ensures that:// 1. Components are updated from parent to child. (because parent is always// created before the child so its render effect will have smaller// priority number)// 2. If a component is unmounted during a parent component's update,// its update can be skipped.queue.sort((a, b) => getId(a) - getId(b))// conditional usage of checkRecursiveUpdate must be determined out of// try ... catch block since Rollup by default de-optimizes treeshaking// inside try-catch. This can leave all warning code unshaked. Although// they would get eventually shaken by a minifier like terser, some minifiers// would fail to do that (e.g. https://github.com/evanw/esbuild/issues/1610)const check = __DEV__? (job: SchedulerJob) => checkRecursiveUpdates(seen!, job): NOOPtry {for (flushIndex = 0; flushIndex < queue.length; flushIndex++) {const job = queue[flushIndex]if (job && job.active !== false) {if (__DEV__ && check(job)) {continue}// console.log(`running:`, job.id)callWithErrorHandling(job, null, ErrorCodes.SCHEDULER)}}} finally {flushIndex = 0queue.length = 0flushPostFlushCbs(seen)isFlushing = falsecurrentFlushPromise = null// some postFlushCb queued jobs!// keep flushing until it drains.if (queue.length ||pendingPreFlushCbs.length ||pendingPostFlushCbs.length) {flushJobs(seen)}}
}
然后执行flushPreFlushCbs(seen)
方法:
export function flushPreFlushCbs(seen?: CountMap,parentJob: SchedulerJob | null = null
) {if (pendingPreFlushCbs.length) {currentPreFlushParentJob = parentJob // job 函数activePreFlushCbs = [...new Set(pendingPreFlushCbs)] // 取代 pendingPreFlushCbspendingPreFlushCbs.length = 0 // 置空 下次不会再触发if (__DEV__) {seen = seen || new Map()}for (preFlushIndex = 0;preFlushIndex < activePreFlushCbs.length;preFlushIndex++) {if (__DEV__ &&checkRecursiveUpdates(seen!, activePreFlushCbs[preFlushIndex])) {continue}activePreFlushCbs[preFlushIndex]() // 当前 job 函数执行}activePreFlushCbs = nullpreFlushIndex = 0currentPreFlushParentJob = null// recursively flush until it drainsflushPreFlushCbs(seen, parentJob)}
}
当前pendingPreFlushCbs
为传入的job
方法,之后将去重后的pendingPreFlushCbs
赋值给activePreFlushCbs
,遍历执行activePreFlushCbspreFlushIndex
,实际是执行每个job
函数:
const job: SchedulerJob = () => {if (!effect.active) {return}if (cb) {// watch(source, cb)const newValue = effect.run()if (deep ||forceTrigger ||(isMultiSource? (newValue as any[]).some((v, i) =>hasChanged(v, (oldValue as any[])[i])): hasChanged(newValue, oldValue)) ||(__COMPAT__ &&isArray(newValue) &&isCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance))) {// cleanup before running cb againif (cleanup) {cleanup()}callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [newValue,// pass undefined as the old value when it's changed for the first timeoldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue,onCleanup])oldValue = newValue}} else {// watchEffecteffect.run()}}
run
方法执行实际执行getter
即() => traverse(baseGetter())
,此时newValue
为cc
再看下traverse
方法,它用于深度遍历对象的所有属性,确保对象的所有依赖都被追踪
export function traverse(value: unknown, seen?: Set<unknown>) {if (!isObject(value) || (value as any)[ReactiveFlags.SKIP]) {return value}seen = seen || new Set()if (seen.has(value)) {return value}seen.add(value)if (isRef(value)) {traverse(value.value, seen)} else if (isArray(value)) {for (let i = 0; i < value.length; i++) {traverse(value[i], seen)}} else if (isSet(value) || isMap(value)) {value.forEach((v: any) => {traverse(v, seen)})} else if (isPlainObject(value)) {for (const key in value) {traverse((value as any)[key], seen)}}return value
}
该方法由于值类型不同,会递归处理返回最终的值,接着执行callWithAsyncErrorHandling
方法:
export function callWithAsyncErrorHandling(fn: Function | Function[],instance: ComponentInternalInstance | null,type: ErrorTypes,args?: unknown[]
): any[] {if (isFunction(fn)) {const res = callWithErrorHandling(fn, instance, type, args)if (res && isPromise(res)) {res.catch(err => {handleError(err, instance, type)})}return res}const values = []for (let i = 0; i < fn.length; i++) {values.push(callWithAsyncErrorHandling(fn[i], instance, type, args))}return values
}export function callWithErrorHandling(fn: Function,instance: ComponentInternalInstance | null,type: ErrorTypes,args?: unknown[]
) {let res// 统一处理监听 错误try {res = args ? fn(...args) : fn()} catch (err) {handleError(err, instance, type)}return res
}
执行了cb
回调函数即watch
传入的匿名函数,callWithAsyncErrorHandling
主要是对错误统一监听处理,最后将 newValue
赋值给 oldValue
,watch
至此执行完毕
总结
1)watch
函数实际执行的是doWatch
方法,调度器scheduler
在watch
中很关键
2)scheduler
、ReactiveEffect
两者之间存在互相作用的关系,一旦effect
触发了scheduler
,那么会导致queuePreFlushCb(job)
执行,job
方法就被塞入微任务的队列中
3)只要job()
触发,那么就表示watch
触发了一次