数据获取

Nuxt 提供了组合函数来处理应用程序中的数据获取。

Nuxt 附带两个组合函数和一个内置库，以在浏览器或服务器环境中执行数据获取：useFetch、useAsyncData 和 $fetch。

简而言之：

$fetch 是进行网络请求的最简单方法。
useFetch 是对 $fetch 的包装，它仅在通用渲染中获取一次数据。
useAsyncData 类似于 useFetch，但提供了更细粒度的控制。

useFetch 和 useAsyncData 都共享一组通用选项和模式，我们将在最后的部分详细说明。

`useFetch` 和 `useAsyncData` 的需求

Nuxt 是一个框架，可以在服务器和客户端环境中运行同构（或通用）代码。如果在 Vue 组件的设置函数中使用 $fetch 函数来执行数据获取，这可能会导致数据被获取两次，一次在服务器上（以渲染 HTML），另一次在客户端（当 HTML 被水合时）。这可能导致水合问题，增加交互时间，并导致不可预测的行为。

useFetch 和 useAsyncData 组合函数通过确保如果在服务器上进行了 API 调用，数据将作为有效负载转发到客户端，解决了此问题。

有效负载是一个通过 useNuxtApp().payload 访问的 JavaScript 对象。它在客户端上使用，以避免在代码在浏览器中执行时重新获取相同的数据在水合期间。

使用 Nuxt DevTools 在 Payload 选项卡 中检查此数据。

app.vue

<script setup lang="ts">
const { data } = await useFetch('/api/data')

async function handleFormSubmit() {
  const res = await $fetch('/api/submit', {
    method: 'POST',
    body: {
      // 我的表单数据
    }
  })
}
</script>

<template>
  <div v-if="data == null">
    没有数据
  </div>
  <div v-else>
    <form @submit="handleFormSubmit">
      <!-- 表单输入标签 -->
    </form>
  </div>
</template>

在上面的示例中，useFetch 将确保请求发生在服务器上并正确转发到浏览器。$fetch 没有这样的机制，因而在仅从浏览器发出的请求时更为合适。

暂停

Nuxt 在内部使用 Vue 的 <Suspense> 组件，以防止在所有异步数据可用于视图之前进行导航。数据获取组合函数可以帮助您利用此功能，并根据每个调用选择最适合的内容。

您可以添加 <NuxtLoadingIndicator> 在页面导航之间添加进度条。

`$fetch`

Nuxt 包含 ofetch 库，并且在整个应用程序中自动作为 $fetch 别名导入。

pages/todos.vue

<script setup lang="ts">
async function addTodo() {
  const todo = await $fetch('/api/todos', {
    method: 'POST',
    body: {
      // 我的待办事项数据
    }
  })
}
</script>

请注意，仅使用 $fetch 将无法提供网络调用去重和导航预防。:br 建议在客户端交互（基于事件）中使用 $fetch，或者在获取初始组件数据时与 useAsyncData 结合使用。

阅读更多关于 $fetch 的信息。

将客户端头传递给 API

在服务器上调用 useFetch 时，Nuxt 将使用 useRequestFetch 来代理客户端头和 cookies（除了不打算转发的头，如 host）。

<script setup lang="ts">
const { data } = await useFetch('/api/echo');
</script>

// /api/echo.ts
export default defineEventHandler(event => parseCookies(event))

或者，下面的示例展示了如何使用 useRequestHeaders 从服务器请求访问和传送 cookies 给 API（从客户端发起）。通过使用同构的 $fetch 调用，我们确保 API 端点可以访问用户浏览器最初发送的相同的 cookie 头。如果您不使用 useFetch，则此操作是必要的。

<script setup lang="ts">
const headers = useRequestHeaders(['cookie'])

async function getCurrentUser() {
  return await $fetch('/api/me', { headers })
}
</script>

您还可以使用 useRequestFetch 自动代理头到该调用。

