Nuxt 中的自定义 useFetch

如何在 Nuxt 中为调用外部 API 创建自定义 fetcher。

在使用 Nuxt 时，您可能会在前端调用外部 API，并且可能需要为从 API 获取数据设置一些默认选项。

$fetch 实用函数（由 useFetch 可组合函数使用）故意不支持全局配置。这很重要，因为这样可以确保整个应用程序中的数据获取行为保持一致，并且其他集成（例如模块）可以依赖于 $fetch 等核心实用函数的行为。

然而，Nuxt 提供了一种为您的 API 创建自定义 fetcher 的方法（如果您有多个 API 要调用，则可以创建多个 fetcher）。

自定义 $fetch

让我们使用 Nuxt 插件创建一个自定义 $fetch 实例。

$fetch 是一个已配置的实例ofetch它支持添加 Nuxt 服务器的基本 URL 以及在 SSR 期间直接函数调用（避免 HTTP 往返）。

让我们假设这里

  • 主 API 是https://api.nuxt.com
  • 我们正在使用以下方式将 JWT 令牌存储在会话中：nuxt-auth-utils
  • 如果 API 返回 401 状态码，我们会将用户重定向到 /login 页面。
app/plugins/api.ts
export default defineNuxtPlugin((nuxtApp) => {
  const { session } = useUserSession()

  const api = $fetch.create({
    baseURL: 'https://api.nuxt.com',
    onRequest ({ request, options, error }) {
      if (session.value?.token) {
        // note that this relies on ofetch >= 1.4.0 - you may need to refresh your lockfile
        options.headers.set('Authorization', `Bearer ${session.value?.token}`)
      }
    },
    async onResponseError ({ response }) {
      if (response.status === 401) {
        await nuxtApp.runWithContext(() => navigateTo('/login'))
      }
    },
  })

  // Expose to useNuxtApp().$api
  return {
    provide: {
      api,
    },
  }
})

通过这个 Nuxt 插件，$api 从 useNuxtApp() 暴露出来，可以直接从 Vue 组件进行 API 调用。

app/app.vue
<script setup>
const { $api } = useNuxtApp()
const { data: modules } = await useAsyncData('modules', () => $api('/modules'))
</script>
用 useAsyncData 包装可避免在进行服务器端渲染时（服务器和客户端在水合时）出现双重数据获取。

自定义 useFetch/useAsyncData

现在 $api 包含了我们想要的逻辑，让我们创建一个 useAPI 可组合函数来替代 useAsyncData + $api 的用法。

app/composables/useAPI.ts
import type { UseFetchOptions } from 'nuxt/app'

export function useAPI<T> (
  url: string | (() => string),
  options?: UseFetchOptions<T>,
) {
  return useFetch(url, {
    ...options,
    $fetch: useNuxtApp().$api as typeof $fetch,
  })
}

让我们使用新的可组合函数，并拥有一个美观整洁的组件。

app/app.vue
<script setup>
const { data: modules } = await useAPI('/modules')
</script>

如果您想自定义返回的任何错误的类型，也可以这样做。

import type { FetchError } from 'ofetch'
import type { UseFetchOptions } from 'nuxt/app'

interface CustomError {
  message: string
  statusCode: number
}

export function useAPI<T> (
  url: string | (() => string),
  options?: UseFetchOptions<T>,
) {
  return useFetch<T, FetchError<CustomError>>(url, {
    ...options,
    $fetch: useNuxtApp().$api,
  })
}
此示例演示了如何使用自定义 useFetch，但对于自定义 useAsyncData 来说，结构是相同的。
在 文档 > 4 X > 示例 > 高级 > 使用自定义 Fetch 可组合项中阅读和编辑实时示例。
我们目前正在讨论寻找一种更清晰的方式让您创建自定义 fetcher，请参阅：https://github.com/nuxt/nuxt/issues/14736.