响应式基础 reactivity-fundamentals

API 参考

本页和后面很多页面中都分别包含了选项式 API 和组合式 API 的示例代码。现在你选择的是选项式 API组合式 API。你可以使用左侧侧边栏顶部的 “API 风格偏好” 开关在 API 风格之间切换。

声明响应式状态 declaring-reactive-state

选用选项式 API 时，会用 data 选项来声明组件的响应式状态。此选项的值应为返回一个对象的函数。Vue 将在创建新组件实例的时候调用此函数，并将函数返回的对象封装到其响应式系统中。此对象的任何顶层 property 都被代理到组件实例 (即方法和生命周期钩子中的 this) 上。

javascript

export default {
  data() {
    return {
      count: 1
    }
  },

  // `mounted` 是生命周期钩子，之后我们会讲到
  mounted() {
    // `this` 指向当前组件实例
    console.log(this.count) // => 1

    // 数据属性也可以被更改
    this.count = 2
  }
}

在演练场中尝试一下

这些实例上的 property 仅在实例首次创建时被添加，因此你需要确保它们都出现在 data 函数返回的对象上。若所需的值还未准备好，在必要时也可以使用 null、undefined 或者其他一些值占位。

也可以不在 data 上定义，直接向组件实例添加新属性。但这个属性将无法触发响应式更新。

Vue 在组件实例上暴露的内置 API 使用 $ 作为前缀。它同时也为内部 property 保留 _ 前缀。你应该避免在顶层 data 上使用任何以这些字符作前缀的 property。

响应式代理 vs. 原始值 * reactive-proxy-vs-original

在 Vue 3 中，数据是基于 JavaScript Proxy（代理）实现响应式的。使用过 Vue 2 的用户可能需要注意下面这样的边界情况：

javascript

export default {
  data() {
    return {
      someObject: {}
    }
  },
  mounted() {
    const newObject = {}
    this.someObject = newObject

    console.log(newObject === this.someObject) // false
  }
}

当你在赋值后再访问 this.someObject，此值已经是原来的 newObject 的一个响应式代理。这与 Vue 2 中原始的 newObject 不会变为响应式完全不同：请确保始终通过 this 来访问响应式状态。

我们可以使用 reactive() 函数创建一个响应式对象或数组：

javascript

import { reactive } from 'vue'

const state = reactive({ count: 0 })

响应式对象其实是 JavaScript Proxy，其行为表现与一般对象相似。不同之处在于 Vue 能够跟踪对响应式对象 property 的访问与更改操作。如果你对这其中的细节感到好奇，我们在深入响应式系统一章中会进行解释，但我们推荐你先读完这里的主要指南。

你也可以看看：为响应式对象标注类型

要在组件模板中使用响应式状态，请在 setup() 函数中定义并返回。

javascript

import { reactive } from 'vue'

export default {
  // `setup` 是一个专门用于组合式 API 的特殊钩子
  setup() {
    const state = reactive({ count: 0 })

    // 暴露 state 到模板
    return {
      state
    }
  }
}

vue

<div>{{ state.count }}</div>

相似地，我们也可以在这个作用域下定义可更改响应式 state 的函数，并作为一个方法与 state 一起暴露出去：

javascript

import { reactive } from 'vue'

export default {
  setup() {
    const state = reactive({ count: 0 })

    function increment() {
      state.count++
    }

    // 不要忘记同时暴露 increment 函数
    return {
      state,
      increment
    }
  }
}

暴露的方法通常会被用作事件监听器：

vue

<button @click="increment">
  {{ state.count }}
</button>

`<script setup>` **

在 setup() 函数中手动暴露状态和方法可能非常繁琐。幸运的是，你可以通过使用构建工具来简化该操作。当使用单文件组件（SFC）时，我们可以使用 <script setup> 来简化大量样板代码。

vue

<script setup>
import { reactive } from 'vue'

const state = reactive({ count: 0 })

function increment() {
  state.count++
}
</script>

<template>
  <button @click="increment">
    {{ state.count }}
  </button>
</template>

在演练场中尝试一下

<script setup> 中的顶层的导入和变量声明可在同一组件的模板中自动使用。

