Vue / 系统课时

watch 与 watchEffect

watch 与 watchEffect

响应式状态发生变化后,有些事情不能写成纯派生值,例如发起请求、写入浏览器存储、同步页面标题或调用第三方 API。这类副作用需要侦听器。本节用一个搜索场景对比 watch 与 watchEffect,并重点处理异步竞态和清理逻辑。

学习目标

  • 根据“显式指定依赖”与“自动收集依赖”的差异选择 watch 或 watchEffect。
  • 用 watch 控制异步请求的触发条件、旧任务取消和结果提交。
  • 识别 watchEffect 的同步依赖收集边界,避免把复杂异步逻辑写成隐式依赖。

先按副作用类型选工具

watch 需要明确给出侦听源,回调只在源变化时执行,并且可以拿到新旧值。它适合搜索请求、分页联动、表单字段联动等“触发条件必须可审计”的逻辑。

watchEffect 会立即运行一次,并自动收集同步执行期间读取的响应式依赖。它适合把多个状态同步到一个外部目标,例如更新标题、打印调试信息或绑定简单的浏览器 API。依赖越多、异步分支越复杂,就越应该倾向 watch。

watch 与 watchEffect 选择流程

用 watch 管理异步搜索

下面的组件把 query 作为唯一侦听源。每次输入变化时,onCleanup 都会中止上一轮尚未完成的任务,只有最新请求允许提交结果。真实项目使用 fetch 时,同样可以把 AbortController.signal 传给请求。

vue
<script setup lang="ts">
import { ref, watch, watchEffect } from 'vue'

const query = ref('')
const result = ref('请输入关键词')
const loading = ref(false)

function searchKeyword(keyword: string, signal: AbortSignal): Promise<string> {
  return new Promise((resolve, reject) => {
    const timer = window.setTimeout(() => resolve(`结果:${keyword}`), 400)

    signal.addEventListener('abort', () => {
      window.clearTimeout(timer)
      reject(new DOMException('Aborted', 'AbortError'))
    }, { once: true })
  })
}

watch(query, async (keyword, _oldKeyword, onCleanup) => {
  const normalized = keyword.trim()
  if (!normalized) {
    result.value = '请输入关键词'
    loading.value = false
    return
  }

  const controller = new AbortController()
  onCleanup(() => controller.abort())

  loading.value = true

  try {
    result.value = await searchKeyword(normalized, controller.signal)
  } catch (error) {
    if (!(error instanceof DOMException && error.name === 'AbortError')) {
      throw error
    }
  } finally {
    // 被新一轮输入中止的旧任务不能把最新请求的 loading 改回 false。
    if (!controller.signal.aborted) {
      loading.value = false
    }
  }
})

watchEffect(() => {
  // 依赖在同步执行时自动收集,适合简单的外部同步。
  document.title = loading.value ? `搜索中:${query.value}` : '搜索完成'
})
</script>

<template>
  <section>
    <input v-model="query" placeholder="输入关键词" />
    <p>{{ loading ? '搜索中…' : result }}</p>
  </section>
</template>

预期结果:连续快速输入 vue、vue3 时,前一次尚未完成的任务会被中止,不会覆盖最后一次输入对应的结果;搜索期间页面标题显示当前关键词,完成后恢复为“搜索完成”。

text
输入:vue
页面:搜索中…

快速继续输入:vue3
页面:搜索中…

约 400ms 后
页面:结果:vue3
浏览器标题:搜索完成

实际计时会受浏览器调度影响,示例中的约 400ms 只用于观察行为。

什么时候用 watchEffect

如果副作用本身天然表达了依赖关系,watchEffect 会更简洁。例如“只要任一设置变化,就把当前组合结果写入 localStorage”,无需手工维护依赖数组。新增一个在 effect 内被读取的响应式值时,它会自动进入依赖集合。

但自动追踪只发生在当前同步执行阶段。对于异步 effect,第一次 await 之后才读取到的响应式状态不会自动成为依赖。因此,网络请求、竞态处理、旧任务清理以及需要精确触发条件的联动逻辑,通常使用 watch 更清楚。

常用控制点

watch 默认不会在创建后立刻执行;需要首次也运行时可使用 immediate: true。侦听对象内部深层字段时,可以选择更具体的 getter 作为源,避免为了方便直接深度侦听一个庞大对象。

当组件卸载时,在 setup 同步创建的侦听器会随组件作用域自动停止;而在异步回调中延迟创建的侦听器更难管理,应尽量避免。对企业代码来说,触发源越明确、清理边界越清晰,副作用越容易测试和排查。

可以把选择原则压缩成一句话:值的计算交给 computed,明确条件触发的副作用交给 watch,简单的自动依赖同步交给 watchEffect。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

watch 与 watchEffect

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通