La soi-disant montre, son essence est d'observer des données réactives, de notifier et d'exécuter la fonction de rappel correspondante lorsque les données changent. En fait, l'essence de la mise en œuvre de watch est d'utiliser les options effect et options.scheduler. Comme le montre l'exemple suivant :
// watch 函数接收两个参数，source 是响应式数据，cb 是回调函数
function watch(source, cb){
effect(
// 触发读取操作，从而建立联系
() => source.foo,
{
scheduler(){
// 当数据变化时，调用回调函数 cb
cb()
}
}
)
}Comme indiqué dans le code, source correspond aux données réactives et cb est la fonction de rappel. S'il existe une option de planification dans la fonction d'effet secondaire, lorsque les données réactives changent, l'exécution de la fonction de planification sera déclenchée au lieu de déclencher directement l'exécution de la fonction d'effet secondaire. De ce point de vue, la fonction de planification du planificateur est équivalente à une fonction de rappel, et la mise en œuvre de watch en profite. La signature de fonction de
La source de données à écouter peut être un tableau, comme indiqué dans la signature de fonction ci-dessous :
// packages/runtime-core/src/apiWatch.ts // 数据源是一个数组 // overload: array of multiple sources + cb export function watch< T extends MultiWatchSources, Immediate extends Readonly<boolean> = false >( sources: [...T], cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>, options?: WatchOptions<Immediate> ): WatchStopHandle
Un tableau peut également être utilisé pour écouter plusieurs sources à en même temps, comme indiqué ci-dessous La signature de la fonction est la suivante :
// packages/runtime-core/src/apiWatch.ts
// 使用数组同时侦听多个源
// overload: multiple sources w/ `as const`
// watch([foo, bar] as const, () => {})
// somehow [...T] breaks when the type is readonly
export function watch<
T extends Readonly<MultiWatchSources>,
Immediate extends Readonly<boolean> = false
>(
source: T,
cb: WatchCallback<MapSources<T, false>, MapSources<T, Immediate>>,
options?: WatchOptions<Immediate>
): WatchStopHandleLa source de données à écouter est une donnée de type ref ou une fonction getter avec une valeur de retour, comme indiqué ci-dessous signature de fonction :
// packages/runtime-core/src/apiWatch.ts // 数据源是一个 ref 类型的数据 或者是一个具有返回值的 getter 函数 // overload: single source + cb export function watch<T, Immediate extends Readonly<boolean> = false>( source: WatchSource<T>, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate> ): WatchStopHandle export type WatchSource<T = any> = Ref<T> | ComputedRef<T> | (() => T)
Les données à écouter La source est un objet obj responsive, comme le montre la signature de fonction suivante :
// packages/runtime-core/src/apiWatch.ts // 数据源是一个响应式的 obj 对象 // overload: watching reactive object w/ cb export function watch< T extends object, Immediate extends Readonly<boolean> = false >( source: T, cb: WatchCallback<T, Immediate extends true ? T | undefined : T>, options?: WatchOptions<Immediate> ): WatchStopHandle
// packages/runtime-core/src/apiWatch.ts
// implementation
export function watch<T = any, Immediate extends Readonly<boolean> = false>(
source: T | WatchSource<T>,
cb: any,
options?: WatchOptions<Immediate>
): WatchStopHandle {
if (__DEV__ && !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 as any, cb, options)
}Comme vous pouvez le voir, la fonction watch reçoit 3 paramètres, qui sont : source La source de données à écouter, la fonction de rappel cb, les options d'écoute.
Vous pouvez savoir grâce à la surcharge de fonction de watch que lors de l'écoute d'une seule source, la source peut être une donnée de type ref ou une fonction getter avec une valeur de retour, ou elle peut être un objet obj réactif. Lors de l’écoute de plusieurs sources, la source peut être un tableau.
Dans la fonction de rappel cb, il fournit aux développeurs la dernière valeur, l'ancienne valeur et la fonction onCleanup pour nettoyer les effets secondaires. Comme le montre la définition de type suivante :
export type WatchCallback<V = any, OV = any> = ( value: V, oldValue: OV, onCleanup: OnCleanup ) => any
options options peuvent contrôler le comportement de la montre Par exemple, le paramètre option immédiat des options peut être utilisé pour contrôler si le rappel de la montre est exécuté immédiatement, et le paramètre option des options peut être utilisé pour contrôler la fonction de rappel de la montre, qu'elle s'exécute de manière synchrone ou asynchrone. La définition de type du paramètre options est la suivante :
export interface WatchOptionsBase extends DebuggerOptions {
flush?: 'pre' | 'post' | 'sync'
}
export interface WatchOptions<Immediate = boolean> extends WatchOptionsBase {
immediate?: Immediate
deep?: boolean
}Vous pouvez voir la définition de type des options WatchOptions hérite de WatchOptionsBase. C'est-à-dire qu'en plus des deux paramètres uniques immédiats et profonds dans les options de surveillance, tous les paramètres de WatchOptionsBase peuvent également être transmis pour contrôler le comportement de l'exécution des effets secondaires.
La fonction doWatch est appelée dans le corps de la fonction watch. Jetons un coup d'œil à son implémentation.
En fait, qu'il s'agisse de la fonction watch ou de la fonction watchEffect, la fonction doWatch est finalement appelée lors de l'exécution.
function doWatch(
source: WatchSource | WatchSource[] | WatchEffect | object,
cb: WatchCallback | null,
{ immediate, deep, flush, onTrack, onTrigger }: WatchOptions = EMPTY_OBJ
): WatchStopHandleLa signature de fonction de doWatch est fondamentalement la même que la signature de fonction de la montre et reçoit également trois paramètres. Afin de faciliter l'utilisation de l'option options, la fonction doWatch la déconstruit.
Tout d'abord, récupérez l'instance actuelle du composant via le composant, puis déclarez trois variables différentes. L'une des fonctions s'appelle un getter, qui est transmis comme argument à la fonction d'effet secondaire. La variable forceTrigger est une valeur booléenne qui indique si la fonction d'effet secondaire doit être forcée. La variable isMultiSource est également une valeur booléenne, utilisée pour indiquer si la source de données d'écoute est une source unique ou plusieurs sources transmises sous la forme d'un tableau. La valeur initiale est fausse, indiquant que la source de données d'écoute est une source unique. Comme indiqué dans le code ci-dessous :
const instance = currentInstance let getter: () => any // 是否需要强制触发副作用函数执行 let forceTrigger = false // 侦听的是否是多个源 let isMultiSource = false
Ensuite, initialisez ces trois variables en fonction de la source de données écoutée.
La source de données d'écoute est une donnée de type ref
Lorsque la source de données d'écoute est une donnée de type ref, le getter est initialisé en renvoyant source.value, c'est-à-dire que lorsque la fonction getter est déclenchée, les données d'écoute réelles sera obtenu via source.value. Utilisez ensuite la fonction isShallow pour déterminer si la source de données écoutée est une réponse superficielle et attribuez le résultat à forceTrigger pour terminer l'initialisation de la variable forceTrigger. Comme le montre le code suivant :
if (isRef(source)) {
// 侦听的数据源是 ref
getter = () => source.value
// 判断数据源是否是浅响应
forceTrigger = isShallow(source)
}La source de données d'écoute est une donnée réactive
Lorsque la source de données d'écoute est une donnée réactive, la source est renvoyée directement pour initialiser le getter, c'est-à-dire lorsque la fonction getter est déclenché Renvoie directement la source de données d'écoute. Étant donné que les données réactives peuvent être un objet objet, défini en profondeur sur vrai, et que les valeurs d'attribut de l'objet peuvent être lues de manière récursive lorsque la fonction getter est déclenchée. Comme le montre le code ci-dessous :
else if (isReactive(source)) {
// 侦听的数据源是响应式数据
getter = () => source
deep = true
}La source de données d'écoute est un tableau
Lorsque la source de données d'écoute est un tableau, c'est-à-dire que plusieurs sources sont écoutées en même temps. À ce stade, définissez directement la variable isMultiSource sur true, indiquant que plusieurs sources sont écoutées. Utilisez ensuite la méthode some du tableau pour détecter s'il existe des objets réactifs dans les multiples sources d'écoute et attribuez les résultats à forceTrigger. Parcourez le tableau et terminez l'initialisation de la fonction getter en fonction du type de chaque source. Comme indiqué dans le code ci-dessous :
else if (isArray(source)) {
// 侦听的数据源是一个数组，即同时侦听多个源
isMultiSource = true
forceTrigger = source.some(isReactive)
getter = () =>
// 遍历数组，判断每个源的类型
source.map(s => {
if (isRef(s)) {
// 侦听的数据源是 ref
return s.value
} else if (isReactive(s)) {
// 侦听的数据源是响应式数据
return traverse(s)
} else if (isFunction(s)) {
// 侦听的数据源是一个具有返回值的 getter 函数
return callWithErrorHandling(s, instance, ErrorCodes.WATCH_GETTER)
} else {
__DEV__ && warnInvalidSource(s)
}
})
}La source de données d'écoute est une fonction
当侦听的数据源是一个具有返回值的 getter 函数时，判断 doWatch 函数的第二个参数 cb 是否有传入。如果有传入，则处理的是 watch 函数的场景，此时执行 source 函数，将执行结果赋值给 getter 。该情况仅适用于 watchEffect 函数未接收到参数的情况。如果组件实例已被卸载，则直接返回而不执行 source 函数，根据该场景进行处理。如果未能执行成功，则执行清除依赖的代码并调用source函数，将返回结果赋值给getter。如下面的代码所示：
else if (isFunction(source)) {
// 处理 watch 和 watchEffect 的场景
// watch 的第二个参数可以是一个具有返回值的 getter 参数，第二个参数是一个回调函数
// watchEffect 的参数是一个 函数
// 侦听的数据源是一个具有返回值的 getter 函数
if (cb) {
// getter with cb
// 处理的是 watch 的场景
// 执行 source 函数，将执行结果赋值给 getter
getter = () =>
callWithErrorHandling(source, instance, ErrorCodes.WATCH_GETTER)
} else {
// no cb -> simple effect
// 没有回调，即为 watchEffect 的场景
getter = () => {
// 件实例已经卸载，则不执行，直接返回
if (instance && instance.isUnmounted) {
return
}
// 清除依赖
if (cleanup) {
cleanup()
}
// 执行 source 函数
return callWithAsyncErrorHandling(
source,
instance,
ErrorCodes.WATCH_CALLBACK,
[onCleanup]
)
}
}
}如果侦听的数据源是一个响应式数据，需要递归读取响应式数据中的属性值。如下面的代码所示：
// 处理的是 watch 的场景
// 递归读取对象的属性值
if (cb && deep) {
const baseGetter = getter
getter = () => traverse(baseGetter())
}在上面的代码中，doWatch 函数的第二个参数 cb 有传入，说明处理的是 watch 中的场景。deep 变量为 true ，说明此时侦听的数据源是一个响应式数据，因此需要调用 traverse 函数来递归读取数据源中的每个属性，对其进行监听，从而当任意属性发生变化时都能够触发回调函数执行。
声明 cleanup 和 onCleanup 函数，并在 onCleanup 函数的执行过程中给 cleanup 函数赋值，当副作用函数执行一些异步的副作用时，这些响应需要在其失效是清除。如下面的代码所示：
// 清除副作用函数
let cleanup: () => void
let onCleanup: OnCleanup = (fn: () => void) => {
cleanup = effect.onStop = () => {
callWithErrorHandling(fn, instance, ErrorCodes.WATCH_CLEANUP)
}
}为了便于控制 watch 的回调函数 cb 的执行时机，需要将 scheduler 调度函数封装为一个独立的 job 函数，如下面的代码所示：
// 将 scheduler 调度函数封装为一个独立的 job 函数，便于在初始化和变更时执行它
const job: SchedulerJob = () => {
if (!effect.active) {
return
}
if (cb) {
// 处理 watch 的场景
// 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 again
if (cleanup) {
cleanup()
}
// 执行watch 函数的回调函数 cb，将旧值和新值作为回调函数的参数
callWithAsyncErrorHandling(cb, instance, ErrorCodes.WATCH_CALLBACK, [
newValue,
// 首次调用时，将 oldValue 的值设置为 undefined
// pass undefined as the old value when it's changed for the first time
oldValue === INITIAL_WATCHER_VALUE ? undefined : oldValue,
onCleanup
])
// 更新旧值，不然下一次会得到错误的旧值
oldValue = newValue
}
} else {
// watchEffect
// 处理 watchEffect 的场景
effect.run()
}
}在 job 函数中，判断回调函数 cb 是否传入，如果有传入，那么是 watch 函数被调用的场景，否则就是 watchEffect 函数被调用的场景。
如果是 watch 函数被调用的场景，首先执行副作用函数，将执行结果赋值给 newValue 变量，作为最新的值。然后判断需要执行回调函数 cb 的情况：
如果侦听的数据源是响应式数据，需要深度侦听，即 deep 为 true
如果需要强制触发副作用函数执行，即 forceTrigger 为 true
如果新旧值发生了变化
如果存在上述三种情况之一，就必须执行 watch 函数的回调函数 cb。如果回调函数 cb 是再次执行，在执行之前需要先清除副作用。然后调用 callWithAsyncErrorHandling 函数执行回调函数cb，并将新值newValue 和旧值 oldValue 传入回调函数cb中。在回调函数cb执行后，更新旧值oldValue，避免在下一次执行回调函数cb时获取到错误的旧值。
如果是 watchEffect 函数被调用的场景，则直接执行副作用函数即可。
设置 job 函数的 allowRecurse 属性根据是否传递回调函数 cb 来进行。这个设置非常关键，因为它可以使作业充当监听器的回调，这样调度程序就能够知道它是否允许调用自身。
// important: mark the job as a watcher callback so that scheduler knows // it is allowed to self-trigger (#1727) // 重要：让调度器任务作为侦听器的回调以至于调度器能知道它可以被允许自己派发更新 job.allowRecurse = !!cb
在调用 watch 函数时，可以通过 options 的 flush 选项来指定回调函数的执行时机：
当 flush 的值为 sync 时，代表调度器函数是同步执行，此时直接将 job 赋值给 scheduler，这样调度器函数就会直接执行。
当 flush 的值为 post 时，代表调度函数需要将副作用函数放到一个微任务队列中，并等待 DOM 更新结束后再执行。
当 flush 的值为 pre 时，即调度器函数默认的执行方式，这时调度器会区分组件是否已经挂载。如果组件未挂载，则先执行一次调度函数，即执行回调函数cb。在组件挂载之后，将调度函数推入一个优先执行时机的队列中。
// 这里处理的是回调函数的执行时机
let scheduler: EffectScheduler if (flush === 'sync') { // 同步执行，将 job 直接赋值给调度器 scheduler = job as any // the scheduler function gets called directly } else if (flush === 'post') { // 将调度函数 job 添加到微任务队列中执行 scheduler = () => queuePostRenderEffect(job, instance && instance.suspense) } else { // default: 'pre' // 调度器函数默认的执行模式 scheduler = () => { if (!instance || instance.isMounted) { // 组件挂载后将 job 推入一个优先执行时机的队列中 queuePreFlushCb(job) } else { // with 'pre' option, the first call must happen before // the component is mounted so it is called synchronously. // 在 pre 选型中，第一次调用必须发生在组件挂载之前 // 所以这次调用是同步的 job() } } }
初始化完 getter 函数和调度器函数 scheduler 后，调用 ReactiveEffect 类来创建一个副作用函数
// 创建一个副作用函数 const effect = new ReactiveEffect(getter, scheduler)
在执行副作用函数之前，首先判断是否传入了回调函数cb，如果有传入，则根据 options 的 immediate 选项来判断是否需要立即执行回调函数cb，如果指定了immediate 选项，则立即执行 job 函数，即 watch 的回调函数会在 watch 创建时立即执行一次。如果不这样做，就需要手动调用副作用函数，将其返回值赋值给oldValue作为旧值。如下面的代码所示：
if (cb) {
// 选项参数 immediate 来指定回调是否需要立即执行
if (immediate) {
// 回调函数会在 watch 创建时立即执行一次
job()
} else {
// 手动调用副作用函数，拿到的就是旧值
oldValue = effect.run()
}
}如果 options 的 flush 选项的值为 post ，需要将副作用函数放入到微任务队列中，等待组件挂载完成后再执行副作用函数。如下面的代码所示：
else if (flush === 'post') {
// 在调度器函数中判断 flush 是否为 'post'，如果是，将其放到微任务队列中执行
queuePostRenderEffect(
effect.run.bind(effect),
instance && instance.suspense
)
}其余情况都是立即执行副作用函数。如下面的代码所示：
else {
// 其余情况立即首次执行副作用
effect.run()
}最终，doWatch函数返回了一个匿名函数，该函数用于取消对数据源的监听。因此在调用 watch 或者 watchEffect 时，可以调用其返回值类结束侦听。
return () => {
effect.stop()
if (instance && instance.scope) {
// 返回一个函数，用以显式的结束侦听
remove(instance.scope.effects!, effect)
}
}Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!
La différence entre vue2.0 et 3.0
Quels sont les cycles de vie de vue3
Comment utiliser la fonction vlookup
A quoi sert principalement javascript ?
Que sont les instructions de contrôle de flux Java ?
chaîne de correspondance d'expression régulière Java
Comment résoudre le problème de l'impossibilité d'ouvrir le gestionnaire de périphériques
Qu'est-ce qu'un concepteur d'interface utilisateur ?
![[Web front-end] Démarrage rapide de Node.js](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
