如何安全获取TypeScript接口的键名作为字符串（类似枚举）？

假设我们有如下接口：

interface MyInterface {
  propertyA: number;
  propertyB: string;
  propertyC: boolean;
}

直接使用object['propertyA']这类字符串字面量动态访问字段存在两个问题：一是接口字段重命名或修改时，代码不会触发TypeScript错误，导致运行时隐患；二是开发时没有自动提示，降低开发效率。以下是几种无需手动维护、能自动同步接口变更的解决方案：

方案1：用keyof配合常量对象推导键名 #

创建一个约束为keyof MyInterface的常量对象，TypeScript会自动推导所有合法键名，且接口变更时会实时报错提醒：

// 自动推导所有接口键名，无需手动编写
const MyInterfaceKeys = {
  propertyA: 'propertyA',
  propertyB: 'propertyB',
  propertyC: 'propertyC'
} as const satisfies Record<keyof MyInterface, keyof MyInterface>;

// 使用示例：动态访问字段
const obj: MyInterface = { propertyA: 1, propertyB: 'test', propertyC: true };
console.log(obj[MyInterfaceKeys.propertyA]); // 1

// React组件中传递字段名给复用方法
// <SomeReusableComponent field={MyInterfaceKeys.propertyB} />

// 检查字符串是否为接口键名
function isValidField(field: string): field is keyof MyInterface {
  return Object.values(MyInterfaceKeys).includes(field as keyof MyInterface);
}

当MyInterface新增或修改字段时，MyInterfaceKeys会触发TypeScript错误，必须同步更新，彻底避免字符串字面量的隐患。

方案2：利用工具函数生成键名集合 #

如果需要批量获取所有键名，可以写一个类型安全的工具函数，结合keyof和类型断言实现：

function getInterfaceKeys<T>(): Array<keyof T> {
  // 运行时传入空对象断言为T，仅用于类型推导
  return Object.keys({} as T) as Array<keyof T>;
}

// 使用示例
const keys = getInterfaceKeys<MyInterface>(); // ['propertyA', 'propertyB', 'propertyC']

// 检查字符串是否匹配接口键名
if (keys.includes('propertyA' as keyof MyInterface)) {
  console.log('合法字段');
}

这种方式无需手动维护键名对象，但运行时依赖空对象的Object.keys，需确保接口类型和实际键名一致。

方案3：自动生成枚举文件（适合复杂场景） #

如果需要在运行时频繁使用键名，且希望完全自动同步接口变更，可以用代码生成脚本，在编译前从TypeScript接口自动生成枚举：

1. 编写Node.js脚本（比如generate-keys.ts）：

import { readFileSync, writeFileSync } from 'fs';
import { parse } from 'typescript';

// 读取包含接口的文件
const fileContent = readFileSync('./path/to/your-interface.ts', 'utf-8');
const ast = parse(fileContent);

// 遍历AST找到目标接口
const interfaceNode = ast.statements.find(
  node => node.kind === 255 /* InterfaceDeclaration */ && (node as any).name.text === 'MyInterface'
);

if (!interfaceNode) throw new Error('未找到MyInterface接口');

// 提取接口属性名
const properties = (interfaceNode as any).members.map((member: any) => member.name.text);

// 生成枚举代码
const enumCode = `export enum MyInterfaceKeys {
  ${properties.map(key => `${key} = '${key}'`).join(',\n  ')}
}`;

// 写入枚举文件
writeFileSync('./src/MyInterfaceKeys.ts', enumCode);

2. 在package.json中添加编译前执行脚本：

{
  "scripts": {
    "prebuild": "ts-node generate-keys.ts",
    "build": "tsc"
  }
}

每次执行npm run build时，脚本会自动从接口生成枚举文件，接口变更时枚举会同步更新，无需手动维护。

内容的提问来源于stack exchange，提问作者Liam Clark Gutiérrez