Vue 3 中 Axios 封装怎么结合 TypeScript 定义响应数据接口

浅婷酱_8485

浅婷酱_8485

2026-10-12

119人浏览

原创

vue 3 中结合 typescript 封装 axios 的核心是让类型贯穿请求全流程:定义泛型 baseresponse 接口统一响应结构,为各接口单独建模数据类型,请求函数支持泛型透传,拦截器确保类型安全与错误处理。

vue 3 中 axios 封装怎么结合 typescript 定义响应数据接口

在 Vue 3 中结合 TypeScript 封装 Axios,核心是让接口返回的数据具备可预测的结构和编辑器智能提示。关键不在于“写个接口”,而在于让类型贯穿请求发起、拦截处理、业务调用全过程。

定义通用响应结构接口

后端通常统一返回类似 { code: number, data: T, message: string } 的格式。用泛型接口描述它,就能适配所有业务接口:

  • 基础响应类型:明确 code、message、data 三要素,data 使用泛型 T 占位,后续可具体化
  • 默认泛型值:设 T = any 或 T = unknown,避免调用时强制传参,提升灵活性
示例:
interface BaseResponse<t unknown> {
  code: number
  message: string
  data: T
}</t>

为具体接口定义数据类型

每个 API 返回的数据结构不同,需单独建模。类型越细,TS 提示越准,运行时隐患越少:

typescript-pro
typescript-pro

您是一位专注于高级类型系统、大规模应用架构及类型安全开发实践的 TypeScript 专家。适用于:advan...

下载
  • 用户列表接口返回数组 → 定义 UserItem 和 UserListResponse
  • 登录接口返回 token 字段 → 单独定义 LoginResponse,继承或组合 BaseResponse
  • 避免直接用 any 或 Record<string any></string>,否则失去类型意义
示例:
interface UserItem {
  id: number
  name: string
  email: string
}

type UserListResponse = BaseResponse<useritem>

interface LoginData {
  token: string
  expires_in: number
}
type LoginResponse = BaseResponse<logindata></logindata></useritem>

在请求方法中注入类型参数

封装的请求函数(如 request.get())要支持泛型透传,确保最终返回值类型精准:

  • 请求函数签名中声明泛型 <t></t>,并用于返回 Promise 类型
  • 响应拦截器中统一解包 res.data 后,仍保留原始泛型信息,不丢失类型上下文
  • 调用时显式传入类型,如 api.getUser<userlistresponse>()</userlistresponse>,或依赖 TS 自动推导
示例(简化版):
class Request {
  request<t>(config: AxiosRequestConfig): Promise<t> {
    return service(config).then(res => res.data as T)
  }
}

// 调用时获得完整类型提示
const users = await request.get<userlistresponse>('/users')</userlistresponse></t></t>

配合拦截器做类型安全处理

响应拦截器不只是“取 data”,更是类型守门人:

  • 当 res.code !== 200 时,抛出带 message 的错误,避免业务层收到 undefined data
  • 对空 data、非预期字段做可选链或断言处理,防止运行时报错
  • 若后端返回结构不稳定(如 data 有时是对象有时是 null),用联合类型 T | null 或可选属性 data?: T 显式表达

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

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

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

下载

相关标签:

vue.js vue typescript axios vue 3

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

相关专题

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

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

2023.08.11

2403

5

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

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

2023.10.09

5183

6

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

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

2024.03.19

6250

13

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

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

2024.03.22

5798

10

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

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

2024.05.22

823

5

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

2026.02.13

292

17

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

2026.02.25

500

17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

2026.03.13

351

19

TypeScript 全栈开发进阶指南
TypeScript 全栈开发进阶指南

面向有 JavaScript 基础的开发者,深入讲解 TypeScript 的类型系统与全栈开发实践。

2026.06.03

266

29

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习