TypeScript 中 Record 类型的基本用法
在 TypeScript 开发过程中,我们经常需要定义键值对结构的对象类型,比如配置项、映射表等场景。如果直接用普通的对象类型定义,需要反复声明每个键的类型,不仅冗余还容易出错。这时候 Record 类型就能帮我们更简洁、更规范地定义这类对象结构。
什么是 Record 类型
Record 是 TypeScript 内置的实用类型,它的作用是构造一个对象类型,这个对象的键和值都有明确的类型约束。它的泛型定义形式是 Record<Keys, Type>,其中第一个参数 Keys 表示对象键的类型,通常是字符串、数字或者联合类型;第二个参数 Type 表示对象值的类型。
基础使用场景示例
比如我们需要定义一个存储用户信息的映射表,键是用户 ID(字符串类型),值是用户的基础信息对象,用 Record 可以这样定义:
// 定义用户信息的类型
interface UserInfo {
name: string;
age: number;
email: string;
}
// 使用 Record 定义用户信息映射表,键为字符串类型的用户ID,值为 UserInfo 类型
const userMap: Record<string, UserInfo> = {
"u_1001": { name: "张三", age: 25, email: "zhangsan@ipipp.com" },
"u_1002": { name: "李四", age: 28, email: "lisi@ipipp.com" }
};
// 访问的时候也会有完整的类型提示
const user = userMap["u_1001"];
console.log(user.name); // 输出:张三上面的代码中,我们不用逐个声明每个用户 ID 对应的类型,只需要通过 Record<string, UserInfo> 就明确了整个对象的键必须是字符串,值必须符合 UserInfo 的结构,后续给 userMap 赋值或者访问属性时都会有对应的类型校验。
键为联合类型的用法
如果对象的键是固定的几个可选值,比如定义不同环境的配置,我们可以把第一个参数改成联合类型,这样能进一步约束键的范围,避免拼写错误:
// 定义环境类型的联合类型
type EnvType = "dev" | "test" | "prod";
// 定义配置项的类型
interface EnvConfig {
apiBaseUrl: string;
timeout: number;
}
// 使用 Record 定义环境配置映射,键只能是 EnvType 中的三个值
const envConfigMap: Record<EnvType, EnvConfig> = {
dev: { apiBaseUrl: "http://127.0.0.1:3000/api", timeout: 5000 },
test: { apiBaseUrl: "https://test.ipipp.com/api", timeout: 8000 },
prod: { apiBaseUrl: "https://ipipp.com/api", timeout: 10000 }
};
// 如果尝试添加不存在的键,TypeScript 会直接报错
// envConfigMap.staging = { apiBaseUrl: "", timeout: 0 }; // 这行会提示错误,staging 不在 EnvType 中这种写法还有一个好处是,如果后续调整了联合类型的范围,比如新增了预发布环境 pre,TypeScript 会提示我们补全 envConfigMap 中对应的配置,避免遗漏。
注意事项
- 使用
Record定义对象时,如果第一个参数是联合类型,那么对象必须包含联合类型中的所有键,不能缺少也不能多余,否则会触发类型错误。 - 如果需要定义可选键的对象,不能直接用
Record,可以结合Partial实用类型,比如Partial<Record<EnvType, EnvConfig>>,这样所有键都会变成可选。 Record构造的对象类型不会限制对象的原型方法或者额外属性,如果有更严格的约束需求,可以结合其他实用类型或者接口继承来实现。
TypeScriptRecord类型键值对对象联合类型类型约束 本作品最后修改时间:2026-05-22 14:34:58