如何通过 TypeScript 模板字面量类型构建具备强约束的国际化翻译 Key 体系

小涛姑娘_4273

小涛姑娘_4273

2026-05-01

556人浏览

原创

能从编译期锁定结构、防止拼错、支持自动补全;通过模板字面量组合模块与字段名生成层级键(如"user.profile"),用satisfies校验语言包结构,keyof typeof自动推导所有合法key并格式化,再结合泛型与运行时检查实现双重安全。

如何通过 typescript 模板字面量类型构建具备强约束的国际化翻译 key 体系

直接用模板字面量类型定义翻译键,能从编译期锁定结构、防止拼错、支持自动补全,比字符串常量或普通接口更精准。

用模板字面量生成带层级的 key

把嵌套路径转为扁平 key,比如 user.profile.name → "user.profile.name",再用模板字面量约束其格式:

  • 先定义合法的一级模块名:type Module = "user" | "settings" | "common";
  • 再定义二级字段名:type UserKey = "profile" | "avatar" | "logout";
  • 组合成完整 key:type TranslationKey = `${Module}.${UserKey}`;(如 "user.profile")
  • 支持多层嵌套:type DeepKey = `${Module}.${UserKey}.${"name" | "email"}`;

结合 satisfies 验证真实语言包结构

光有类型不够,还得确保实际 JSON 或对象符合该 key 体系。用 satisfies 在赋值时校验,又不丢失字面量精度:

Scrapfly SDK TypeScript
Scrapfly SDK TypeScript

使用 Scrapfly SDK(scrapfly-sdk)在 TypeScript 或 JavaScript 中进行网页抓取,用于用户请求抓取 URL、绕过反爬虫防护、渲染页面等场景。

下载
  • 定义 key 类型:type AppKey = "common.ok" | "user.login.title" | "settings.theme.dark";
  • 写语言包时强制匹配:const en = { "common.ok": "OK", "user.login.title": "Sign In" } satisfies Record;
  • 若漏掉某个 key 或写错拼写(如 "commom.ok"),TS 编译直接报错

自动推导所有可用 key(零手动维护)

避免硬编码 key 字符串,让 TypeScript 从语言包对象里“掏”出全部合法 key:

  • 用 keyof typeof en 获取 en 对象的所有键字面量类型
  • 再用映射类型 + 模板字面量统一格式化:type AllKeys = keyof typeof en extends infer K ? K extends string ? `prefix.${K}` : never : never : never;
  • 最终得到类似 "prefix.common.ok" | "prefix.user.login.title" 的联合类型
  • 这个类型可直接用于 translate(key: AllKeys) 参数校验

运行时 key 安全兜底(可选但推荐)

类型再严,也不能替代运行时检查。建议在 translate() 方法里加一层验证:

  • 接收泛型参数 (key: K),确保调用时是合法 key
  • 内部仍做 if (!(key in translations)) console.warn(`Missing translation for ${key}`)
  • 这样既保编译安全,又防部署后漏翻译导致白屏

相关专题

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

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

2023.06.20

3589

3

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

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

2023.07.25

2428

9

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

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

2023.08.02

1360

5

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

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

2023.08.09

1318

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

1416

5

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

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

2023.09.20

2338

7

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

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

2023.09.20

3860

8

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

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

2023.09.22

18115

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

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

共21课时 | 1.8万人学习