JavaScript / TypeScript / 系统课时
keyof 与属性键
keyof 与属性键
keyof 用来把对象类型的属性名提取成键联合类型。掌握它以后,可以把“只能访问真实存在的属性”写进类型系统,并与泛型组合,实现安全的读取、更新和属性遍历。
学习目标
- 理解
keyof如何得到对象类型的键联合 - 使用
K extends keyof T约束属性参数 - 识别索引签名与
Object.keys的类型边界
从对象类型得到键联合
对普通对象类型使用 keyof,结果是其已知属性名组成的联合类型。下面的 PersonKey 等价于 "name" | "age" | "active",因此变量只能接收这几个键。
keyof 处理的是类型,不会在运行时读取对象。若写成 const key: PersonKey = "email",TypeScript 会在编译阶段报错,因为 email 不属于 Person 的键集合。
用泛型约束属性访问
keyof 最常见的用途,是约束泛型键参数。K extends keyof T 表示 K 必须是 T 的合法属性键,而 T[K] 会进一步得到该属性对应的值类型。
下面的示例同时演示键联合、安全读取和受控的属性遍历:
type Person = {
name: string;
age: number;
active: boolean;
};
// K 只能取 T 的真实属性键,返回值随具体键自动变化。
function getProperty<T, K extends keyof T>(obj: T, key: K): T[K] {
return obj[key];
}
const user: Person = { name: "Ada", age: 36, active: true };
const key: keyof Person = "name";
// 这里分别推断为 string 与 boolean,而不是宽泛的联合类型。
const userName = getProperty(user, "name");
const active = getProperty(user, "active");
console.log(key);
console.log(userName);
console.log(active);
// Object.keys 返回 string[];仅在对象形状可信时局部收窄。
for (const current of Object.keys(user) as Array<keyof Person>) {
console.log(current, user[current]);
}预期输出:
name
Ada
true
name Ada
age 36
active true如果调用 getProperty(user, "email"),错误会在编译阶段暴露,而不是等到运行时得到 undefined。同时,userName 会保持为 string,active 会保持为 boolean。
理解属性键的边界
JavaScript 的属性键可以是 string、number 或 symbol,所以 keyof T 的结果不保证只是字符串。对于带字符串索引签名的类型,例如 { [key: string]: boolean },keyof 会得到 string | number,因为数字属性访问会被转换为字符串键。
如果某个 API 明确只接受字符串键,可以使用 Extract<keyof T, string> 收窄。这样比直接把键断言成 string 更准确,因为约束仍然来源于目标类型本身。
谨慎处理 Object.keys
Object.keys(obj) 在标准类型声明中通常返回 string[],而不是 (keyof T)[]。原因是运行时对象可能包含静态类型没有声明的额外属性,TypeScript 不能普遍保证两者完全一致。
因此,示例中的 as Array<keyof Person> 应只用于你能控制对象形状的场景。面对接口响应、用户输入或第三方数据时,应先做运行时校验,再把键用于类型安全访问。keyof 的核心价值是建立静态约束,而不是替代运行时数据验证。