在指南的后续章节中，我们基本上都会在组合式 API 示例中使用单文件组件 + <script setup> 的语法，因为大多数 Vue 开发者都会这样使用。

声明方法 * declaring-methods

在 Vue School 上观看免费课程

要为组件添加方法，我们需要用到 methods 选项。它应该是一个包含所有方法的对象：

javascript

export default {
  data() {
    return {
      count: 0
    }
  },
  methods: {
    increment() {
      this.count++
    }
  },
  mounted() {
    // 在其他方法或是生命周期中也可以调用方法
    this.increment()
  }
}

Vue 自动为 methods 中的方法绑定了永远指向组件实例的 this。这确保了方法在作为事件监听器或回调函数时始终保持正确的 this。你不应该在定义 methods 时使用箭头函数，因为这会阻止 Vue 的自动绑定。

javascript

export default {
  methods: {
    increment: () => {
      // 反例：无法访问此处的 `this`!
    }
  }
}

和组件实例上的其他 property 一样，方法也可以在模板上被访问。在模板中它们常常被用作事件监听器：

vue

<button @click="increment">{{ count }}</button>

在演练场中尝试一下

在上面的例子中，increment 方法会在 <button> 被点击时调用。

DOM 更新时机 dom-update-timing

当你更改响应式状态后，DOM 也会自动更新。然而，你得注意 DOM 的更新并不是同步的。相反，Vue 将缓冲它们直到更新周期的 “下个时机” 以确保无论你进行了多少次声明更改，每个组件都只需要更新一次。

若要等待一个状态改变后的 DOM 更新完成，你可以使用 nextTick() 这个全局 API：

javascript

import { nextTick } from 'vue'

function increment() {
  state.count++
  nextTick(() => {
    // 访问更新后的 DOM
  })
}

javascript

import { nextTick } from 'vue'

export default {
  methods: {
    increment() {
      this.count++
      nextTick(() => {
        // 访问更新后的 DOM
      })
    }
  }
}

深层响应性 deep-reactivity

在 Vue 中，状态都是默认深层响应式的。这意味着即使在更改深层次的对象或数组，你的改动也能被检测到。

javascript

export default {
  data() {
    return {
      obj: {
        nested: { count: 0 },
        arr: ['foo', 'bar']
      }
    }
  },
  methods: {
    mutateDeeply() {
      // 以下都会按照期望工作
      this.obj.nested.count++
      this.obj.arr.push('baz')
    }
  }
}

javascript

import { reactive } from 'vue'

const obj = reactive({
  nested: { count: 0 },
  arr: ['foo', 'bar']
})

function mutateDeeply() {
  // 以下都会按照期望工作
  obj.nested.count++
  obj.arr.push('baz')
}

你也可以直接创建一个浅层响应式对象。它们仅在顶层具有响应性，一般仅在某些特殊场景中需要。

响应式代理 vs. 原始对象 ** reactive-proxy-vs-original-1

值得注意的是，reactive() 返回的是一个原始对象的 Proxy，它和原始对象是不相等的：

javascript

const raw = {}
const proxy = reactive(raw)

// 代理和原始对象不是全等的
console.log(proxy === raw) // false

只有代理是响应式的，更改原始对象不会触发更新。因此，使用 Vue 的响应式系统的最佳实践是 仅使用你声明对象的代理版本。

为保证访问代理的一致性，对同一个对象调用 reactive() 会总是返回同样的代理，而对一个已存在代理调用 reactive() 也是返回同样的代理：

javascript

// 在同一个对象上调用 reactive() 会返回相同的代理
console.log(reactive(raw) === proxy) // true

// 在一个代理上调用 reactive() 会返回它自己
console.log(reactive(proxy) === proxy) // true

这个规则对嵌套对象也适用。依靠深层响应性，响应式对象内的嵌套对象依然是代理：

javascript

const proxy = reactive({})

const raw = {}
proxy.nested = raw

console.log(proxy.nested === raw) // false

`reactive()` 的局限性 ** limitations-of-reactive

reactive() API 有两条限制：

