如何在 setup 中优雅地调用 API?组合式函数封装异步请求的干货教程

星宇小哥_1812

星宇小哥_1812

2026-05-07

530人浏览

原创

vue 3 中调用 api 的核心是使用组合式函数封装请求逻辑,聚焦发起请求、处理响应、暴露 execute 接口,返回 { data, error, loading, execute },支持手动触发、错误加载状态响应式绑定及进阶能力如参数化、取消、缓存与防抖。

如何在 setup 中优雅地调用 api?组合式函数封装异步请求的干货教程

在 Vue 3 的 setup 中调用 API,核心不是“怎么发请求”,而是“如何组织得清晰、可复用、易测试、不污染组件逻辑”。直接在 setup 里写 axios.get() 看似快,但很快会陷入重复处理 loading、error、缓存、取消请求的泥潭。真正的优雅,来自组合式函数(Composable)的合理封装。

明确职责:组合式函数只管“请求逻辑”,不管“UI 状态”

一个高质量的 API 组合式函数,应聚焦三件事:发起请求、处理响应结构、暴露可控的执行接口。它不该直接修改组件内的 ref,也不该主动触发 UI 更新。

  • 返回值推荐解构对象:{ data, error, loading, execute },语义清晰,按需使用
  • execute 是函数,而非自动执行——让调用方决定何时拉数据(比如点击后、路由就绪后)
  • 错误和加载状态用 ref 包裹,方便在模板中响应式绑定(v-if="loading")

基础封装:带 loading 和 error 处理的通用模式

以下是一个生产可用的最小可行封装(以 axios 为例):

(复制即用,支持 TypeScript)
import { ref, Ref } from 'vue'
import axios from 'axios'

interface UseApiOptions {
  manual?: boolean // 是否手动触发,默认 false(自动执行)
}

export function useApi<t>(url: string, options: UseApiOptions = {}) {
  const data = ref<t null>(null)
  const error = ref<error null>(null)
  const loading = ref(false)

  const execute = async () => {
    loading.value = true
    error.value = null
    try {
      const res = await axios.get<t>(url)
      data.value = res.data
      return res.data
    } catch (e) {
      error.value = e as Error
      throw e
    } finally {
      loading.value = false
    }
  }

  if (!options.manual) {
    execute()
  }

  return {
    data,
    error,
    loading,
    execute
  }
}</t></error></t></t>

在组件中使用时干净利落:

import { useApi } from '@/composables/useApi'

export default defineComponent({
  setup() {
    const { data, loading, error, execute } = useApi<user>('/api/user/1')

    const handleRefresh = () => execute()

    return () => (
      <div>
        {loading.value ? '加载中...' : null}
        {error.value ? `错误:${error.value.message}` : null}
        {data.value ? <h2>{data.value.name}</h2> : null}
        <button onclick="{handleRefresh}">刷新</button>
      </div>
    )
  }
})</user>

进阶技巧:支持参数、取消请求、缓存与防抖

真实业务中,你很快会需要这些能力。它们不该堆在组件里,而应沉淀到组合式函数中:

  • 动态参数:把 url 改为函数,如 (id: string) => `/api/user/${id}`,execute 接收参数并重置状态
  • 请求取消:用 AxiosController 或 AbortController,在 execute 中生成新 controller,并在下一次调用前 abort 上次(尤其适合搜索输入框)
  • 简单内存缓存:用 Map 缓存 url + JSON.stringify(params) 对应的结果,命中则直接 resolve,避免重复请求
  • 节流/防抖:对高频触发的 execute(如搜索),用 lodash.debounce 包一层,返回新的防抖函数

避坑提醒:别让组合式函数变成“黑盒”

封装是为了简化,不是隐藏复杂度。几个常见反模式要警惕:

  • 把所有 API 请求都塞进一个叫 useRequest 的万能函数里——参数越来越多,类型难推导,维护成本飙升
  • 在组合式函数里直接调用 notification.success() 或 router.push() —— 违反关注点分离,组件失去控制权
  • 不暴露原始响应(如 res.headers、res.status),导致分页、鉴权头等场景无法处理
  • 忽略 TypeScript 类型推导,用 any 或 unknown 敷衍,失去类型安全优势

好的组合式函数,应该像乐高积木:单个功能纯粹,拼起来却能构建复杂应用。它不替你做决定,只给你稳当的把手。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2503

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5383

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6430

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6038

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

863

5

promise的用法
promise的用法

“promise” 是一种用于处理异步操作的编程概念,它可以用来表示一个异步操作的最终结果。Promise 对象有三种状态:pending(进行中)、fulfilled(已成功)和 rejected(已失败)。Promise的用法主要包括构造函数、实例方法(then、catch、finally)和状态转换。

2023.10.12

4400

6

html文本框类型介绍
html文本框类型介绍

html文本框类型有单行文本框、密码文本框、数字文本框、日期文本框、时间文本框、文件上传文本框、多行文本框等等。详细介绍:1、单行文本框是最常见的文本框类型,用于接受单行文本输入,用户可以在文本框中输入任意文本,例如用户名、密码、电子邮件地址等;2、密码文本框用于接受密码输入,用户在输入密码时,文本框中的内容会被隐藏,以保护用户的隐私;3、数字文本框等等。

2023.10.12

3883

6

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

1674

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

12082

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习