如何用Jest测试未导出TypeScript类及其私有静态方法

怎么访问未导出的TypeScript类 #

TypeScript默认不会对外暴露未导出的类，但有两种常用方式可以在测试里拿到它：

• 临时条件导出（推荐测试用，不影响生产）
  在SomeClass.ts里加一段仅测试环境生效的导出逻辑：

  class SomeClass {
    private static someMethod() {
      // 业务代码
    }
  }
  
  // 只有测试环境才导出类
  if (process.env.NODE_ENV === 'test') {
    module.exports.SomeClass = SomeClass;
  }
  

  然后在测试文件里直接require导入：

  // SomeClass.test.ts
  const { SomeClass } = require('./SomeClass');
  

• 不修改原文件，用类型断言绕过
  不需要动原代码，直接在测试文件里通过require获取模块，再用类型断言指定类的类型：

  // SomeClass.test.ts
  const SomeClass = require('./SomeClass') as unknown as typeof import('./SomeClass').SomeClass;
  

  这里因为原类没导出，import('./SomeClass')里没有这个类型，所以用unknown中转后断言成我们需要的类类型。

怎么调用私有静态方法 #

TypeScript的私有方法只是编译阶段的限制，运行时这些方法其实还是挂在类对象上的，所以可以这么搞：

• 直接用类型断言调用
  把类断言成any类型，跳过TypeScript的检查，直接调用私有方法：

  // SomeClass.test.ts
  (SomeClass as any).someMethod();
  

• 用Object.getOwnPropertyDescriptor获取方法
  如果不想用any，可以通过这个API拿到私有方法的引用：

  // SomeClass.test.ts
  const someMethod = Object.getOwnPropertyDescriptor(SomeClass, 'someMethod')?.value as () => void;
  someMethod(); // 调用测试
  

• 用Jest的spyOn监听调用（如果需要验证调用情况）
  要是你需要测试这个方法被调用了多少次，或者要模拟它的返回值，可以结合spyOn和类型断言：

  // SomeClass.test.ts
  const spy = jest.spyOn(SomeClass as any, 'someMethod');
  // 触发会调用someMethod的业务逻辑
  expect(spy).toHaveBeenCalled(); // 断言方法被调用
  

注意点 #

• 测试未导出类和私有方法相当于绕过了TypeScript的封装，会让测试和代码实现细节绑定得很紧，以后改代码的时候测试很容易挂。能导出类、把私有方法改成受保护的，或者直接测试类的公共接口，就优先这么做。
• 用条件导出的时候，要确保生产环境不会把测试用的导出代码打包进去，避免泄露内部实现。

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