仅对对象类型有效（对象、数组和 Map、Set 这样的集合类型），而对 string、number 和 boolean 这样的原始类型无效。
因为 Vue 的响应式系统是通过 property 访问进行追踪的，因此我们必须始终保持对该响应式对象的相同引用。这意味着我们不可以随意地“替换”一个响应式对象，因为这将导致对初始引用的响应性连接丢失：

javascript

  let state = reactive({ count: 0 })

  // 上面的引用 ({ count: 0 }) 将不再被追踪（响应性连接已丢失！）
  state = reactive({ count: 1 })

同时这也意味着当我们将响应式对象的 property 赋值或解构至本地变量时，或是将该 property 传入一个函数时，我们会失去响应性：

javascript

  const state = reactive({ count: 0 })

  // n 是一个局部变量，同 state.count
  // 失去响应性连接
  let n = state.count
  // 不影响原始的 state
  n++

  // count 也和 state.count 失去了响应性连接
  let { count } = state
  // 不会影响原始的 state
  count++

  // 该函数接收一个普通数字，并且
  // 将无法跟踪 state.count 的变化
  callSomeFunction(state.count)

`ref()` 定义响应式变量 ** reactive-variables-with-ref

为了解决 reactive() 带来的限制，Vue 也提供了一个 ref() 方法来允许我们创建可以使用任何值类型的响应式 ref：

javascript

import { ref } from 'vue'

const count = ref(0)

ref() 从参数中获取到值，将其包装为一个带 .value property 的 ref 对象：

javascript

const count = ref(0)

console.log(count) // { value: 0 }
console.log(count.value) // 0

count.value++
console.log(count.value) // 1

你也可以看看：为 ref 标注类型

和响应式对象的 property 类似，ref 的 .value property 也是响应式的。同时，当值为对象类型时，会用 reactive() 自动转换它的 .value。

一个包含对象类型值的 ref 可以响应式地替换整个对象：

javascript

const objectRef = ref({ count: 0 })

// 这是响应式的替换
objectRef.value = { count: 1 }

ref 被传递给函数或是从一般对象上被解构时，不会丢失响应性：

javascript

const obj = {
  foo: ref(1),
  bar: ref(2)
}

// 该函数接收一个 ref
// 需要通过 .value 取值
// 但它会保持响应性
callSomeFunction(obj.foo)

// 仍然是响应式的
const { foo, bar } = obj

一言以蔽之，ref() 使我们能创造一种任意值的 “引用” 并能够不丢失响应性地随意传递。这个功能非常重要，因为它经常用于将逻辑提取到组合函数中。

ref 在模板中的解包 ** ref-unwrapping-in-templates

当 ref 在模板中作为顶层 property 被访问时，它们会被自动“解包”，所以不需要使用 .value。下面是之前的计数器例子，用 ref() 代替：

vue

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

const count = ref(0)

function increment() {
  count.value++
}
</script>

<template>
  <button @click="increment">
    {{ count }} <!-- 无需 .value -->
  </button>
</template>

在演练场中尝试一下

请注意，仅当 ref 是模板渲染上下文的顶层 property 时才适用自动“解包”。例如， foo 是顶层 property，但 object.foo 不是。

所以我们给出以下 object：

javascript

const object = { foo: ref(1) }

下面的表达式将不会像预期的那样工作：

vue

{{ object.foo + 1 }}

渲染的结果会是一个 [object Object]，因为 object.foo 是一个 ref 对象。我们可以通过让 foo 成为顶级 property 来解决这个问题：

javascript

const { foo } = object

vue

{{ foo + 1 }}

现在渲染结果将是 2。

需要注意的是，如果一个 ref 是文本插值（即一个 {{ }} 符号）计算的最终值，它也将被解包。因此下面的渲染结果将为 1：

vue

{{ object.foo }}

这只是文本插值的一个方便功能，相当于 {{ object.foo.value }}。

ref 在响应式对象中的解包 ** ref-unwrapping-in-reactive-objects

当一个 ref 作为一个响应式对象的 property 被访问或更改时，它会自动解包，因此会表现得和一般的 property 一样：

javascript

const count = ref(0)
const state = reactive({
  count
})

console.log(state.count) // 0

state.count = 1
console.log(count.value) // 1

如果将一个新的 ref 赋值给一个关联了已有 ref 的 property，那么它会替换掉旧的 ref：

javascript

