vue3-侦听器

侦听器

• 计算属性允许我们声明性地计算衍生值。

• 需求在状态变化时进行一些操作，比如更改 Dom,根据异步操作结果去修改另外的数据状态。

watch

1. 监听异步请求结果

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


const question = ref('')
const answer = ref('问题需要包含一个问号 ;-)')
const loading = ref(false)

// 可以直接侦听一个 ref
watch(question, async (newQuestion, oldQuestion) => {
    if (newQuestion.includes('?')) {
        loading.value = true
        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
        } finally {
            loading.value = false
        }
    }
})

</script>

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

<style lang="scss" scoped>
.container {}
</style>

示例

侦听数据源类型

• ref (包括计算属性)

• 一个响应式对象

• 一个 getter 函数

• 多个数据源组成的数组

<script lang="ts" setup>
import { ref, watch } from "vue"
const a = ref(0)
const b = ref(0)
const sum = ref(0)

// 监听ref
watch(a, (newA: number) => {
    a.value = newA
})

// 监听getter函数
watch(
    () => a.value + b.value,
    (sum) => {
        console.log(sum)
    }
)

// 多个来源组成的数组
watch([a, () => b.value], ([newA, newB]) => {
    console.log(newA, newB)
    sum.value = newA + newB
})

a.value = 1;
b.value = 2;

//修改数据
const changeData = () => {
    a.value = 10;
    b.value = 20
}
</script>

<template>
    <div class="container">
        <h1>a的值{{ a }}</h1>
        <h1>b的值{{ b }}</h1>
        <h1>sum的值{{ sum }}</h1>
        <button @click="changeData">修改数据</button>
    </div>
</template>

<style lang="scss" scoped>
.container {}
</style>

直接侦听响应式对象的属性值

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 }
)

深度侦听需要遍历被侦听对象中的所有嵌套的属性，当用于大型数据结构时，开销很大。因此请只在必要时才使用它，并且要留意性能。

即时回调的侦听器

1. watch 默认是懒执行的：仅当数据源变化时，才会执行回调

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

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

const count = ref(0)
const person = reactive({ name: '王大可', age: 18 })

watch(
  person,
  (newValue, oldValue) => {
    console.log(newValue, oldValue)
    count.value++
  },
  { immediate: true }
)
</script>

<template>
  <div class="container">
    <h2>对象监听变更次数 ：{{ count }}</h2>
  </div>
</template>

<style lang="scss" scoped>
.container {
}
</style>

watchEffect

• 当 id 发生变化请求远程资源数据 watch 实现监听

<script lang="ts" setup>
import { reactive, ref, watch } from 'vue'
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 }
)
</script>

<template>
  <div class="container">
    <h2>data数据 ：{{ data }}</h2>
  </div>
</template>

<style lang="scss" scoped>
.container {
}
</style>

效果：

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

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

1. 回调会立即执行.相当于 immediate: true。

2. 对于有多个依赖项的侦听器来说，使用 watchEffect() 可以消除手动维护依赖列表的负担。

3. 如果你需要侦听一个嵌套数据结构中的几个属性，watchEffect() 可能会比深度侦听器更有效，因为它将只跟踪回调中被使用到的属性，而不是递归地跟踪所有的属性。

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

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

<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) {
    // 数据加载后执行某些操作...
  }
})