数据获取

Nuxt 提供了组合式API来处理应用中的数据获取。

Nuxt 内置了两个组合式API和一个库，用于在浏览器或服务器环境中执行数据获取：useFetch、useAsyncData 和 $fetch。

简而言之：

$fetch 是发起网络请求的最简单方式。
useFetch 是 $fetch 的封装，在通用渲染中只会获取数据一次。
useAsyncData 与 useFetch 类似，但提供更精细的控制。

useFetch 和 useAsyncData 共享一组通用选项和模式，我们将在最后几节详细介绍。

为什么需要 `useFetch` 和 `useAsyncData`

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

useFetch 和 useAsyncData 组合式API通过确保如果在服务器上发起了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 == undefined">
    无数据
  </div>
  <div v-else>
    <form @submit="handleFormSubmit">
      <!-- 表单输入标签 -->
    </form>
  </div>
</template>

在上面的示例中，useFetch 会确保请求在服务器上发生，并正确转发到浏览器。$fetch 没有这种机制，更适合仅从浏览器发起请求的场景。

Suspense

Nuxt 在底层使用 Vue 的 <Suspense> 组件，以防止在所有异步数据可用于视图之前进行导航。数据获取组合式API可以帮助你利用此功能，并在每次调用时使用最适合的方式。

你可以添加 <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 不会提供网络请求去重和导航阻止。
建议在客户端交互（基于事件）时使用 $fetch，或者在获取初始组件数据时与 useAsyncData 结合使用。

了解更多关于 $fetch 的信息。

将客户端标头传递到API

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

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

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

或者，下面的示例展示了如何使用 useRequestHeaders 从服务器端请求（源自客户端）访问Cookie并将其发送到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 组合式API在底层使用 $fetch，用于在 setup 函数中发起SSR安全的网络请求。

app.vue

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

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

这个组合式API是 useAsyncData 组合式API和 $fetch 工具的封装。

阅读更多 Docs > API > Composables > Use Fetch.

阅读并编辑实时示例中的内容 Docs > Examples > Features > Data Fetching.

`useAsyncData`

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

useFetch(url) 几乎等同于 useAsyncData(url, () => event.$fetch(url))。
这是最常见用例的开发体验优化。（你可以在 useRequestFetch 中了解更多关于 event.fetch 的信息。）

在某些情况下，使用 useFetch 组合式API并不合适，例如当CMS或第三方提供自己的查询层时。在这种情况下，你可以使用 useAsyncData 来包装你的调用，同时仍然保留该组合式API提供的优势。

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 的文件和行，因此建议始终创建自己的键以避免不必要的行为，例如当你创建自己的自定义组合式API来包装 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 组合式API是包装并等待多个 $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 actions），因为这可能导致意外行为，例如使用空值重复执行。如果你需要触发副作用，请使用 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（或如果提供了 options.default() 则设置为其值）、将 error 设置为 undefined、将 status 设置为 idle 并将任何当前挂起的请求标记为已取消的函数。
error：数据获取失败时的错误对象。
status：表示数据请求状态的字符串（"idle"、"pending"、"success"、"error"）。

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

默认情况下，Nuxt 会等待 refresh 完成后才允许再次执行。

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

选项

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

延迟加载（Lazy）

默认情况下，数据获取组合式API会通过使用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 的信息。

仅客户端获取

默认情况下，数据获取组合式API将在客户端和服务器环境中执行其异步函数。将 server 选项设置为 false 以仅在客户端执行调用。在初始加载时，数据将不会在激活前获取。这意味着即使你在客户端等待 useFetch，在 <script setup> 中 data 仍将保持为 null。结合 lazy 选项，这对于不需要在首次渲染时获取的数据（例如，非SEO敏感数据）非常有用。

/* 此调用在激活前执行 */
const articles = await useFetch('/api/article')

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

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

最小化有效载荷大小

pick 选项帮助你通过只选择需要从组合式API返回的字段来最小化存储在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 都不能阻止最初获取不需要的数据。但它们会阻止不需要的数据被添加到从服务器传输到客户端的有效载荷中。

缓存和重新获取

键（Keys）

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

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

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

共享状态和选项一致性

当多个组件使用相同的键调用 useAsyncData 或 useFetch 时，它们将共享相同的 data、error 和 status ref。这确保了组件之间的一致性，但需要某些选项保持一致。以下选项必须在所有使用相同键的调用中保持一致：

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

响应式键（Reactive Keys）

你可以使用计算属性ref、普通ref或 getter 函数作为键，允许动态数据获取，当依赖项更改时自动更新：

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

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

刷新和执行（Refresh and execute）

如果你想手动获取或刷新数据，请使用组合式API提供的 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。

清除（Clear）

如果你出于任何原因想要清除提供的数据，而不需要知道传递给 clearNuxtData 的特定键，可以使用组合式API提供的 clear 函数。

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

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

监听（Watch）

要在应用程序中的其他响应式值更改时重新运行你的获取函数，请使用 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（Computed URL）

有时你可能需要从响应式值计算URL，并在这些值更改时刷新数据。你不必为此费心，只需将每个参数作为响应式值附加。Nuxt 将自动使用响应式值，并在每次更改时重新获取。

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

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

在更复杂的URL构造情况下，你可以使用作为计算getter的回调函数，返回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>
    <!--  fetching 时禁用输入 -->
    <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>

如果你需要在其他响应式值更改时强制刷新，你也可以监听其他值。

非立即执行（Not immediate）

useFetch 组合式API会在调用时立即开始获取数据。你可以通过设置 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：当获取成功完成时

传递标头和Cookie

当我们在浏览器中调用 $fetch 时，用户标头（如 cookie）将直接发送到API。通常，在服务器端渲染期间，出于安全考虑，$fetch 不会包含用户的浏览器Cookie，也不会传递来自fetch响应的Cookie。然而，当在服务器上调用 useFetch 并使用相对URL时，Nuxt 将使用 useRequestFetch 来代理标头和Cookie（除了不打算转发的标头，如 host）。

在SSR响应中从服务器端API调用传递Cookie

如果你想在另一个方向传递/代理Cookie，从内部请求回到客户端，你需要自己处理。

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)
  /* 从响应中获取Cookie */
  const cookies = res.headers.getSetCookie()
  /* 将每个Cookie附加到我们传入的请求 */
  for (const cookie of cookies) {
    appendResponseHeader(event, 'set-cookie', cookie)
  }
  /* 返回响应的数据 */
  return res._data
}

<script setup lang="ts">
// 这个组合式API将自动将Cookie传递给客户端
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组件的推荐方式。

阅读更多 Docs > API > Utils > Define Nuxt Component.

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

当使用 useAsyncData 和 useLazyAsyncData 将在服务器上获取的数据传输到客户端时（以及任何其他利用Nuxt有效载荷的内容），有效载荷使用 devalue 进行序列化。这允许我们不仅传输基本JSON，还可以序列化和恢复/反序列化更高级的数据类型，如正则表达式、日期、Map和Set、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">
// `data` 的类型被推断为 string，尽管我们返回了一个Date对象
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 组合式API useEventSource。

通过POST请求消费SSE时，你需要手动处理连接。以下是实现方法：

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

// 使用 TextDecoderStream 从响应创建新的 ReadableStream，以文本形式获取数据
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]);

Was this helpful?

Report an issue or Edit this page on GitHub

过渡

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

状态管理

Nuxt 提供强大的状态管理库和 useState 组合式函数，用于创建响应式且支持 SSR 的共享状态。