JavaScript / TypeScript / 系统课时

keyof 约束

keyof 约束

直接用任意字符串访问对象属性,既可能拼错键名,也会丢失返回值类型。本课结合 keyof、泛型约束和索引访问类型,确保传入的键真实存在,并让返回值或新值与该键对应的属性类型保持一致。

学习目标

  • 使用 keyof 获取对象键的联合类型
  • 用 K extends keyof T 限制属性名
  • 使用 T[K] 保持键和值的类型关联

安全读取属性

keyof T 表示类型 T 的全部已知键,T[K] 表示键 K 对应的属性类型。

ts
// 把键与该键对应的值关联起来
function getValue<T, K extends keyof T>(object: T, key: K): T[K] {
  return object[key];
}

function setValue<T, K extends keyof T>(
  object: T,
  key: K,
  value: T[K]
): void {
  object[key] = value;
}

type User = {
  id: number;
  name: string;
  active: boolean;
};

const user: User = {
  id: 1,
  name: "Ada",
  active: false
};

const userName = getValue(user, "name");
setValue(user, "active", true);

console.log(userName.toUpperCase());
console.log(user.active);

预期输出:

text
ADA
true

键为 "name" 时,返回类型是 string;键为 "active" 时,新值必须是 boolean。不存在的键和错误的值类型都会在编译阶段被拒绝。

处理动态字符串

普通 string 可能包含任意内容,不能直接当作 keyof T。来自表单或接口的动态键应先通过白名单、in 检查或专用校验函数确认,再进入泛型函数。

不要随意使用 as keyof T 绕过检查,因为断言只会压制编译错误,不会保证运行时属性真的存在。

与索引签名的区别

索引签名适合键集合本来就开放的字典;keyof 更适合键集合已知的对象模型。选择依据是业务键是否固定,而不是哪种写法更短。

动态键与联合键

对一个确定的 name 字面量键,T[K] 是 string;如果变量本身可能是 name 或 active,读取结果也会是 string 或 boolean 的联合。调用方必须继续判断,泛型不能替你决定运行时选中了哪个键。

这个 setValue 演示单个字面量键的关联,不保证任意联合键与独立联合值逐一配对。若业务需要批量更新,可以把键和值建模为判别联合更新项,再按键分支处理,避免把两个独立联合误当成相关的一对。

通用的 in 检查只能说明某属性当前存在,不会自动把任意 string 变成每一种 T 的 keyof。来自用户输入的字段名应使用与当前模型一致的白名单校验。临时尝试设置 active 为字符串和读取 missing 键,类型检查应拒绝;撤销负例后,原输出仍为 ADA 和 true。

独立验证

使用 TypeScript 5.9.3 和 Node.js 22 检查本节。读取 name 应允许调用 toUpperCase,修改 active 只能传布尔值。临时传字符串或不存在的键,应出现编译错误;撤销后再核对 ADA 与 true。把主示例保存为独立目录的 main.ts,执行 npx tsc main.ts --strict --target ES2022 --module commonjs --outDir dist,预期退出码为 0;再执行 node dist/main.js 核对上述结果。说明性片段按其上下文编译,练习目录保持 CommonJS 模块约定。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

keyof 约束

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通