如何利用 TypeScript 模板字面量类型构建具备强校验的路由动态参数系统

夏明吖_5963

夏明吖_5963

2026-05-07

939人浏览

原创

模板字面量类型+条件类型可在编译期捕获路径参数类型错误,如将/user/123/post/abc中abc应为number的错误提前暴露;需用infer提取参数名并递归处理多级参数,配合类型映射实现id: number等约束。

如何利用 typescript 模板字面量类型构建具备强校验的路由动态参数系统

能直接在编译期捕获 /user/123/post/abc 这类路径中 abc 应为 number 的错误,而不是等运行时 404 或后端报 500 —— 这就是模板字面量类型 + 条件类型组合能干的实事。

用 `/users/:id` 这种写法定义路由类型,TS 默认不认

TypeScript 不会把字符串字面量 "/users/:id" 自动识别为“带参数的路径”,它只当普通字符串。必须显式告诉 TS:冒号后是参数占位符,且要提取它的名字和约束类型。

  • 不能直接写 type UserRoute = "/users/:id" —— 这只是个固定字符串,id 没有类型意义
  • 正确做法是用模板字面量配合 infer,例如:type RouteParams = T extends `${string}/:${infer K}` ? { [k in K]: string } : {}
  • 关键点:${infer K} 是唯一能从字符串中“抓出”参数名的方式;而 K 后续可被映射为对象键
  • 如果路径含多级参数(如 /posts/:postId/comments/:commentId),需递归处理,否则只会提取第一个 :postId

ExtractParams 怎么自动推导成 { id: string; postId: string }

靠条件类型 + 递归展开。核心是让 TS 把路径按 /: 切开,逐段 infer 参数名,并累积到一个对象类型里。

  • 基础递归结构:T extends `${string}/:${infer K}/${infer Rest}` ? { [k in K]: string } & ExtractParams : ...
  • 注意 Rest 必须再进一次 ExtractParams,否则第二层参数不会出现
  • 终止条件要覆盖单参数(/${string}/:${infer K})和无参数(string)两种情况,漏掉会导致类型变 any
  • 实际使用时,ExtractParams 推导出 { id: string },但如果你希望 id 是 number,就得额外加约束逻辑(见下一条)

让 :id 对应 number 而非默认 string,需要手动标注

模板字面量本身不解析语义,:id 和 :idNum 在类型层面没区别。要实现数字校验,得引入额外标记机制。

Galileo TypeScript sdk
Galileo TypeScript sdk

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

下载
  • 常见方案:改用大括号语法,如 /users/{id:number}/posts/{postId:number},再用正则式匹配 {(\w+):(\w+)} 提取名与类型名
  • 然后通过映射类型查表:type TypeMap = { number: number; string: string; boolean: boolean },拼出 { [k in K]: TypeMap[T] }
  • 更轻量的做法是约定后缀,比如 :idNum 表示 number,:idStr 表示 string,再用条件类型做后缀剥离
  • ⚠️ 注意:TypeScript 无法在类型层面执行 parseInt,所以所有“数字参数”最终仍需运行时转换,类型层只负责拒绝非数字字符串字面量(如 "abc")

生成完整路由联合类型时,keyof 和 as const 容易混淆

你可能想把所有合法路径收集成一个联合类型,比如 "/users/:id" | "/posts/:id",但若来源是对象 key,容易掉坑。

  • 错误写法:const routes = { user: "/users/:id", post: "/posts/:id" }; type AllRoutes = keyof typeof routes → 得到 "user" | "post",不是路径字符串
  • 正确写法:先用 as const 固定值,再取值类型:const routes = { user: "/users/:id", post: "/posts/:id" } as const; type AllRoutes = typeof routes[keyof typeof routes]
  • 更推荐直接定义联合类型:type KnownRoutes = "/users/:id" | "/posts/:id",避免运行时对象干扰类型推导
  • 如果路由来自配置文件(JSON),需用 declare module "*.json" + as const 导入,否则 JSON 默认是 any

真正难的不是写出 ExtractParams,而是当路由嵌套变深、参数类型混合(string/number/id[])、还要兼容 SSR 数据预取时,类型递归深度和错误提示可读性会迅速下滑——这时候宁愿拆成两个工具类型,也不硬塞进一个泛型里。

相关文章

路由优化大师
路由优化大师

路由优化大师是一款及简单的路由器设置管理软件,其主要功能是一键设置优化路由、屏广告、防蹭网、路由器全面检测及高级设置等,有需要的小伙伴快来保存下载体验吧!

下载

相关标签:

typescript 路由

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

相关专题

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

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

2023.06.20

3469

3

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

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

2023.07.25

2408

9

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

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

2023.08.02

1340

5

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

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

2023.08.09

1278

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

1396

5

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

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

2023.09.20

2298

7

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

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

2023.09.20

3740

8

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

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

2023.09.22

17455

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万人学习