从 enum 接口上的 prop 解析类型

Question

所以我有一个很大的网络应用程序。这解决了很多实体。 例如：

enum EntityTypes {
  EntityA = 'A',
  EntityB = 'B',
  EntityC = 'C',
  EntityD = 'D',
}

interface EntityA {
  type: EntityTypes.EntityA;
  aSpecialProperty: boolean;
}

interface EntityB {
  type: EntityTypes.EntityB;
  bSpecialProperty: boolean;
}

interface EntityC {
  type: EntityTypes.EntityC;
  cSpecialProperty: string;
}

interface EnityD {
  type: EntityTypes.EntityD;
  dSpecialProperty: number;
}

我们这样做是因为我们稍后希望像这样解析每种类型独有的属性（到目前为止，我们都是这样做的）：

type EntityTypesResolver<T extends EntityTypes> = T extends EntityTypes.EntityA
  ? EntityA
  : T extends EntityTypes.EntityB
  ? EntityB
  : T extends EntityTypes.EntityC
  ? EntityC
  : T extends EntityTypes.EntityD
  ? EntityD
  : never;

type EntityResolver<ResultType> = {
  [P in EntityTypes]: (entity: EntityTypesResolver<P>) => ResultType;
};

const resolver: EntityResolver<string> = {
  [EntityTypes.EntityA]: (entity) => `${entity.aSpecialProperty}`,
  [EntityTypes.EntityB]: (entity) => `${entity.bSpecialProperty}`,
  [EntityTypes.EntityC]: (entity) => entity.cSpecialProperty,
  [EntityTypes.EntityD]: (entity) => `${entity.dSpecialProperty}`,
};

问题：我想消除（或找到更优雅的解决方案）EntityTypesResolver，因为它看起来像一个容易出错的代码块，原因如下：

1. 由于我们是一个致力于此代码库的大型团队，我不想依赖其他程序员记住维护这种类型
2. 这里的可读性很糟糕

我很长时间都试图为此找到一个优雅的解决方案，但似乎没有取得任何成果。

@jcalz提出的解决方案： 我对这个解决方案的问题是我仍然必须依靠其他程序员来维护Entity 类型别名。 //这两行

type Entity = EntityA | EntityB | EntityC | EntityD
type EntityTypesResolver<T extends EntityTypes> = Extract<Entity, { type: T }>

Answer 1

您的EntityTypesResolver<T> 类型函数根据为T 传入的EntityTypes 成员从一组已知接口中选择一个接口。目前，它通过一系列conditional types 来实现这一点，这很有效，但正如你所说，它的可读性不是很高。

将这些接口转换为discriminated union 并根据type 判别属性定义EntityTypesResolver 到Extract 该联合的一个或多个成员会更加自然和可读。看起来像这样：

type Entity = EntityA | EntityB | EntityC | EntityD;
type EntityTypesResolver<T extends EntityTypes> = Extract<Entity, { type: T }>;

这样可读性问题就解决了。

---

不幸的是，编译器无法知道EntityTypesResolver 应该咨询哪一组接口，除非你告诉它，这是无法避免的。所以有人将不得不维护Entity 类型，确保它包含一个对应于EntityTypes 枚举的每个成员的成员。例如，无法要求编译器扫描它知道的所有接口并选择具有正确排序的type 属性的接口。

您可以做的一件事（感谢您的建议）是编写一些代码，当且仅当 Entity 联合缺少来自其成员。一种方法是定义一个虚拟generic type，其类型参数为constrained 到Entity 中所有type 属性的并集，其中defaults 到EntityTypes，这是所有@987654345 的并集@枚举值。泛型参数默认值必须扩展它们的约束，因此这行代码用于检查 Entity 是否完整：

type EntityCompletenessCheck<T extends Entity['type']
  = EntityTypes> = void;
//  ^^^^^^^^^^^ <-- is there an error here?
// if so, then the Entity union is missing at least one entry from EntityTypes

请注意，Entity 中所有type 属性的并集写为Entity['type']，indexed access type 回答了以下问题：“如果我有一个e 类型为Entity 和索引以'type' 类型的值进入它...即e.type，我读取的值的类型是什么？”由于 Entity 是一个联合，并且该联合的每个成员都有不同的 type 属性，因此您最终会得到这些联合。

还请注意，EntityCompletenessCheck 是一个虚拟类型，除了错误检查外，我们没有其他任何用途，因此它的名称和值无关紧要。我将其命名为EntityCompletenessCheck 并为其分配了void，但如果您愿意，您可以将其命名为Foo 并为其分配"bar"。

反正上面的代码，没有错误。但是，如果我要在 EntityTypes 中添加一个新值，而 Entity 中没有相应的条目，如下所示：

enum EntityTypes {
  EntityA = 'A',
  EntityB = 'B',
  EntityC = 'C',
  EntityD = 'D',
  EntityE = 'E', // <-- new enum member
}
type Entity = EntityA | EntityB | EntityC | EntityD // <-- oops, forgot

那你有没有报错：

type EntityCompletenessCheck<T extends Entity['type']
  = EntityTypes> = void;
//  ~~~~~~~~~~~ <-- ERROR! Type 'EntityTypes' does not satisfy the constraint 
// 'EntityTypes.EntityA | EntityTypes.EntityB | EntityTypes.EntityC | EntityTypes.EntityD'

这表明Entity['type'] 没有捕获所有EntityTypes 枚举成员，并且您需要修复一些问题（例如，将EntityE 接口添加到Entity 联合，或删除EntityE来自EntityTypes 枚举）。

---

所以你去。代码大部分是可读的，如果开发人员不记得维护 Entity 可区分联合，那么将会出现一个错误，希望能提醒他们或您。

---

Playground link to code