useFetch

源码
使用支持 SSR 的组合函数从 API 端点获取数据。

此组合函数是对 useAsyncData 和 $fetch 的简洁封装。
它自动基于 URL 和 fetch 选项生成 key，提供基于服务器路由的请求 URL 类型提示，并推断 API 响应类型。

useFetch 是一个组合函数，适用于直接在 setup 函数、插件或路由中间件中调用。它返回响应式组合对象，并处理将响应添加到 Nuxt payload，以便在页面水合时无需在客户端重新获取数据。

使用方法

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 }) {
    // 设置请求头
    // 注意，这依赖于 ofetch >= 1.4.0 - 可能需要更新锁文件
    options.headers.set('Authorization', '...')
  },
  onRequestError ({ request, options, error }) {
    // 处理请求错误
  },
  onResponse ({ request, response, options }) {
    // 处理响应数据
    localStorage.setItem('token', response._data.token)
  },
  onResponseError ({ request, response, options }) {
    // 处理响应错误
  },
})

响应式 Key 和共享状态

你可以使用计算属性 ref 或普通 ref 作为 URL，实现基于动态数据的自动更新：

pages/[id].vue
<script setup lang="ts">
const route = useRoute()
const id = computed(() => route.params.id)

// 路由变化时，id 更新，数据会自动重新获取
const { data: post } = await useFetch(() => `/api/posts/${id.value}`)
</script>

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

使用 useFetch 创建的键控状态可以通过 Nuxt 应用中 useNuxtData 访问。
useFetch 是编译器保留的函数名，不应自定义函数命名为 useFetch。
如果从 useFetch 解构的 data 变量是字符串而非 JSON 解析对象，确保组件中没有导入类似 import { useFetch } from '@vueuse/core' 的语句。
在 Docs > 3 X > Getting Started > Data Fetching 中查看详情

响应式 Fetch 选项

Fetch 选项可以以响应式形式提供，支持 computed、ref 和 计算属性。当响应式选项更新时，会自动触发使用更新后值的新请求。

const searchQuery = ref('initial')
const { data } = await useFetch('/api/search', {
  query: { q: searchQuery },
})
// 触发新请求: /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,
})
// 不会触发新请求
searchQuery.value = 'new search'

类型声明

Signature
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>
  cache?: false | 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload'
  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 = {
  /** 本次数据请求的原因 */
  cause: 'initial' | 'refresh:manual' | 'refresh:hook' | 'watch'
}

type AsyncData<DataT, ErrorT> = {
  data: Ref<DataT | null>
  pending: Ref<boolean>
  refresh: (opts?: AsyncDataExecuteOptions) => Promise<void>
  execute: (opts?: AsyncDataExecuteOptions) => Promise<void>
  clear: () => void
  error: Ref<ErrorT | null>
  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 (对象): 请求配置，扩展自 unjs/ofetch 选项和 AsyncDataOptions。所有选项均可为静态值、ref 或计算属性。
  • options (object): 请求配置，扩展自 unjs/ofetch 选项和 AsyncDataOptions。所有选项都可以是静态值、ref 或计算值。
OptionTypeDefaultDescription
keyMaybeRefOrGetter<string>auto-gen用于去重的唯一 key。如果未提供，将基于 URL 和选项自动生成。
methodMaybeRefOrGetter<string>'GET'HTTP 请求方法。
queryMaybeRefOrGetter<SearchParams>-要追加到 URL 的查询/搜索参数。别名：params。
paramsMaybeRefOrGetter<SearchParams>-query 的别名。
bodyMaybeRefOrGetter<RequestInit['body'] | Record<string, any>>-请求体。对象会自动被序列化为字符串。
headersMaybeRefOrGetter<Record<string, string> | [key, value][] | Headers>-请求头。
baseURLMaybeRefOrGetter<string>-请求的基础 URL。
cachefalse | string-缓存控制。布尔值禁用缓存，或使用 Fetch API 的取值：default、no-store 等。
serverbooleantrue是否在服务器端获取。
lazybooleanfalse如果为 true，则在路由加载后解析（不阻塞导航）。
immediatebooleantrue如果为 false，则阻止请求立即触发。
default() => DataT-在异步解析之前，data 的默认值工厂函数。
timeoutnumber-在请求超时前等待的毫秒数（默认 undefined，表示不设置超时）
transform(input: DataT) => DataT | Promise<DataT>-在解析后对结果进行转换的函数。
getCachedData(key, nuxtApp, ctx) => DataT | undefined-返回缓存数据的函数。下方查看默认实现。
pickstring[]-仅从结果中挑选指定的键。
watchMultiWatchSources | false-要监听并自动刷新的一组响应式来源。false 会禁用监听。
deepbooleanfalse在深层 ref 对象中返回数据。
dedupe'cancel' | 'defer''cancel'避免同一时刻对相同 key 进行多次获取。
$fetchtypeof 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 时生效缓存。

返回值

名称类型描述
dataRef<DataT | undefined>异步获取的结果。
refresh(opts?: AsyncDataExecuteOptions) => Promise<void>用于手动刷新数据的函数。默认情况下，Nuxt 会等到一次 refresh 完成后，才允许再次执行。
execute(opts?: AsyncDataExecuteOptions) => Promise<void>refresh 的别名。
errorRef<ErrorT | undefined>如果数据获取失败，则为错误对象。
statusRef<'idle' | 'pending' | 'success' | 'error'>数据请求的状态。下方查看可能的取值。
pendingRef<boolean>用于指示当前请求是否正在进行中的布尔标志。
clear() => void将 data 重置为 undefined（若提供了 options.default() 则重置为该值），将 error 重置为 undefined，将 status 设为 idle，并取消任何正在进行的请求。

状态值

  • idle：请求尚未开始（例如 { immediate: false } 或服务器渲染时 { server: false }）
  • pending：请求正在进行中
  • success：请求成功完成
  • error：请求失败
如果服务器端没有预先请求数据（例如 server: false），那么直到页面完成水合，数据才会被请求。这意味着即使客户端 await 了 useFetch，在 <script setup> 中 data 依旧会是 null。

示例

Read and edit a live example in Docs > 3 X > Examples > Advanced > Use Custom Fetch Composable.
Read and edit a live example in Docs > 3 X > Examples > Features > Data Fetching.