useAsyncData

useAsyncData 提供对在 SSR 友好型可组合函数中异步解析的数据的访问。

在你的页面、组件和插件中，你可以使用 useAsyncData 来访问异步解析的数据。

useAsyncData 是一个旨在直接在 Nuxt 上下文中调用的可组合函数。它返回响应式可组合函数，并处理将响应添加到 Nuxt 有效负载中，以便在页面水合时将它们从服务器传递到客户端，而无需在客户端重新获取数据。

使用

app/pages/index.vue

<script setup lang="ts">
const { data, status, pending, error, refresh, clear } = await useAsyncData(
  'mountains',
  (_nuxtApp, { signal }) => $fetch('https://api.nuxtjs.dev/mountains', { signal }),
)
</script>

如果你正在使用自定义的 useAsyncData 包装器，请不要在可组合函数中对其进行 await，因为这可能会导致意外行为。请遵循此教程以获取有关如何制作自定义异步数据获取器的更多信息。

data、status、pending 和 error 是 Vue 响应式引用，在 <script setup> 中使用时应通过 .value 访问，而 refresh/execute 和 clear 则是普通函数。

观察参数

内置的 watch 选项允许在检测到任何更改时自动重新运行 fetcher 函数。

app/pages/index.vue

<script setup lang="ts">
const page = ref(1)
const { data: posts } = await useAsyncData(
  'posts',
  (_nuxtApp, { signal }) => $fetch('https://fakeApi.com/posts', {
    params: {
      page: page.value,
    },
    signal,
  }), {
    watch: [page],
  },
)
</script>

响应式键

你可以使用计算引用、普通引用或 getter 函数作为键，从而实现动态数据获取，并在键更改时自动更新

app/pages/[id].vue

<script setup lang="ts">
const route = useRoute()
const userId = computed(() => `user-${route.params.id}`)

// When the route changes and userId updates, the data will be automatically refetched
const { data: user } = useAsyncData(
  userId,
  () => fetchUserById(route.params.id),
)
</script>

使你的 `handler` 可中止

你可以通过使用第二个参数中提供的 signal 来使你的 handler 函数可中止。这对于取消不再需要的请求很有用，例如当用户离开页面时。$fetch 原生支持中止信号。

const { data, error } = await useAsyncData(
  'users',
  (_nuxtApp, { signal }) => $fetch('/api/users', { signal }),
)

refresh() // will actually cancel the $fetch request (if dedupe: cancel)
refresh() // will actually cancel the $fetch request (if dedupe: cancel)
refresh()

clear() // will cancel the latest pending handler

你还可以将 AbortSignal 传递给 refresh/execute 函数以手动取消单个请求。

const { refresh } = await useAsyncData(
  'users',
  (_nuxtApp, { signal }) => $fetch('/api/users', { signal }),
)
let abortController: AbortController | undefined

function handleUserAction () {
  abortController = new AbortController()
  refresh({ signal: abortController.signal })
}

function handleCancel () {
  abortController?.abort() // aborts the ongoing refresh request
}

如果你的 handler 函数不支持中止信号，你可以使用提供的 signal 实现自己的中止逻辑。

const { data, error } = await useAsyncData(
  'users',
  (_nuxtApp, { signal }) => {
    return new Promise((resolve, reject) => {
      signal?.addEventListener('abort', () => {
        reject(new Error('Request aborted'))
      })
      return Promise.resolve(callback.call(this, yourHandler)).then(resolve, reject)
    })
  },
)

处理程序信号将在以下情况中止：

使用 dedupe: 'cancel' 发出新请求
调用 clear 函数
超出 options.timeout 时长

useAsyncData 是一个由编译器转换的保留函数名，因此你不应将自己的函数命名为 useAsyncData。

在文档 > 4 X > 入门 > 数据获取#useasyncdata 中阅读更多内容。

参数

key：一个唯一的键，用于确保数据获取可以在请求之间正确地进行去重。如果你不提供键，将为你生成一个对 useAsyncData 实例的文件名和行号唯一的键。
handler：一个异步函数，必须返回一个真值（例如，它不应该是 undefined 或 null），否则请求可能会在客户端重复。
handler 函数应是无副作用的，以确保 SSR 和 CSR 水合过程中的可预测行为。如果你需要触发副作用，请使用 callOnce 工具来执行此操作。
options:
- server：是否在服务器上获取数据（默认为 true）
- lazy：是否在加载路由后解析异步函数，而不是阻塞客户端导航（默认为 false）
- immediate：设置为 false 时，将阻止请求立即触发。（默认为 true）
- default：一个工厂函数，用于在异步函数解析之前设置 data 的默认值 - 与 lazy: true 或 immediate: false 选项结合使用时很有用
- transform：一个函数，可用于在解析后更改 handler 函数的结果
- getCachedData：提供一个返回缓存数据的函数。null 或 undefined 的返回值将触发一次获取。默认情况下，这是
```
const getDefaultCachedData = (key, nuxtApp, ctx) => nuxtApp.isHydrating
  ? nuxtApp.payload.data[key]
  : nuxtApp.static.data[key]
```
  这仅在 nuxt.config 的 experimental.payloadExtraction 启用时才缓存数据。
