前言

关于我为什么要写这篇文章，在于我被问到了watch监听面试题，忽略了一些知识点，所以在此特地查看 vue3文档好好的去掌握一下监听这个概念。

在组合式 API 中，我们可以使用 watch 函数在每次响应式状态发生变化时触发回调函数：

<script setup>
import { ref, watch } from "vue";

const question = ref("");
const answer = ref("Questions usually contain a question mark. ;-)");

// 可以直接侦听一个 ref
watch(question, async (newQuestion, oldQuestion) => {
  if (newQuestion.indexOf("?") > -1) {
    answer.value = "Thinking...";
    console.log(oldQuestion);
    try {
      const res = await fetch("https://yesno.wtf/api");
      answer.value = (await res.json()).answer;
    } catch (error) {
      answer.value = "Error! Could not reach the API. " + error;
    }
  }
});
</script>

<template>
  <p>
    Ask a yes/no question:
    <input v-model="question" />
  </p>
  <p>{{ answer }}</p>
</template>

一. watch 监听参数源

watch 可以监听ref,reactive,getter函数或多个数据源组成的数组，官方例子：

const x = ref(0)
const y = ref(0)

// 单个 ref
watch(x, (newX) => {
  console.log(`x is ${newX}`)
})

// getter 函数
watch(
  () => x.value + y.value,
  (sum) => {
    console.log(`sum of x + y is: ${sum}`)
  }
)

// 多个来源组成的数组
watch([x, () => y.value], ([newX, newY]) => {
  console.log(`x is ${newX} and y is ${newY}`)
})

注意：watch是不能直接监听reactive 的属性值的，需要用到一个返回属性的getter函数

// 提供一个 getter 函数
watch(
  () => obj.count,
  (count) => {
    console.log(`count is: ${count}`)
  }
)

二. 深层侦听器

当wacth直接监听reactive对象时,会隐式创建深层监听器，该回调函数在所有嵌套的变更时都会被触发

const obj = reactive({ count: 0 })

watch(obj, (newValue, oldValue) => {
  // 在嵌套的属性变更时触发
  // 注意：`newValue` 此处和 `oldValue` 是相等的
  // 因为它们是同一个对象！
})

obj.count++

由此看出直接监听reactive对象newValue, oldValue的值是一样的。

相比之下，一个返回响应式对象的 getter 函数，只有在返回不同的对象时，才会触发回调。

举例：

const state = reactive({
  someObject: {
    name: 'John',
    age: 30
  }
});

watch(
  () => state.someObject,
  (newValue, oldValue) => {
    console.log('Callback triggered');
  }
);

state.someObject.age = 31; // 不会触发回调函数

state.someObject = {
  name: 'John',
  age: 32
}; // 会触发回调函数

当然如果上方例子想强制深层监听该对象属性的变化，可以加上deep属性。

const state = reactive({
  someObject: {
    name: 'John',
    age: 30
  }
});

watch(
  () => state.someObject,
  (newValue, oldValue) => {
    console.log('Callback triggered');
  },
  { deep: true }
);

state.someObject.age = 31; // 会触发回调函数

state.someObject = {
  name: 'John',
  age: 32
}; // 会触发回调函数

当我们将 watch 函数的选项对象中的 deep 设置为 true 时，即 { deep: true }，回调函数将在 state.someObject 内部属性发生变化时被触发。因此，当我们修改 state.someObject.age 的值或者整个 state.someObject 对象被替换时，回调函数都会被触发。

使用 deep: true 选项可以递归地监听对象内部属性的变化，使得回调函数更加灵活和全面地响应对象的变化。

三. 即时回调侦听

watch 默认是懒执行的：仅当数据源变化时，才会执行回调。但在某些场景中，我们希望在创建侦听器时，立即执行一遍回调。举例来说，我们想请求一些初始数据，然后在相关状态更改时重新请求数据。

我们可以通过传入 immediate: true 选项来强制侦听器的回调立即执行：

watch(source, (newValue, oldValue) => {
  // 立即执行，且当 `source` 改变时再次执行
}, { immediate: true })

四. watchEffect

侦听器的回调使用与源完全相同的响应式状态是很常见的。例如下面的代码，在每当 todoId 的引用发生变化时使用侦听器来加载一个远程资源：

const todoId = ref(1)
const data = ref(null)

watch(todoId, async () => {
  const response = await fetch(
    `https://jsonplaceholder.typicode.com/todos/${todoId.value}`
  )
  data.value = await response.json()
}, { immediate: true })

特别是注意侦听器是如何两次使用 todoId 的，一次是作为源，另一次是在回调中。

我们可以用 watchEffect 函数来简化上面的代码。watchEffect() 允许我们自动跟踪回调的响应式依赖。上面的侦听器可以重写为：

watchEffect(async () => {
  const response = await fetch(
    `https://jsonplaceholder.typicode.com/todos/${todoId.value}`
  )
  data.value = await response.json()
})