在将头代理到外部 API 之前，请非常小心，只包含您需要的头。并非所有头都适合被绕过，可能会引入不必要的行为。以下是一些不应被代理的常见头：

host, accept
content-length, content-md5, content-type
x-forwarded-host, x-forwarded-port, x-forwarded-proto
cf-connecting-ip, cf-ray

`useFetch`

useFetch 组合函数在内部使用 $fetch 在设置函数中进行 SSR 安全的网络调用。

app.vue

<script setup lang="ts">
const { data: count } = await useFetch('/api/count')
</script>

<template>
  <p>页面访问：{{ count }}</p>
</template>

该组合函数是 useAsyncData 组合函数和 $fetch 工具的包装器。

Read more in Docs > API > Composables > Use Fetch.

Read and edit a live example in Docs > Examples > Features > Data Fetching.

`useAsyncData`

useAsyncData 组合函数负责包装异步逻辑并在解析后返回结果。

useFetch(url) 几乎等同于 useAsyncData(url, () => event.$fetch(url))。:br 这是对最常见用例的开发者体验糖。（您可以在 useRequestFetch 中找到有关 event.fetch 的更多信息。）

有一些情况下，使用 useFetch 组合函数是不合适的，例如当 CMS 或第三方提供自己的查询层时。在这种情况下，您可以使用 useAsyncData 来包装您的调用，并仍然保留组合函数提供的好处。

pages/users.vue

<script setup lang="ts">
const { data, error } = await useAsyncData('users', () => myGetFunction('users'))

// 这也是可能的：
const { data, error } = await useAsyncData(() => myGetFunction('users'))
</script>

useAsyncData 的第一个参数是用于缓存第二个参数查询函数响应的唯一键。如果直接传递查询函数，则可以忽略此键，键将被自动生成。

由于自动生成的键仅考虑调用 useAsyncData 的文件和行，因此建议始终创建自己的键，避免不必要的行为，例如在创建自定义组合函数包装 useAsyncData 时。

设置键可以方便在使用 useNuxtData 的组件之间共享相同的数据或刷新特定数据。

pages/users/[id].vue

<script setup lang="ts">
const { id } = useRoute().params

const { data, error } = await useAsyncData(`user:${id}`, () => {
  return myGetFunction('users', { id })
})
</script>

useAsyncData 组合函数是一个很好的方法，用于包装和等待多个 $fetch 请求的完成，并处理结果。

<script setup lang="ts">
const { data: discounts, status } = await useAsyncData('cart-discount', async () => {
  const [coupons, offers] = await Promise.all([
    $fetch('/cart/coupons'),
    $fetch('/cart/offers')
  ])

  return { coupons, offers }
})
// discounts.value.coupons
// discounts.value.offers
</script>

useAsyncData 是用于获取和缓存数据，而不是触发副作用，例如调用 Pinia 操作，因为这可能导致意外行为，例如与 null 值重复执行。如果您需要触发副作用，请使用 callOnce 工具来执行。

<script setup lang="ts">
const offersStore = useOffersStore()

// 你不能这样做
await useAsyncData(() => offersStore.getOffer(route.params.slug))
</script>

阅读更多关于 useAsyncData 的信息。

返回值

useFetch 和 useAsyncData 具有以下相同的返回值。

data：传递的异步函数的结果。
refresh/execute：可用于刷新 handler 函数返回的数据的函数。
clear：可用于将 data 设置为 undefined、将 error 设置为 null、将 status 设置为 idle，并标记任何当前挂起的请求为已取消的函数。
error：如果数据获取失败，则为错误对象。
status：指示数据请求状态的字符串（"idle"、"pending"、"success"、"error"）。

data、error 和 status 是 Vue refs，可在 <script setup> 中通过 .value 访问

默认情况下，Nuxt 在 refresh 完成之前会等待其再次执行。

如果您没有在服务器上获取数据（例如，使用 server: false），则数据 将不会 在水合完成之前被获取。这意味着，即使您在客户端等待 useFetch，data 在 <script setup> 中仍将保持为 null。

选项

