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

用法

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

监视参数

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

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

响应式键

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

const route = useRoute()
const userId = computed(() => `user-${route.params.id}`)

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

参数

• key：一个唯一的键，以确保数据获取可以在请求之间正确去重。如果你没有提供键，那么将为你生成一个唯一的键，该键与 useAsyncData 实例的文件名和行号相关。
• handler：一个异步函数，必须返回一个真值（例如，不应为 undefined 或 null），否则请求可能会在客户端重复。

• 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：在深度 ref 对象中返回数据（默认值为 true）。可以设置为 false 以在浅 ref 对象中返回数据，如果你的数据不需要深度响应性，这可以提高性能。
  • dedupe：避免同时多次获取相同的键（默认为 cancel）。可能的选项：
    • cancel - 当发起新请求时取消现有请求
    • defer - 如果有挂起的请求，则根本不发起新请求

共享状态和选项一致性

当为多个 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（或如果提供了 options.default() 的值），将 error 设置为 null，将 status 设置为 idle，并将任何当前挂起的请求标记为已取消的函数。

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

类型

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'