useAsyncData

useAsyncData 提供对异步解析数据的访问，适用于 SSR 友好的组合式 API。

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

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

使用方法

pages/index.vue

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

如果你使用自定义的 useAsyncData 封装，请不要在组合式 API 中使用 await，这可能导致意外行为。有关如何创建自定义异步数据获取器的更多信息，请遵循这个食谱。

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

监视参数

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

pages/index.vue

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

响应式键

你可以使用计算属性、普通引用或获取函数作为键，这样当键更改时可以自动更新数据获取：

pages/[id].vue

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

// 当路由变化且 userId 更新时，数据将自动重新获取
const { data: user } = useAsyncData(
  userId,
  () => fetchUserById(route.params.id)
)
</script>

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

Read more in Docs > Getting Started > Data Fetching#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 - 如果有待处理的请求，则不发起新的请求

在底层，lazy: false 使用 <Suspense> 在数据获取之前阻止路由加载。考虑使用 lazy: true 并实现加载状态以提供更灵敏的用户体验。

你可以使用 useLazyAsyncData 来实现与 useAsyncData 的 lazy: true 相同的行为。

共享状态和选项一致性

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

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

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

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

server
lazy
immediate
dedupe
watch

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

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

返回值

data: 传入的异步函数的结果。
refresh/execute: 一个可以用来刷新 handler 函数返回的数据的函数。
error: 如果数据获取失败，则为错误对象。
status: 一个字符串，指示数据请求的状态：
- idle: 当请求尚未开始，例如：
  - 当 execute 尚未被调用且 { immediate: false } 被设置时
  - 当在服务器上渲染 HTML 时且 { server: false } 被设置时
- pending: 请求正在进行中
- success: 请求已成功完成
- error: 请求失败
clear: 一个函数，该函数将 data 设置为 undefined，将 error 设置为 null，将 status 设置为 'idle'，并将任何当前待处理的请求标记为已取消。

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

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

类型

Signature

function useAsyncData<DataT, DataE>(
  handler: (nuxtApp?: NuxtApp) => Promise<DataT>,
  options?: AsyncDataOptions<DataT>
): AsyncData<DataT, DataE>
function useAsyncData<DataT, DataE>(
  key: string | Ref<string> | ComputedRef<string>,
  handler: (nuxtApp?: NuxtApp) => Promise<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?: WatchSource[] | false
  getCachedData?: (key: string, nuxtApp: NuxtApp, ctx: AsyncDataRequestContext) => DataT | undefined
}

type AsyncDataRequestContext = {
  /** 请求数据的原因 */
  cause: 'initial' | 'refresh:manual' | 'refresh:hook' | 'watch'
}

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

interface AsyncDataExecuteOptions {
  dedupe?: 'cancel' | 'defer'
}

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

Read more in Docs > Getting Started > Data Fetching.

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

useAppConfig

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

useCookie

useCookie 是一个支持 SSR 的组合式 API，用于读取和写入 cookies。