useAsyncData 和 useFetch 返回相同的对象类型，并接受一组通用选项作为最后一个参数。它们可以帮助您控制组合函数行为，例如导航阻塞、缓存或执行。

懒加载

默认情况下，数据获取组合函数将等待其异步函数的解析，然后才导航到新页面，使用 Vue 的 Suspense。在客户端导航中可以通过 lazy 选项忽略此功能。在这种情况下，您需要手动使用 status 值处理加载状态。

app.vue

<script setup lang="ts">
const { status, data: posts } = useFetch('/api/posts', {
  lazy: true
})
</script>

<template>
  <!-- 您需要处理加载状态 -->
  <div v-if="status === 'pending'">
    加载中 ...
  </div>
  <div v-else>
    <div v-for="post in posts">
      <!-- 做一些事情 -->
    </div>
  </div>
</template>

您可以选择使用 useLazyFetch 和 useLazyAsyncData 作为方便的方法来执行相同的操作。

<script setup lang="ts">
const { status, data: posts } = useLazyFetch('/api/posts')
</script>

阅读更多关于 useLazyFetch 的信息。

阅读更多关于 useLazyAsyncData 的信息。

仅限客户端的获取

默认情况下，数据获取组合函数将在客户端和服务器环境中执行其异步函数。将 server 选项设置为 false 仅在客户端执行调用。在初始加载时，数据将在水合完成之前不会被获取，因此您必须处理挂起状态，不过在随后的客户端导航中，数据将在加载页面之前被等待。

结合 lazy 选项，这对在第一次渲染时不需要的数据（例如，不敏感于 SEO 的数据）很有用。

/* 此调用在水合之前执行 */
const articles = await useFetch('/api/article')

/* 此调用仅在客户端执行 */
const { status, data: comments } = useFetch('/api/comments', {
  lazy: true,
  server: false
})

useFetch 组合函数旨在在设置方法中调用或直接在生命周期钩子的函数顶层调用，否则您应使用 $fetch 方法。

最小化有效负载大小

pick 选项可帮助您通过仅选择您希望从组合函数返回的字段来最小化存储在 HTML 文档中的有效负载大小。

<script setup lang="ts">
/* 仅选择在模板中使用的字段 */
const { data: mountain } = await useFetch('/api/mountains/everest', {
  pick: ['title', 'description']
})
</script>

<template>
  <h1>{{ mountain.title }}</h1>
  <p>{{ mountain.description }}</p>
</template>

如果您需要更多控制或对多个对象进行映射，您可以使用 transform 函数来更改查询的结果。

const { data: mountains } = await useFetch('/api/mountains', {
  transform: (mountains) => {
    return mountains.map(mountain => ({ title: mountain.title, description: mountain.description }))
  }
})

pick 和 transform 都不会防止在初始时获取不必要的数据。但它们将防止不必要的数据被添加到从服务器传输到客户端的有效负载中。

缓存和重新获取

键

useFetch 和 useAsyncData 使用键来防止重新获取相同的数据。

useFetch 使用提供的 URL 作为键。或者，可以在作为最后一个参数传递的 options 对象中提供 key 值。
useAsyncData 如果第一个参数是字符串，则使用其作为键。如果第一个参数是执行查询的处理函数，则将为您生成一个唯一的与 useAsyncData 的文件名和行号相对应的键。

要通过键获取缓存数据，可以使用 useNuxtData

共享状态和选项一致性

当多个组件使用相同的键调用 useAsyncData 或 useFetch 时，它们将共享相同的 data、error 和 status refs。这确保了组件之间的一致性，但要求某些选项保持一致。

以下选项 必须一致，才能够在相同键的所有调用中使用：

handler 函数
deep 选项
transform 函数
pick 数组
getCachedData 函数
default 值

// ❌ 这将触发开发警告
const { data: users1 } = useAsyncData('users', () => $fetch('/api/users'), { deep: false })
const { data: users2 } = useAsyncData('users', () => $fetch('/api/users'), { deep: true })

