Vue / 知识点

Vue 3 开发速查手册

手册条目

使用 watchEffect 自动收集同步执行期间访问的响应式依赖。

自动追踪副作用

当副作用依赖多个响应式值,或依赖关系会随分支变化时,使用 watchEffect 可在执行回调时自动收集被读取的依赖,并在依赖变化后重新运行。它适合请求刷新、日志联动和轻量同步;需要精确控制监听源时应改用 watch。

基本语法

watchEffect(effect, options?) 会立即执行一次回调。回调同步执行期间读取到的 ref、reactive 属性或计算值会成为依赖;任一依赖变化后,Vue 会安排下一次执行。

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

const keyword = ref('vue')
const page = ref(1)

watchEffect((onCleanup) => {
  const controller = new AbortController()

  // 同步读取 keyword 和 page,因此两者都会成为依赖
  console.log(`load: keyword=${keyword.value}, page=${page.value}`)

  onCleanup(() => {
    controller.abort()
    console.log('cleanup previous effect')
  })
})

setTimeout(() => {
  page.value = 2
}, 0)
</script>

<template>
  <p>{{ keyword }} / page {{ page }}</p>
</template>

预期输出

text
load: keyword=vue, page=1
cleanup previous effect
load: keyword=vue, page=2

开发环境下日志附近可能出现框架调试信息,但读取顺序不变:首次立即执行;page 变化前先清理旧副作用,再运行新副作用。

高频用法

用于自动刷新请求时,把本次请求使用的响应式参数放在回调的同步部分读取,并在 onCleanup 中取消旧请求。用于联动浏览器 API 时,在回调中注册监听器,在清理函数中移除,避免重复绑定。

依赖必须在同步阶段被访问。异步回调执行到第一个 await 后才读取的响应式值不会被自动收集;可在 await 前保存所需值,或改用 watch 显式声明监听源。

常用选项

flush: 'pre' 是默认值,回调通常在组件更新前运行;flush: 'post' 适合读取更新后的 DOM;flush: 'sync' 会同步触发,容易造成重复执行或性能抖动,只应用于简单且低频的状态。

调试依赖时可使用 onTrack 和 onTrigger,它们仅用于开发诊断,不应承载业务逻辑。

风险与边界

回调内若无条件修改自己读取的状态,可能形成持续重跑。触发条件是副作用既读取又反复写入同一依赖;后果是高 CPU、界面卡顿或无限更新。安全替代方案是将状态推导改为 computed,或使用 watch 比较新旧值后再写入。

watchEffect 返回停止函数。组件 setup 同步创建的监听会随组件卸载自动停止;在异步回调中延迟创建的监听可能脱离组件生命周期,应保存并主动调用停止函数。

兼容性

watchEffect 适用于 Vue 3。为兼容较早的 Vue 3 小版本,清理逻辑优先使用回调参数 onCleanup;较新的 onWatcherCleanup 需要按项目锁定的 Vue 版本确认后再使用。

目录与阅读设置

记录一个想法

Vue 3 开发速查手册

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

登录哪都通