TypeScript 中确保数组包含对象常量全部键的类型安全方案

大墨吖_3198

大墨吖_3198

2026-05-21

466人浏览

原创

TypeScript 中确保数组包含对象常量全部键的类型安全方案

本文介绍如何利用 TypeScript 的高级类型技巧(如递归条件类型和元组联合转换),自动校验数组是否完整包含 as const 对象的所有键,实现“增删枚举项即触发编译错误”的强约束机制。

本文介绍如何利用 typescript 的高级类型技巧(如递归条件类型和元组联合转换),自动校验数组是否完整包含 `as const` 对象的所有键,实现“增删枚举项即触发编译错误”的强约束机制。

在 TypeScript 项目中,我们常使用 as const 对象模拟字符串枚举(如状态码、选项标识等),以兼顾运行时可读性与编译期类型安全性。但当需要将这些键导出为数组(例如用于下拉选项、权限校验或 API 参数白名单)时,传统写法极易遗漏新增/删除的键 —— 而 TypeScript 默认无法检测 ['ACTIVE'] 是否缺少 'DELETED'。

下面是一个典型且不安全的写法:

export const Status = {
  'ACTIVE': 'Active',
  'DELETED': 'Deleted'
} as const;

export type StatusKeys = keyof typeof Status; // 'ACTIVE' | 'DELETED'

// ❌ 编译通过,但语义不完整:缺少 'DELETED'
export const ArrayStatus: StatusKeys[] = ['ACTIVE'];

该代码不会报错,因为 StatusKeys[] 仅表示“元素属于联合类型”,而非“必须包含全部字面量”。

✅ 正确解法:用递归条件类型生成全排列元组

核心思路是:将联合类型 'ACTIVE' | 'DELETED' 转换为唯一合法元组类型 ['ACTIVE', 'DELETED'] 或 ['DELETED', 'ACTIVE'],从而让 TypeScript 在赋值时强制要求“数量一致 + 元素全覆盖”。

我们定义一个泛型工具类型 TupleUnion:

Galileo TypeScript sdk
Galileo TypeScript sdk

完整的Galileo AI平台 TypeScript/JS SDK 参考,用于评估、观察和保护 GenAI 应用。适用于构建 Node.js 或 TypeScript 项目。

下载
type TupleUnion<u extends string r any> = {
  [S in U]: Exclude<u s> extends never
    ? [...R, S] // 基础情况:只剩一个未选,直接追加
    : TupleUnion<exclude s>, [...R, S]>; // 递归:从剩余中选一个,继续构造
}[U];</exclude></u></u>

该类型通过映射类型遍历联合中的每个字面量 S,并递归构建所有可能的排列组合元组,最终通过索引访问 [U] 得到所有合法排列的联合类型。

应用示例:

export const Status = {
  'ACTIVE': 'Active',
  'DELETED': 'Deleted',
  'PENDING': 'Pending'
} as const;

export type StatusKeys = keyof typeof Status; // 'ACTIVE' | 'DELETED' | 'PENDING'

// ✅ 正确:必须包含全部三个键(顺序任意)
export const ArrayStatus: TupleUnion<statuskeys> = ['ACTIVE', 'PENDING', 'DELETED'];

// ❌ 编译错误:缺少 'PENDING'
// export const ArrayStatusBad: TupleUnion<statuskeys> = ['ACTIVE', 'DELETED'];

// ✅ 也可用于子集(需显式排除)
export const Subset: TupleUnion<exclude>> = ['ACTIVE', 'DELETED'];</exclude></statuskeys></statuskeys>

? 原理简析:TupleUnion 展开后等价于 ['A', 'B'] | ['B', 'A'],因此赋值时若元素数量不足或存在重复/缺失,TS 会因无法匹配任一元组而报错。

⚠️ 注意事项与最佳实践

  • 性能提示:TupleUnion 是递归类型,对超过 5–6 个字面量的联合可能触发 TS 深度限制(可通过 --maxNodeModuleJsDepth 调整,但建议枚举项保持精简)。
  • 顺序无关性:该方案允许任意顺序,符合多数业务场景;如需固定顺序(如按定义顺序),需配合 const 断言 + satisfies(TS 4.9+)或额外排序逻辑。
  • 维护性优势:一旦向 Status 新增 'ARCHIVED': 'Archived',所有依赖 TupleUnion 的数组声明将立即报错,强制开发者同步更新,杜绝漏配风险。
  • 替代方案对比:
    • Object.keys(Status) as const ❌ 无法推导字面量类型;
    • 手动维护 ['ACTIVE', 'DELETED'] as const ❌ 失去与源对象的自动同步;
    • 运行时校验(如 assert(ArrayStatus.length === Object.keys(Status).length))❌ 无法在编辑器/CI 阶段捕获。

通过 TupleUnion,你将获得真正“声明即契约”的类型保障 —— 枚举即真相,数组即镜像,任何偏差皆不可编译通过。

相关文章

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

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

下载

相关标签:

typescript

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

相关专题

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

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

2023.06.20

3349

3

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

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

2023.07.25

2368

9

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

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

2023.08.02

1300

5

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

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

2023.08.09

1258

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

1376

5

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

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

2023.09.20

2258

7

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

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

2023.09.20

3640

8

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

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

2023.09.22

16835

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.7万人学习

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

共21课时 | 1.7万人学习