vue 侦听器 watch

基本示例

计算属性允许我们声明性地计算衍生值。然而在有些情况下，我们需要在状态变化时执行一些“副作用”：例如更改 DOM，或是根据异步操作的结果去修改另一处的状态。

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

vue

<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...";
    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 的第一个参数可以是不同形式的“数据源”：它可以是一个 ref (包括计算属性)、一个响应式对象、一个 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}`);
});

注意，你不能直接侦听响应式对象的属性值，例如：

const obj = reactive({ count: 0 });

// 错误，因为 watch() 得到的参数是一个 number
watch(obj.count, (count) => {
  console.log(`count is: ${count}`);
});

这里需要用一个返回该属性的 getter 函数：

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

深层侦听器

直接给 watch() 传入一个响应式对象，会隐式地创建一个深层侦听器——该回调函数在所有嵌套的变更时都会被触发：

const obj = reactive({ count: 0 });

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

obj.count++;

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

watch(
  () => state.someObject,
  () => {
    // 仅当 state.someObject 被替换时触发
  },
);

你也可以给上面这个例子显式地加上 deep 选项，强制转成深层侦听器：

watch(
  () => state.someObject,
  (newValue, oldValue) => {
    // 注意：`newValue` 此处和 `oldValue` 是相等的
    // *除非* 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() 可能会比深度侦听器更有效，因为它将只跟踪回调中被使用到的属性，而不是递归地跟踪所有的属性。

TIP

watchEffect 仅会在其同步执行期间，才追踪依赖。在使用异步回调时，只有在第一个 await 正常工作前访问到的属性才会被追踪。

`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 更新后执行 */
});

停止侦听器

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

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

vue

<script setup>
import { watchEffect } from "vue";

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

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

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

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

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

注意，需要异步创建侦听器的情况很少，请尽可能选择同步创建。如果需要等待一些异步数据，你可以使用条件式的侦听逻辑：

// 需要异步请求得到的数据
const data = ref(null);

watchEffect(() => {
  if (data.value) {
    // 数据加载后执行某些操作...
  }
});

案例

watch 函数

与 watch 配置功能一致
监视指定的一个或多个响应式数据，一旦数据变化，就自动执行监视回调
默认初始时不执行回调，但可以通过配置 immediate 为 true , 来指定初始时立即执行第一次
通过配置 deep 为 true , 来指定深度监视

目标：可以侦听 data/computed 属性值改变

语法：

watch("被侦听的属性名", (oldVal) => {});

完整例子代码：

vue

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

const first_name = ref("张");
const last_name = ref("大毛");
const full_name = ref("张 大毛");

/*
  watch 一个数据
  默认在数据发生改变时执行回调
*/
watch(first_name, (val) => {
  full_name.value = val + " " + last_name.value;
});

watch(last_name, (val) => {
  full_name.value = first_name.value + " " + val;
});

// 用计算属性实现同样的效果
// const full_name = computed(() => {
//   return first_name.value + ' ' + last_name.value
// })
</script>

<template>
  <div class="container">
    <form action="">
      <div class="mb-3 row">
        <label for="inputPassword" class="col-sm-3 col-form-label">姓：</label>
        <div class="col-sm-9">
          <input type="text" class="form-control" v-model="last_name" />
        </div>
      </div>
      <div class="mb-3 row">
        <label for="inputPassword" class="col-sm-3 col-form-label">名：</label>
        <div class="col-sm-9">
          <input type="text" class="form-control" v-model="first_name" />
        </div>
      </div>
      <div class="mb-3 row">
        <label for="inputPassword" class="col-sm-3 col-form-label"
          >姓名：</label
        >
        <div class="col-sm-9">
          <input type="text" class="form-control" v-model="full_name" />
        </div>
      </div>
    </form>
  </div>
</template>

<style scoped></style>

总结：想要侦听一个属性变化，可使用侦听属性 watch

深度侦听和立即执行

目标：侦听复杂类型，或者立即执行侦听函数

语法：

watch: {
    "要侦听的属性名": {
        immediate: true, // 立即执行
        deep: true, // 深度侦听复杂类型内变化
        handler (newVal, oldVal) {
        }
    }
}

完整例子代码：

vue

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

const user = reactive({
  firstName: "正",
  lastName: "心",
});

const fullName3 = ref("");
/*
使用 watch 的 2 个特性：
  深度监视
  初始化立即执行
*/
watch(
  user,
  () => {
    fullName3.value = user.firstName + "-" + user.lastName;
  },
  {
    immediate: true, // 深度侦听 (对象里面层的值改变), 默认是 false
    deep: true, // 深度侦听 (对象里面层的值改变), 默认是 false
  },
);

/*
watch 一个数据
  默认在数据发生改变时执行回调
*/
watch(fullName3, (value) => {
  console.log("watch");
  const names = value.split("-");
  user.firstName = names[0];
  user.lastName = names[1];
});

/*
watch 多个数据：
  使用数组来指定
  如果是 ref 对象，直接指定
  如果是 reactive 对象中的属性，必须通过函数来指定
*/
watch([() => user.firstName, () => user.lastName, fullName3], (values) => {
  console.log("监视多个数据", values);
});
</script>

<template>
  姓：<input v-model="user.firstName" /><br />
  名：<input v-model="user.lastName" /><br />
  姓名：<input v-model="fullName3" /><br />
</template>

总结：immediate 立即侦听，deep 深度侦听，handler 固定方法触发

附录

vue3 介绍

数据绑定

数据渲染

计算属性

组件基础

生命周期

深入组件

路由使用

路由进阶

案例

vue 侦听器 watch

基本示例

侦听数据源类型

深层侦听器

即时回调的侦听器

`watchEffect()`

`watch` vs. `watchEffect`

回调的触发时机

停止侦听器

案例

watch 函数

深度侦听和立即执行

vue 侦听器 watch ​

基本示例 ​

侦听数据源类型 ​

深层侦听器 ​

即时回调的侦听器 ​

watchEffect() ​

watch vs. watchEffect ​

回调的触发时机 ​

停止侦听器 ​

案例 ​

watch 函数 ​

深度侦听和立即执行 ​

vue 侦听器 watch

基本示例

侦听数据源类型

深层侦听器

即时回调的侦听器

`watchEffect()`

`watch` vs. `watchEffect`

回调的触发时机

停止侦听器

案例

watch 函数

深度侦听和立即执行