useFetch

使用 SSR 友好的组合式函数从 API 端点获取数据。

这个组合式函数为 useAsyncData 和 $fetch 提供了一个便捷的封装。它根据 URL 和 fetch 选项自动生成一个键，为基于服务器路由的请求 URL 提供类型提示，并推断 API 响应类型。

useFetch 是一个组合式函数，旨在直接在 setup 函数、插件或路由中间件中调用。它返回响应式组合式函数，并处理将响应添加到 Nuxt payload 中，以便在页面 hydration 时，数据可以从服务器传递到客户端，而无需在客户端重新获取。

使用

app/pages/modules.vue

<script setup lang="ts">
const { data, status, error, refresh, clear } = await useFetch('/api/modules', {
  pick: ['title'],
})
</script>

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

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

使用 query 选项，你可以将搜索参数添加到查询中。此选项扩展自unjs/ofetch并使用unjs/ufo来创建 URL。对象会自动字符串化。

const param1 = ref('value1')
const { data, status, error, refresh } = await useFetch('/api/modules', {
  query: { param1, param2: 'value2' },
})

上述示例的结果是 https://api.nuxt.com/modules?param1=value1&param2=value2。

你也可以使用拦截器:

const { data, status, error, refresh, clear } = await useFetch('/api/auth/login', {
  onRequest ({ request, options }) {
    // Set the request headers
    // note that this relies on ofetch >= 1.4.0 - you may need to refresh your lockfile
    options.headers.set('Authorization', '...')
  },
  onRequestError ({ request, options, error }) {
    // Handle the request errors
  },
  onResponse ({ request, response, options }) {
    // Process the response data
    localStorage.setItem('token', response._data.token)
  },
  onResponseError ({ request, response, options }) {
    // Handle the response errors
  },
})

响应式键和共享状态

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

app/pages/[id].vue

<script setup lang="ts">
const route = useRoute()
const id = computed(() => route.params.id)

// When the route changes and id updates, the data will be automatically refetched
const { data: post } = await useFetch(() => `/api/posts/${id.value}`)
</script>

当在多个组件中使用相同的 URL 和选项调用 useFetch 时，它们将共享相同的 data、error 和 status ref。这确保了组件之间的一致性。

使用 useFetch 创建的键控状态可以通过 useNuxtData 在整个 Nuxt 应用程序中检索。

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

如果你遇到从 useFetch 解构的 data 变量返回字符串而不是 JSON 解析对象的情况，请确保你的组件不包含诸如 import { useFetch } from '@vueuse/core 之类的导入语句。

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

响应式 Fetch 选项

Fetch 选项可以作为响应式提供，支持 computed、ref 和计算 getter。当响应式 fetch 选项更新时，它将触发使用更新后的解析响应式值重新获取。

const searchQuery = ref('initial')
const { data } = await useFetch('/api/search', {
  query: { q: searchQuery },
})
// triggers a refetch: /api/search?q=new%20search
searchQuery.value = 'new search'

如果需要，你可以使用 watch: false 禁用此行为

const searchQuery = ref('initial')
const { data } = await useFetch('/api/search', {
  query: { q: searchQuery },
  watch: false,
})
// does not trigger a refetch
searchQuery.value = 'new search'

类型

签名

export function useFetch<DataT, ErrorT> (
  url: string | Request | Ref<string | Request> | (() => string | Request),
  options?: UseFetchOptions<DataT>
): Promise<AsyncData<DataT, ErrorT>>

type UseFetchOptions<DataT> = {
  key?: MaybeRefOrGetter<string>
  method?: MaybeRefOrGetter<string>
  query?: MaybeRefOrGetter<SearchParams>
  params?: MaybeRefOrGetter<SearchParams>
  body?: MaybeRefOrGetter<RequestInit['body'] | Record<string, any>>
  headers?: MaybeRefOrGetter<Record<string, string> | [key: string, value: string][] | Headers>
  baseURL?: MaybeRefOrGetter<string>
  server?: boolean
  lazy?: boolean
  immediate?: boolean
  getCachedData?: (key: string, nuxtApp: NuxtApp, ctx: AsyncDataRequestContext) => DataT | undefined
  deep?: boolean
  dedupe?: 'cancel' | 'defer'
  timeout?: number
  default?: () => DataT
  transform?: (input: DataT) => DataT | Promise<DataT>
  pick?: string[]
  $fetch?: typeof globalThis.$fetch
  watch?: MultiWatchSources | false
  timeout?: MaybeRefOrGetter<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>
}

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

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

参数