- pick：仅从 handler 函数结果中选择此数组中指定的键
- watch：观察响应式源以自动刷新
- deep：以深层响应式对象返回数据。默认为 false 以浅层响应式对象返回数据，如果你的数据不需要深层响应，这可以提高性能。
- dedupe：避免一次获取同一键多次（默认为 cancel）。可能的选项：
  - cancel - 当发出新请求时取消现有请求
  - defer - 如果存在挂起请求，则根本不发出新请求
- timeout - 一个以毫秒为单位的数字，表示请求超时前的等待时间（默认为 undefined，表示没有超时）

在底层，lazy: false 使用 <Suspense> 在数据获取完成之前阻塞路由的加载。考虑使用 lazy: true 并实现加载状态，以获得更快的用户体验。

你可以使用 useLazyAsyncData 来获得与 useAsyncData 配合 lazy: true 相同的行为。

共享状态和选项一致性

当多个 useAsyncData 调用使用相同的键时，它们将共享相同的 data、error、status 和 pending 引用。这确保了组件之间的一致性，但需要选项一致性。

以下选项在所有使用相同键的调用中必须保持一致

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

以下选项可以不同而不会触发警告

服务器
lazy
immediate
dedupe
watch

// ❌ This will trigger a development warning
const { data: users1 } = useAsyncData('users', (_nuxtApp, { signal }) => $fetch('/api/users', { signal }), { deep: false })
const { data: users2 } = useAsyncData('users', (_nuxtApp, { signal }) => $fetch('/api/users', { signal }), { deep: true })

// ✅ This is allowed
const { data: users1 } = useAsyncData('users', (_nuxtApp, { signal }) => $fetch('/api/users', { signal }), { immediate: true })
const { data: users2 } = useAsyncData('users', (_nuxtApp, { signal }) => $fetch('/api/users', { signal }), { immediate: false })

使用 useAsyncData 创建的带键状态可以使用 useNuxtData 在你的 Nuxt 应用程序中检索。

返回值

data：传入的异步函数的结果。
refresh/execute：一个可用于刷新由 handler 函数返回的数据的函数。
error：如果数据获取失败，则为错误对象。
status：一个字符串，指示数据请求的状态
- idle：当请求尚未开始时，例如
  - 当 execute 尚未调用且设置了 { immediate: false } 时
  - 当在服务器上渲染 HTML 且设置了 { server: false } 时
- pending：请求正在进行中
- success：请求已成功完成
- error：请求失败
pending：一个 Ref<boolean>，当请求正在进行时（即 status.value === 'pending' 时）为 true。
clear：一个函数，可用于将 data 设置为 undefined（或 options.default() 的值，如果提供），将 error 设置为 undefined，将 status 设置为 idle，并标记任何当前挂起的请求为已取消。

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

如果你尚未在服务器上获取数据（例如，使用 server: false），那么在水合完成之前不会获取数据。这意味着即使你在客户端 await useAsyncData，data 在 <script setup> 中仍将保持 undefined。

类型

签名

export type AsyncDataHandler<ResT> = (nuxtApp: NuxtApp, options: { signal: AbortSignal }) => Promise<ResT>

export function useAsyncData<DataT, DataE> (
  handler: AsyncDataHandler<DataT>,
  options?: AsyncDataOptions<DataT>
): AsyncData<DataT, DataE>
export function useAsyncData<DataT, DataE> (
  key: MaybeRefOrGetter<string>,
  handler: AsyncDataHandler<DataT>,
  options?: AsyncDataOptions<DataT>
): Promise<AsyncData<DataT, DataE>>

type AsyncDataOptions<DataT> = {
  server?: boolean
  lazy?: boolean
  immediate?: boolean
  deep?: boolean
  dedupe?: 'cancel' | 'defer'
  default?: () => DataT | Ref<DataT> | null
  transform?: (input: DataT) => DataT | Promise<DataT>
  pick?: string[]
  watch?: MultiWatchSources | false
  getCachedData?: (key: string, nuxtApp: NuxtApp, ctx: AsyncDataRequestContext) => DataT | undefined
  timeout?: number
}

type AsyncDataRequestContext = {
  /** The reason for this data request */
  cause: 'initial' | 'refresh:manual' | 'refresh:hook' | 'watch'
}

type AsyncData<DataT, ErrorT> = {
  data: Ref<DataT | undefined>
  refresh: (opts?: AsyncDataExecuteOptions) => Promise<void>
  execute: (opts?: AsyncDataExecuteOptions) => Promise<void>
  clear: () => void
  error: Ref<ErrorT | undefined>
  status: Ref<AsyncDataRequestStatus>
  pending: Ref<boolean>
}

interface AsyncDataExecuteOptions {
  dedupe?: 'cancel' | 'defer'
  timeout?: number
  signal?: AbortSignal
}

type AsyncDataRequestStatus = 'idle' | 'pending' | 'success' | 'error'

在文档 > 4 X > 入门 > 数据获取中阅读更多信息。

这有帮助吗？

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

useAppConfig

访问项目中定义的响应式应用配置。

useCookie

useCookie 是一个 SSR 友好的可组合函数，用于读取和写入 cookie。