为何在TypeScript中用keyof IWarehouse而非string定义变量类型？

代码示例 #

export class SpecialProduct extends Product {
   public warehouseName: keyof IWarehouse = 'warehouse.name';

   //Remaining code where warehouseName is used
}


export type IWarehouse = IStorage & {
  'warehouse.name': string;
  'warehouse.poBox': string;
}

疑问 #

为什么要写public warehouseName: keyof IWarehouse = 'warehouse.name';，而不是直接用public warehouseName: string = 'warehouse.name';？

用keyof IWarehouse替代string是TypeScript类型安全特性的典型应用，核心好处如下：

• 避免拼写错误，保证值的合法性
  要是用string类型，你给warehouseName写个'warehouse.nme'这种错字，TypeScript不会管，但运行时肯定出问题。而keyof IWarehouse会把值限制在IWarehouse的有效属性键范围内，写错直接在IDE里标红，提前把bug扼杀在摇篮里。

• 类型变更时自动同步提醒
  以后如果IWarehouse里的属性名改了，比如把'warehouse.name'改成'warehouse.fullName'，TypeScript会马上检测到warehouseName的赋值不匹配，逼着你一起改。要是用string类型，这种修改根本不会触发任何提示，很容易漏改留下隐患。

• 让代码意图更清晰
  keyof IWarehouse一眼就能告诉其他开发者：这个变量存的是IWarehouse的属性键，不是随便什么字符串。别人维护代码的时候不用猜它的用途，可读性和可维护性直接拉满。

• IDE智能提示加持
  赋值的时候IDE会自动弹出IWarehouse的所有可选键，不用手动敲全字符串，既高效又减少出错概率。

内容的提问来源于stack exchange，提问作者Flack