URL (string | Request | Ref<string | Request> | () => string | Request)：要获取的 URL 或请求。可以是字符串、Request 对象、Vue ref 或返回字符串/Request 的函数。支持响应式动态端点。
options (object)：fetch 请求的配置。扩展unjs/ofetch选项和 AsyncDataOptions。所有选项都可以是静态值、ref 或计算值。

选项	类型	默认	描述
`key`	`MaybeRefOrGetter<string>`	自动生成	用于去重处理的唯一键。如果未提供，则根据 URL 和选项生成。
`方法`	`MaybeRefOrGetter<string>`	`'GET'`	HTTP 请求方法。
`查询`	`MaybeRefOrGetter<SearchParams>`	-	要添加到 URL 的查询/搜索参数。别名：`params`。
`参数`	`MaybeRefOrGetter<SearchParams>`	-	`query` 的别名。
`正文`	`MaybeRefOrGetter<RequestInit['body'] \| Record<string, any>>`	-	请求正文。对象会自动字符串化。
`headers`	`MaybeRefOrGetter<Record<string, string> \| [key, value][] \| Headers>`	-	请求头。
`baseURL`	`MaybeRefOrGetter<string>`	-	请求的基本 URL。
`timeout`	`MaybeRefOrGetter<number>`	-	终止请求的超时时间（毫秒）。
`缓存`	`布尔值 \| 字符串`	-	缓存控制。布尔值禁用缓存，或使用 Fetch API 值：`default`、`no-store` 等。
`服务器`	`boolean`	`true`	是否在服务器端获取。
`lazy`	`boolean`	`false`	如果为 true，则在路由加载后解析（不阻止导航）。
`immediate`	`boolean`	`true`	如果为 false，则阻止请求立即触发。
`默认`	`() => DataT`	-	在异步解析之前，`data` 默认值的工厂函数。
`timeout`	`number`	-	请求超时前等待的毫秒数（默认为 `undefined`，表示没有超时）
`transform`	`(input: DataT) => DataT \| Promise<DataT>`	-	解析后转换结果的函数。
`getCachedData`	`(key, nuxtApp, ctx) => DataT \| undefined`	-	返回缓存数据的函数。默认值见下文。
`pick`	`string[]`	-	仅从结果中选取指定的键。
`watch`	`MultiWatchSources \| false`	-	要监视和自动刷新的响应式源数组。`false` 禁用监视。
`deep`	`boolean`	`false`	以深层 ref 对象的形式返回数据。
`dedupe`	`'cancel' \| 'defer'`	`'cancel'`	避免同时多次获取相同的键。
`$fetch`	`typeof globalThis.$fetch`	-	自定义 $fetch 实现。请参阅 Nuxt 中的自定义 useFetch

所有 fetch 选项都可以给定一个 computed 或 ref 值。这些值将被监视，如果它们更新，将自动使用任何新值发起新请求。

getCachedData 默认值

const getDefaultCachedData = (key, nuxtApp, ctx) => nuxtApp.isHydrating
  ? nuxtApp.payload.data[key]
  : nuxtApp.static.data[key]

这仅在 nuxt.config 中的 experimental.payloadExtraction 启用时才缓存数据。

返回值

名称	类型	描述
`数据`	`Ref<DataT \| undefined>`	异步获取的结果。
`刷新`	`(opts?: AsyncDataExecuteOptions) => Promise<void>`	手动刷新数据的函数。默认情况下，Nuxt 会等待 `refresh` 完成才能再次执行。
`execute`	`(opts?: AsyncDataExecuteOptions) => Promise<void>`	`refresh` 的别名。
`error`	`Ref<ErrorT \| undefined>`	如果数据获取失败，则为错误对象。
`状态`	`Ref<'idle' \| 'pending' \| 'success' \| 'error'>`	数据请求的状态。可能的值见下文。
`清除`	`() => void`	将 `data` 重置为 `undefined`（如果提供了 `options.default()`，则为该值），将 `error` 重置为 `undefined`，将 `status` 设置为 `idle`，并取消所有待处理的请求。

状态值

idle：请求尚未开始（例如，在服务器渲染时设置了 { immediate: false } 或 { server: false }）
pending：请求正在进行中
success：请求成功完成
error：请求失败

如果您尚未在服务器端获取数据（例如，使用 server: false），那么数据将直到 hydration 完成后才会被获取。这意味着即使您在客户端 await useFetch，data 在 <script setup> 中仍将保持 null。

示例

在文档 > 4 X > 示例 > 高级 > 使用自定义 Fetch Composable 中阅读并编辑实时示例。

在文档 > 4 X > 示例 > 功能 > 数据获取中阅读并编辑实时示例。

这有帮助吗？

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

useError

useError composable 返回正在处理的全局 Nuxt 错误。

useHead

useHead 用于自定义 Nuxt 应用程序中单个页面的 head 属性。