定义 TypeScript 对象键的类型:使用 Record 和 Partial
在 TypeScript 开发中,我们经常需要定义对象的类型,尤其是当对象的键和值都有明确规则时,合理使用内置工具类型可以大幅减少重复代码,提升类型定义的准确性和可维护性。其中 Record 和 Partial 是两个非常常用的工具类型,本文将详细介绍它们的用法和组合场景。
一、Record 工具类型的基础用法
Record<Keys, Type> 用于构造一个对象类型,其中键的类型是 Keys,值的类型是 Type。它非常适合用来定义“键集合固定、值类型统一”的对象类型,避免我们手动逐个声明每个键的类型。
比如我们需要定义一个表示用户角色权限的对象,键是固定的几个角色,值是布尔类型表示是否拥有对应权限,就可以用 Record 实现:
// 定义角色类型的联合类型
type Role = 'admin' | 'editor' | 'viewer';
// 使用 Record 定义权限对象类型,键为 Role,值为 boolean
type RolePermission = Record<Role, boolean>;
// 符合类型的对象示例
const permissions: RolePermission = {
admin: true,
editor: true,
viewer: false
};如果不使用 Record,我们需要手动写出每个键的类型,当键的数量很多时就会非常繁琐:
// 不使用 Record 的等价写法,冗余度高
type RolePermissionManual = {
admin: boolean;
editor: boolean;
viewer: boolean;
};二、Partial 工具类型的基础用法
Partial<Type> 的作用是将类型 Type 中的所有属性都变为可选属性,常用于处理对象属性不需要全部必填的场景,比如表单提交时的部分更新、初始化可选配置等。
比如我们有一个用户信息的完整类型,在用户编辑个人信息时,可能只需要更新部分字段,就可以用 Partial 生成可选版本的类型:
// 完整的用户信息类型
type UserInfo = {
name: string;
age: number;
email: string;
address: string;
};
// 使用 Partial 生成所有属性可选的类型
type PartialUserInfo = Partial<UserInfo>;
// 只需要更新部分字段,符合 PartialUserInfo 类型
const updateInfo: PartialUserInfo = {
name: '张三',
age: 25
};三、Record 和 Partial 的组合使用
在实际开发中,我们经常会遇到“对象的键是固定集合,但这些键对应的属性不一定全部需要存在”的场景,这时候就可以把 Record 和 Partial 组合起来使用,先通过 Record 定义键和值的对应关系,再用 Partial 把所有键变为可选。
比如我们需要定义一个缓存对象,键是固定的几个接口路径,值是缓存的数据,但初始化时可能还没有缓存任何数据,就可以这样定义:
// 定义接口路径的联合类型
type ApiPath = '/user/list' | '/user/detail' | '/order/list';
// 定义缓存值的类型
type CacheValue = {
data: any;
expireTime: number;
};
// 组合 Record 和 Partial:键为 ApiPath,值为 CacheValue,所有键可选
type ApiCache = Partial<Record<ApiPath, CacheValue>>;
// 初始化空缓存,符合类型要求
const cache: ApiCache = {};
// 缓存某个接口的数据,也符合类型要求
cache['/user/list'] = {
data: [{ id: 1, name: '张三' }],
expireTime: Date.now() + 60 * 1000
};这种组合方式既保证了对象的键只能是预定义的集合,不会出现非法键,又允许对象只包含部分键,非常灵活。如果我们需要反过来,先让属性可选再定义键集合,也是可以的,不过通常先 Record 再 Partial 的逻辑更符合“先确定键和值的对应关系,再允许部分缺失”的场景。
四、注意事项
1. Record 的键类型 Keys 需要是 string | number | symbol 的子类型,通常我们使用字符串联合类型作为键类型,避免传入不符合要求的类型。
2. Partial 只会处理第一层的属性,如果对象有嵌套结构,需要递归处理的话,可以自定义深度可选的工具类型,不过大部分场景下第一层可选已经能满足需求。
3. 组合使用时要注意顺序,Partial<Record<K, V>> 和 Record<K, Partial<V>> 是不同的:前者是键可选,后者是值内部的属性可选,需要根据实际需求选择。
type K = 'a' | 'b';
type V = { x: number; y: number };
// 键可选,值的结构不变
type A = Partial<Record<K, V>>;
// 等价于 { a?: V; b?: V }
// 键必填,值的所有属性可选
type B = Record<K, Partial<V>>;
// 等价于 { a: { x?: number; y?: number }; b: { x?: number; y?: number } }
TypeScriptRecordPartial对象类型工具类型 本作品最后修改时间:2026-05-22 14:33:26