以下选项 可以安全不同，而不会触发警告：

server
lazy
immediate
dedupe
watch

// ✅ 这是允许的
const { data: users1 } = useAsyncData('users', () => $fetch('/api/users'), { immediate: true })
const { data: users2 } = useAsyncData('users', () => $fetch('/api/users'), { immediate: false })

如果您需要独立的实例，请使用不同的键：

// 这些是完全独立的实例
const { data: users1 } = useAsyncData('users-1', () => $fetch('/api/users'))
const { data: users2 } = useAsyncData('users-2', () => $fetch('/api/users'))

响应式键

您可以使用计算引用、普通引用或获取函数作为键，从而实现动态数据获取，当依赖项更改时自动更新：

// 使用计算属性作为键
const userId = ref('123')
const { data: user } = useAsyncData(
  computed(() => `user-${userId.value}`),
  () => fetchUser(userId.value)
)

// 当 userId 更改时，数据将被自动重新获取
// 如果没有其他组件使用旧数据，它将被清除
userId.value = '456'

刷新和执行

如果您想手动获取或刷新数据，请使用组合函数提供的 execute 或 refresh 函数。

<script setup lang="ts">
const { data, error, execute, refresh } = await useFetch('/api/users')
</script>

<template>
  <div>
    <p>{{ data }}</p>
    <button @click="() => refresh()">刷新数据</button>
  </div>
</template>

execute 函数是 refresh 的别名，工作方式完全相同，但在请求非立即的情况下更具语义。

要全局重新获取或使缓存数据失效，请参见 clearNuxtData 和 refreshNuxtData。

清除

如果您想清除提供的数据，无论出于什么原因，且不需要知道需要传递给 clearNuxtData 的特定键，可以使用组合函数提供的 clear 函数。

<script setup lang="ts">
const { data, clear } = await useFetch('/api/users')

const route = useRoute()
watch(() => route.path, (path) => {
  if (path === '/') clear()
})
</script>

监视

要在应用程序中的其他响应式值更改时重新运行获取函数，请使用 watch 选项。您可以将其用于一个或多个可监视元素。

<script setup lang="ts">
const id = ref(1)

const { data, error, refresh } = await useFetch('/api/users', {
  /* 更改 id 将触发重新获取 */
  watch: [id]
})
</script>

请注意，观察响应式值不会更改获取的 URL。例如，这将始终获取用户的相同初始 ID，因为 URL 是在函数调用时构造的。

<script setup lang="ts">
const id = ref(1)

const { data, error, refresh } = await useFetch(`/api/users/${id.value}`, {
  watch: [id]
})
</script>

如果您需要根据响应式值更改 URL，您可能希望使用计算 URL 来实现相同的目的。

计算 URL

有时您可能需要根据响应式值计算 URL，并在每次这些值更改时刷新数据。您可以将每个参数附加为响应式值。 Nuxt 将自动使用响应式值，并在每次发生更改时重新获取数据。

<script setup lang="ts">
const id = ref(null)

const { data, status } = useLazyFetch('/api/user', {
  query: {
    user_id: id
  }
})
</script>

在更复杂的 URL 构建情况下，您可以使用回调作为计算获取器，返回 URL 字符串。

每当依赖项更改时，将使用新构造的 URL 获取数据。将其与非立即结合使用，您可以等待响应式元素改变后再进行获取。

<script setup lang="ts">
const id = ref(null)

const { data, status } = useLazyFetch(() => `/api/users/${id.value}`, {
  immediate: false
})

const pending = computed(() => status.value === 'pending');
</script>

<template>
  <div>
    <!-- 在获取时禁用输入 -->
    <input v-model="id" type="number" :disabled="pending"/>

    <div v-if="status === 'idle'">
      输入一个用户 ID
    </div>

    <div v-else-if="pending">
      加载中 ...
    </div>

    <div v-else>
      {{ data }}
    </div>
  </div>
</template>

