如何用Jest测试TypeScript类是否正确实现指定接口？

TypeScript接口是编译时类型约束，编译后会被完全移除，所以没法直接在运行时获取接口的属性键来做校验。要实现你要的需求，得用「编译时校验+运行时测试」结合的方案，下面是两种可行的实现方式：

方案一：维护接口的运行时属性键列表 #

先创建一个和接口属性完全对应的常量数组，用TypeScript的类型系统确保这个数组和接口的属性一致，再用Jest校验类实例的属性是否匹配这个数组。

步骤1：定义运行时属性键并做编译时校验 #

// 假设你的TemplateInterface定义如下
interface TemplateInterface {
  id: string;
  name: string;
  description: string;
}

// 1. 定义接口属性键的运行时数组
const TEMPLATE_INTERFACE_KEYS = ['id', 'name', 'description'] as const;

// 2. 用类型断言确保数组和接口完全匹配（编译时校验）
type TemplateInterfaceKeys = typeof TEMPLATE_INTERFACE_KEYS[number];
// 如果数组和接口的属性不匹配，下面的类型会报错
type AssertKeysMatchInterface = TemplateInterface extends Record<TemplateInterfaceKeys, unknown> ? true : never;
const assertMatch: AssertKeysMatchInterface = true;

步骤2：编写Jest测试用例 #

it("should match all properties defined in TemplateInterface", () => {
  const template = new Template(sampleTemplateJson);
  const instanceKeys = Object.keys(template);

  // 校验实例包含接口要求的所有属性
  TEMPLATE_INTERFACE_KEYS.forEach(key => {
    expect(instanceKeys).toContain(key);
  });

  // 可选：如果需要严格校验实例没有多余属性，加上这一步
  expect(instanceKeys.sort()).toEqual(TEMPLATE_INTERFACE_KEYS.sort());
});

这样做的好处是：

• 编译时如果修改了接口但没更新数组，TypeScript会直接报错
• 运行时测试会校验类实例的属性是否完全符合要求，一旦类的属性被修改导致不匹配，测试会失败

方案二：利用类的类型推导（适合简单场景） #

如果你的类是直接按照接口实现的，也可以通过keyof推导类的属性类型，再结合一个辅助函数来做校验：

// 辅助函数：校验对象包含指定的所有属性
function hasAllProperties<T>(obj: unknown, keys: readonly (keyof T)[]): obj is T {
  if (typeof obj !== 'object' || obj === null) return false;
  return keys.every(key => key in obj);
}

// 测试用例
it("should conform to TemplateInterface", () => {
  const template = new Template(sampleTemplateJson);
  // 这里用keyof TemplateInterface推导属性键，但需要转成运行时数组
  const requiredKeys = ['id', 'name', 'description'] as const satisfies readonly (keyof TemplateInterface)[];
  
  expect(hasAllProperties<TemplateInterface>(template, requiredKeys)).toBe(true);
});

这个方案里的satisfies关键字（TypeScript 4.9+支持）会确保数组里的键都属于接口的属性，编译时就能校验数组的正确性，运行时则通过辅助函数判断实例是否包含所有属性。

为什么原测试无法满足需求 #

你原来的测试expect(template).toBeInstanceOf(InspectionTemplate)只验证了实例属于指定类，但不管这个类是否符合接口定义——哪怕类实现接口时报错（比如你代码里的注释提示），只要类能被实例化，这个测试都会通过。

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