const otherCount = ref(2)

state.count = otherCount
console.log(state.count) // 2
// 原始 ref 现在已经和 state.count 失去联系
console.log(count.value) // 1

只有当嵌套在一个深层响应式对象内时，才会发生 ref 解包。当其作为浅层响应式对象的 property 被访问时不会解包。

数组和集合类型的 ref 解包 ref-unwrapping-in-arrays-and-collections

不像响应式对象，当 ref 作为响应式数组或像 Map 这种原生集合类型的元素被访问时，不会进行解包。

javascript

const books = reactive([ref('Vue 3 Guide')])
// 这里需要 .value
console.log(books[0].value)

const map = reactive(new Map([['count', ref(0)]]))
// 这里需要 .value
console.log(map.get('count').value)

有状态方法 * stateful-methods

在某些情况下，我们可能需要动态地创建一个方法函数，比如创建一个预置防抖的事件处理器：

javascript

import { debounce } from 'lodash-es'

export default {
  methods: {
    // 使用 Lodash 的防抖函数
    click: debounce(function () {
      // ... 对点击的响应 ...
    }, 500)
  }
}

不过这种方法对于被重用的组件来说是有问题的，因为这个预置防抖的函数是 有状态的：它在运行时维护着一个内部状态。如果多个组件实例都共享这同一个预置防抖的函数，那么它们之间将会互相影响。

要保持每个组件实例的防抖函数都彼此独立，我们可以改为在 created 生命周期钩子中创建这个预置防抖的函数：

javascript

export default {
  created() {
    // 每个实例都有了自己的预置防抖的处理函数
    this.debouncedClick = _.debounce(this.click, 500)
  },
  unmounted() {
    // 最好是在组件卸载时
    // 清除掉防抖计时器
    this.debouncedClick.cancel()
  },
  methods: {
    click() {
      // ... 对点击的响应 ...
    }
  }
}

响应性语法糖 ** reactivity-transform

不得不对 ref 使用 .value 是一个受限于 JavaScript 语言限制的缺点。然而，通过编译时转换，我们可以在适当的位置自动添加 .value 来提升开发体验。Vue 提供了一种编译时转换，使得可以像这样书写之前的“计数器”示例：

vue

<script setup>
let count = $ref(0)

function increment() {
  // 无需 .value
  count++
}
</script>

<template>
  <button @click="increment">{{ count }}</button>
</template>

你可以在响应性语法糖章节中了解更多细节。请注意它仍处于实验性阶段，在最终提案落地前仍可能发生改动。

响应式基础 reactivity-fundamentals #

声明响应式状态 declaring-reactive-state #

响应式代理 vs. 原始值 * reactive-proxy-vs-original #

<script setup> ** #

声明方法 * declaring-methods #

DOM 更新时机 dom-update-timing #

深层响应性 deep-reactivity #

响应式代理 vs. 原始对象 ** reactive-proxy-vs-original-1 #

reactive() 的局限性 ** limitations-of-reactive #

ref() 定义响应式变量 ** reactive-variables-with-ref #

ref 在模板中的解包 ** ref-unwrapping-in-templates #

ref 在响应式对象中的解包 ** ref-unwrapping-in-reactive-objects #

数组和集合类型的 ref 解包 ref-unwrapping-in-arrays-and-collections #

有状态方法 * stateful-methods #

响应性语法糖 ** reactivity-transform #

响应式基础 reactivity-fundamentals

声明响应式状态 declaring-reactive-state

响应式代理 vs. 原始值 * reactive-proxy-vs-original

`<script setup>` **

声明方法 * declaring-methods

DOM 更新时机 dom-update-timing

深层响应性 deep-reactivity

响应式代理 vs. 原始对象 ** reactive-proxy-vs-original-1

`reactive()` 的局限性 ** limitations-of-reactive

`ref()` 定义响应式变量 ** reactive-variables-with-ref

ref 在模板中的解包 ** ref-unwrapping-in-templates

ref 在响应式对象中的解包 ** ref-unwrapping-in-reactive-objects

数组和集合类型的 ref 解包 ref-unwrapping-in-arrays-and-collections

有状态方法 * stateful-methods

响应性语法糖 ** reactivity-transform