如何通过 TypeScript 条件类型运算自动化推断复杂的 RESTful API 返回结构

落宇酱_7189

落宇酱_7189

2026-05-29

463人浏览

原创

单纯用 t extends u ? x : y 无法推导响应字段,因它只做类型兼容判断而不解析结构;必须结合 infer 提取子类型与分布式条件类型处理联合响应。

如何通过 typescript 条件类型运算自动化推断复杂的 restful api 返回结构

直接用 T extends { success: true } ? { data: T } : { error: string } 这类写法,推不出实际数据结构——它只做静态分支判断,不解析响应体字段。真正能自动化推断 API 返回结构的,得靠条件类型 + infer + 分布式行为三者联动。

为什么单纯用 T extends U ? X : Y 无法推导响应字段

条件类型本身不“读取”对象属性,只做类型兼容性判断。比如你传入 { success: true; result: { id: 1 } }T extends { success: true } 为真,但返回的 { data: T }data 类型还是整个原始对象,不是你想要的 { id: 1 }

常见错误现象:

  • 调用后 IDE 提示 dataany 或宽泛的联合类型
  • 想取 res.data.id,但编译报错“Property 'id' does not exist on type 'T'”
  • 手动加 as 断言才能通过,失去类型安全意义

必须搭配 infer 才能提取嵌套结构

infer 是唯一能从类型中“抓出子类型”的机制。比如要从 { success: true; data: User } 中抽出 User,就得写:

type ExtractData<t> = T extends { success: true; data: infer D } ? D : never;</t>

关键点:

  • infer D 必须出现在 extends 右侧的类型模式中,不能写在问号后面
  • 如果结构不完全匹配(比如字段名是 payload 而非 data),整个条件就走 never 分支,结果为空联合类型
  • 多个 infer 可同时使用:T extends { code: 200; body: infer B; meta: infer M }

联合响应格式需依赖分布式条件类型

真实 API 常返回 { code: 200; data: User } | { code: 400; error: string }。这时单层条件类型会失效,因为 TypeScript 默认对联合类型每个成员分别应用条件逻辑(即“分布式行为”)。

正确做法是让条件类型作用于裸泛型参数:

TypeScript
TypeScript

{"answer":"编写类型安全的 TypeScript,合理运用类型收窄、推断模式与严格模式最佳实践。"}

下载
type ApiResponse<t> = T extends { code: 200; data: infer D } 
  ? { ok: true; data: D } 
  : T extends { code: number; error: infer E } 
    ? { ok: false; error: E } 
    : never;</t>

这样 ApiResponse 就能自动拆解、分别映射,最终得到 { ok: true; data: User } | { ok: false; error: 'Unauthorized' }

容易踩的坑:

  • 把泛型包进元组或对象(如 [T]{ input: T })会关闭分布式行为,导致整个联合被当做一个整体处理
  • 没写 never 终止分支,TypeScript 会补全为 unknown,破坏类型收敛
  • 字段名大小写/拼写不一致(如 Data vs data)直接让 infer 失效

实际封装建议:用工具类型组合而非硬编码

不要为每个接口单独写一遍 ExtractData,而是抽象成可复用的工具:

// 支持自定义成功字段和数据字段
type StandardResponse<t successkey extends keyof t="success" datakey> = 
  T extends Record<successkey true> & Record<datakey infer d>
    ? { data: D; error: null }
    : T extends Record
      ? { data: null; error: string }
      : never;</datakey></successkey></t>

使用时:

type UserRes = { success: true; data: { id: number; name: string } };
type Result = StandardResponse<userres>; // { data: { id: number; name: string }; error: null }</userres>

注意点:

  • 字段名作为泛型参数传入,避免重复定义;但运行时不可变,所以仅适用于约定稳定的响应规范
  • Record<k v></k> 比直接写 { [K]: V } 更安全,能防止 K 不在 T 中时意外通过
  • 这种封装在大型项目中容易失控——一旦后端改一个字段名,所有调用处都会爆红,得同步更新泛型参数

最易被忽略的是:条件类型推导结果不会反向影响运行时数据形状。即使类型上 data 被精确推为 User,如果你实际返回的是 { success: true, data: null },TS 也拦不住——它只校验你写的类型是否自洽,不校验数据是否符合类型。

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

相关文章

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

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

下载

相关标签:

typescript restful api

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2589

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2108

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1080

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1018

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1256

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1918

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

2900

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

12535

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

509

3

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习