如何在Nest.js动态useClass注入的自定义服务中添加Jest Spy

你遇到的核心问题是：从测试模块通过module.get('ExampleService')获取的实例，与控制器私有属性中注入的实例并非同一个引用。大概率是因为服务作用域设置（非单例），或者Nest DI容器处理字符串令牌动态useClass提供者时的内部逻辑，导致实例复用异常。

方案一：直接访问控制器私有属性（无需临时方法） #

利用TypeScript类型断言直接获取控制器内的私有服务实例，再进行spy操作：

it('... test description', async () => {
  // 直接获取控制器实际使用的ExampleService实例
  const actualExampleService = (controller as any).exampleService;
  const spy2 = jest.spyOn(actualExampleService, 'method').mockImplementation(() => /* 模拟逻辑 */);

  await controller.method(/* 参数 */);

  expect(spy2).toHaveBeenCalled();
});

方案二：测试时替换为模拟服务（更符合单元测试隔离原则） #

不依赖实际的DevelopmentService或ProductionService，直接在测试模块中提供模拟实例，完全控制测试依赖：

beforeEach(async () => {
  // 预先创建模拟服务，包含需要测试的方法
  const mockExampleService = {
    method: jest.fn(() => /* 模拟返回值 */)
  };

  const module: TestingModule = await Test.createTestingModule({
    controllers: [MyController],
    imports: [/* 你的模块导入 */],
    providers: [
      AnotherService,
      // 替换动态提供者为模拟实例
      {
        provide: 'ExampleService',
        useValue: mockExampleService
      }
    ],
  }).compile();

  anotherService = module.get<AnotherService>(AnotherService);
  exampleService = mockExampleService;
  controller = module.get<MyController>(MyController);
});

it('... test description', async () => {
  await controller.method(/* 参数 */);

  // 直接断言模拟方法是否被调用
  expect(exampleService.method).toHaveBeenCalled();
});

方案三：确保服务为单例作用域 #

如果你的DevelopmentService或ProductionService设置了非单例作用域（如Scope.REQUEST/Scope.TRANSIENT），会导致每次获取的实例都是新的，进而出现引用不一致问题。检查并确保服务为单例：

import { Injectable, Scope } from '@nestjs/common';

@Injectable({ scope: Scope.DEFAULT }) // DEFAULT即单例，显式声明避免歧义
export class DevelopmentService {
  // 服务逻辑
}

同时确保测试中通过正确令牌获取实例：

exampleService = module.get<DevelopmentService | ProductionService>('ExampleService');

当你使用动态useClass提供者时，若服务为非单例作用域，或Nest DI处理字符串令牌时的内部机制导致module.get返回的实例与控制器注入的实例并非同一引用，那么你对exampleService的spy操作只会作用于前者，无法覆盖控制器实际使用的实例。

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