这个例子中，回调会立即执行，不需要指定 immediate: true。在执行期间，它会自动追踪 todoId.value 作为依赖（和计算属性类似）。每当 todoId.value 变化时，回调会再次执行。有了 watchEffect()，我们不再需要明确传递 todoId 作为源值。

你可以参考一下这个例子的 watchEffect 和响应式的数据请求的操作。

对于这种只有一个依赖项的例子来说，watchEffect() 的好处相对较小。但是对于有多个依赖项的侦听器来说，使用 watchEffect() 可以消除手动维护依赖列表的负担。此外，如果你需要侦听一个嵌套数据结构中的几个属性，watchEffect() 可能会比深度侦听器更有效，因为它将只跟踪回调中被使用到的属性，而不是递归地跟踪所有的属性。

watch vs. watchEffect:

watch 和 watchEffect 都能响应式地执行有副作用的回调。它们之间的主要区别是追踪响应式依赖的方式：

watch 只追踪明确侦听的数据源。它不会追踪任何在回调中访问到的东西。另外，仅在数据源确实改变时才会触发回调。watch 会避免在发生副作用时追踪依赖，因此，我们能更加精确地控制回调函数的触发时机。

watchEffect，则会在副作用发生期间追踪依赖。它会在同步执行过程中，自动追踪所有能访问到的响应式属性。这更方便，而且代码往往更简洁，但有时其响应性依赖关系会不那么明确。

五. 回调的触发时机(面试）

当你更改了响应式状态，它可能会同时触发 Vue 组件更新和侦听器回调。

默认情况下，用户创建的侦听器回调，都会在 Vue 组件更新之前被调用。这意味着你在侦听器回调中访问的 DOM 将是被 Vue 更新之前的状态。

如果想在侦听器回调中能访问被 Vue 更新之后的 DOM，你需要指明 flush: 'post' 选项：

watch(source, callback, {
  flush: 'post'
})

watchEffect(callback, {
  flush: 'post'
})

后置刷新的 watchEffect() 有个更方便的别名 watchPostEffect()：

import { watchPostEffect } from 'vue'

watchPostEffect(() => {
  /* 在 Vue 更新后执行 */
})

以上都是官方的解释，这边仔细的聊一下这个watchPostEffect的作用：

watchPostEffect 是 Vue 3 中的一个高级 API，用于在组件更新之后执行副作用操作。它可以在组件渲染完成后立即触发回调函数，类似于 Vue 2.x 中的 $nextTick。

watchPostEffect 主要用于以下情况：

需要在组件更新后执行某些操作，例如 DOM 操作、访问组件的 refs 或属性等。

需要等待组件更新完成后才能进行一些异步操作，例如发起网络请求、执行动画效果等。

与普通的 watch 监听器不同，watchPostEffect 不会立即执行回调函数，而是在组件渲染完成之后才会触发。这样可以确保在组件更新后执行副作用操作，避免与更新过程中的 DOM 操作冲突或获取到过期的组件数据。总之，watchPostEffect 提供了一种在组件更新后执行副作用操作的方式，可以帮助我们处理需要等待组件渲染完成后才能进行的操作。

下面是一个示例，在组件更新后使用 watchPostEffect 执行副作用操作：

import { watchPostEffect, ref } from 'vue';

export default {
  setup() {
    const count = ref(0);

    watchPostEffect(() => {
      console.log('Component updated:', count.value);
      // 在组件更新后执行副作用操作
      // 可以访问最新的组件数据、执行 DOM 操作等
    });

    return {
      count
    };
  }
}

六. 停止侦听器(面试）

在 setup() 或 <script setup> 中用同步语句创建的侦听器，会自动绑定到宿主组件实例上，并且会在宿主组件卸载时自动停止。因此，在大多数情况下，你无需关心怎么停止一个侦听器。

一个关键点是，侦听器必须用同步语句创建：如果用异步回调创建一个侦听器，那么它不会绑定到当前组件上，你必须手动停止它，以防内存泄漏。如下面这个例子：

<script setup>
import { watchEffect } from 'vue'

// 它会自动停止
watchEffect(() => {})

// ...这个则不会！
setTimeout(() => {
  watchEffect(() => {})
}, 100)
</script>

要手动停止一个侦听器，请调用 watch 或 watchEffect 返回的函数：

const unwatch = watchEffect(() => {})

// ...当该侦听器不再需要时
unwatch()

举个例子：

import { watch, reactive, toRefs } from 'vue';

export default {
  setup() {
    const data = reactive({
      count: 0
    });

    // 创建一个侦听器
    const stopWatcher = watch(() => {
      console.log('Count changed:', data.count);
    });

    // 模拟一段时间后停止侦听器
    setTimeout(() => {
      stopWatcher(); // 调用停止侦听器的函数
      console.log('Watcher stopped');
    }, 5000);

    return {
      ...toRefs(data)
    };
  }
}

vue3 监听数据变化

前言