如果您需要在其他响应式值更改时强制刷新，也可以观察其他值。

非立即

useFetch 组合函数将从被调用时开始获取数据。您可以通过设置 immediate: false 来防止这种情况，例如，等待用户交互。

为此，您将需要同时处理 status 以处理获取生命周期，以及 execute 来启动数据获取。

<script setup lang="ts">
const { data, error, execute, status } = await useLazyFetch('/api/comments', {
  immediate: false
})
</script>

<template>
  <div v-if="status === 'idle'">
    <button @click="execute">获取数据</button>
  </div>

  <div v-else-if="status === 'pending'">
    正在加载评论...
  </div>

  <div v-else>
    {{ data }}
  </div>
</template>

对于更细粒度的控制，status 变量可以是：

idle 当获取尚未开始
pending 当获取已开始但尚未完成
error 当获取失败时
success 当获取成功完成时

传递头和 Cookies

当我们在浏览器中调用 $fetch 时，用户头（如 cookie）将直接发送到 API。

通常，在服务器端渲染期间，由于安全考虑，$fetch 不会包含用户浏览器的 cookies，也不会传递来自 fetch 响应的 cookies。

但是，当在服务器端以相对 URL 调用 useFetch 时，Nuxt 将使用 useRequestFetch 来代理头和 cookies（除了不打算转发的头，如 host）。

在 SSR 响应中通过服务器端 API 调用传递 cookies

如果您希望在请求返回客户端时在另一个方向上传递/代理 cookies，您需要自己处理。

composables/fetch.ts

import { appendResponseHeader } from 'h3'
import type { H3Event } from 'h3'

export const fetchWithCookie = async (event: H3Event, url: string) => {
  /* 从服务器端点获取响应 */
  const res = await $fetch.raw(url)
  /* 获取响应中的 cookies */
  const cookies = res.headers.getSetCookie()
  /* 将每个 cookie 附加到我们的传入请求 */
  for (const cookie of cookies) {
    appendResponseHeader(event, 'set-cookie', cookie)
  }
  /* 返回响应的数据 */
  return res._data
}

<script setup lang="ts">
// 此组合函数将自动将 cookies 传递给客户端
const event = useRequestEvent()

const { data: result } = await useAsyncData(() => fetchWithCookie(event!, '/api/with-cookie'))

onMounted(() => console.log(document.cookie))
</script>

选项 API 支持

Nuxt 提供了一种通过选项 API 执行 asyncData 获取的方法。您必须将组件定义包装在 defineNuxtComponent 中才能实现此操作。

<script>
export default defineNuxtComponent({
  /* 使用 fetchKey 选项提供唯一键 */
  fetchKey: 'hello',
  async asyncData () {
    return {
      hello: await $fetch('/api/hello')
    }
  }
})
</script>

使用 <script setup> 或 <script setup lang="ts"> 是在 Nuxt 中声明 Vue 组件的推荐方式。

Read more in Docs > API > Utils > Define Nuxt Component.

从服务器到客户端序列化数据

使用 useAsyncData 和 useLazyAsyncData 将从服务器获取的数据转移到客户端时（以及利用 Nuxt 有效负载的其他内容），有效负载通过 devalue 序列化。这使我们能够传输的不仅仅是基本 JSON，还可以序列化和恢复/反序列化更高级别的数据类型，如正则表达式、日期、映射和集合，ref、reactive、shallowRef、shallowReactive 和 NuxtError 等。

您还可以为 Nuxt 不支持的类型定义自己的序列化/反序列化程序。您可以在 useNuxtApp 文档中阅读更多内容。

请注意，这 不适用于 通过 $fetch 或 useFetch 获取的服务器路由传递的数据 - 请参阅下一部分以获取更多信息。

从 API 路由序列化数据

从 server 目录获取数据时，响应使用 JSON.stringify 进行序列化。然而，由于序列化仅限于 JavaScript 原始数据类型，Nuxt 尽其所能地将 $fetch 和 useFetch 的返回类型转换为实际值。

