侦听器
基本示例
计算属性允许我们声明性地计算衍生值。然而,在有些情况下,为了应对一些状态的变化,我们需要运行些effect(副作用):例如更改 DOM,或者根据异步操作的结果,去修改另一处的状态。
在组合式 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...' 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>{{ question }}</p> </template>
侦听来源类型
watch
的第一个参数,可以是不同形式的“数据源”:它可以是一个ref(包括计算属性)、一个响应式对象、一个getter函数、或多个来源组成的数组:
const x = ref(0) const y = ref(0) // 单个 refwatch (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() 传入了一个 numberwatch (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函数,只有在getter函数返回不同的对象时,才会触发回调:
watch ( () => state.someObject, () => { // 仅当 state.someObject 被替换时触发 } )
然而,在上面的例子里,你可以显式地加上deep
选项,强制转成深层侦听器:
watch ( () => state.someObject, (newValue, oldValue) => { // 注意:`newValue` 此处和 `oldValue` 是相等的 // *除非* state.someObject 被整个替换了 }, { deep: true } )
深度侦听需要遍历被侦听对象中的所有嵌套的 property,当用于大型数据结构时,开销很大。因此请只在必要时才使用它,并且要留意性能。
watchEffect()
watch()
是懒执行的:仅在侦听源变化时,才会执行回调。但在某些场景中,我们希望在创建侦听器时,立即执行一遍回调,或者说要积极地执行回调。举个例子,我们想请求一些初始数据,然后在相关状态更改时重新请求数据。我们可以这样写:
const url = ref('https://...') const data = ref(null) async function fetchData() { const response = await fetch(url.value) data.value = await response.json() } // 立即获取 fetchData() // ...再侦听 url 变化watch (url, fetchData)
这段代码还可以用watchEffect()函数来简化。watchEffect()
会立即执行一遍回调函数,如果这时函数产生了effect(副作用),Vue 会自动追踪effect的依赖关系,自动分析出响应源。上面的例子可以重写为:
const url = ref('https://...') const data = ref(null) watchEffect(async () => { const response =await fetch (url.value) data.value = await response.json() })
这个例子中,回调会立即执行。在执行期间,它会自动追踪url.value作为依赖(近似于计算属性)。每当url.value变化时,回调会再次执行。
watchEffect()
仅会在其同步执行期间,才追踪依赖。在使用异步回调时,只有在第一个await
正常工作前访问到属性,才会被追踪。
watch vs. watchEffect
watch
和watchEffect
都能响应式地执行有effect(副作用)的回调。它们之间的主要区别是追踪响应式依赖的方式:
watch
只追踪明确侦听的源。它不会追踪任何在回调中访问到的东西。另外,仅在响应源确实改变时才会触发回调。watch
会避免在发生副作用时追踪依赖,因此,我们能更加精确地控制回调函数的触发时机。watchEffect
会在effect(副作用)发生期间追踪依赖。它会在同步执行过程中,自动追踪所有能访问到的响应式 property。这更方便,而且代码往往更简洁,但其响应性依赖关系不那么明确。
回调的刷新时机
当你更改了响应式状态,它可能会同时触发 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>
中用同步语句创建的侦听器,会自动绑定到宿主组件实例上,并且会在宿主组件卸载时自动停止。因此,在大多数情况下,你无需关心怎么停止一个侦听器。
一个关键点是,侦听器必须用同步语句创建:如果用异步回调创建一个侦听器,那么它不会绑定到当前组件上,你必须手动停止它,以防内存泄漏。如下方这个例子:
<script setup> import { watchEffect } from 'vue' // 它会自动停止watchEffect (() => {}) // ...这个则不会! setTimeout(() => {watchEffect (() => {}) }, 100) </script>
要手动停止一个侦听器,请调用watch
或watchEffect
返回的函数:
const unwatch =watchEffect (() => {}) // ...当该侦听器不再需要时onBeforeUnmount (() =>unwatch())
注意,需要异步创建侦听器的情况很少,请尽可能选择同步创建。如果需要等待一些异步数据,你可以使用条件式的侦听逻辑:
// 需要异步请求得到的数据 const data = ref(null)watchEffect (() => { if (data.value) { // 得到数据后要做的事... } })