了解更多关于 JSON.stringify 的限制。

示例

server/api/foo.ts

export default defineEventHandler(() => {
  return new Date()
})

app.vue

<script setup lang="ts">
// 即使我们返回了一个 Date 对象，`data` 的类型也会被推断为 string
const { data } = await useFetch('/api/foo')
</script>

自定义序列化函数

要自定义序列化行为，您可以在返回的对象上定义一个 toJSON 函数。如果您定义了一个 toJSON 方法，Nuxt 将尊重该函数的返回类型，不会尝试转换类型。

server/api/bar.ts

export default defineEventHandler(() => {
  const data = {
    createdAt: new Date(),

    toJSON() {
      return {
        createdAt: {
          year: this.createdAt.getFullYear(),
          month: this.createdAt.getMonth(),
          day: this.createdAt.getDate(),
        },
      }
    },
  }
  return data
})

app.vue

<script setup lang="ts">
// `data` 的类型被推断为
// {
//   createdAt: {
//     year: number
//     month: number
//     day: number
//   }
// }
const { data } = await useFetch('/api/bar')
</script>

使用替代序列化程序

Nuxt 当前不支持 JSON.stringify 的替代序列化程序。然而，您可以将有效负载作为普通字符串返回，并利用 toJSON 方法来保持类型安全。

在下面的示例中，我们使用 superjson 作为我们的序列化程序。

server/api/superjson.ts

import superjson from 'superjson'

export default defineEventHandler(() => {
  const data = {
    createdAt: new Date(),

    // 解决类型转换问题
    toJSON() {
      return this
    }
  }

  // 使用 superjson 将输出序列化为字符串
  return superjson.stringify(data) as unknown as typeof data
})

app.vue

<script setup lang="ts">
import superjson from 'superjson'

// `date` 会被推断为 { createdAt: Date }，您可以安全地使用 Date 对象方法
const { data } = await useFetch('/api/superjson', {
  transform: (value) => {
    return superjson.parse(value as unknown as string)
  },
})
</script>

食谱

通过 POST 请求消费 SSE（服务器推送事件）

如果您通过 GET 请求消费 SSE，您可以使用 EventSource 或 VueUse 组合函数 useEventSource。

当通过 POST 请求消费 SSE 时，您需要手动处理连接。以下是如何执行此操作：

// 向 SSE 端点发出 POST 请求
const response = await $fetch<ReadableStream>('/chats/ask-ai', {
  method: 'POST',
  body: {
    query: "你好 AI，你好吗？",
  },
  responseType: 'stream',
})

// 从响应中创建一个新的 ReadableStream，使用 TextDecoderStream 将数据作为文本获取
const reader = response.pipeThrough(new TextDecoderStream()).getReader()

// 在接收到数据块时读取它
while (true) {
  const { value, done } = await reader.read()

  if (done)
    break

  console.log('接收:', value)
}

发起并行请求

当请求互不依赖时，您可以使用 Promise.all() 进行并行请求，以提高性能。

const { data } = await useAsyncData(() => {
  return Promise.all([
    $fetch("/api/comments/"), 
    $fetch("/api/author/12")
  ]);
});

const comments = computed(() => data.value?.[0]);
const author = computed(() => data.value?.[1]);

报告问题或者在 GitHub 上编辑此页面

过渡

使用 Vue 或原生浏览器视图过渡在页面和布局之间应用过渡效果。

状态管理

Nuxt 提供强大的状态管理库和 useState 组合函数，创建一个响应式且友好的 SSR 共享状态。

数据获取

观看 Alexander Lichter 的视频，避免错误使用 useFetch

观看 Alexander Lichter 的视频，更深入了解 useFetch 和 useAsyncData 之间的差异

观看 Vue School 关于阻塞与非阻塞（懒加载）请求的视频

观看 Vue School 关于最小化有效负载大小的视频

观看 Vue School 关于使用键选项缓存数据的视频

观看 Vue School 关于并行数据获取的视频