Jest测试依赖注入类时Mock方法未生效问题排查

出现TypeError: this.KafkaSQSHandler.sendToKafkaSQS is not a function的核心原因是你mock的KafkaSQSHandler类没有生成带有sendToKafkaSQS方法的实例，导致StatementHandlerService调用该方法时找不到对应函数。以下是针对性的修复方案，按场景划分：

场景1：直接在测试文件中mock依赖模块 #

根据KafkaSQSHandler的导出方式调整mock逻辑：

命名导出类的情况 #

如果原模块是命名导出：

// KafkaSQSHandler.js
export class KafkaSQSHandler {
  sendToKafkaSQS() { /* 业务逻辑 */ }
}

测试文件中需要让mock类的构造函数返回带有目标方法的实例：

// StatementHandlerService.test.js
jest.mock('./KafkaSQSHandler', () => ({
  KafkaSQSHandler: jest.fn().mockImplementation(() => ({
    sendToKafkaSQS: jest.fn().mockResolvedValue('模拟返回值')
  }))
}));

import { StatementHandlerService } from './StatementHandlerService';
import { KafkaSQSHandler } from './KafkaSQSHandler';

test('storeAndSend方法正常执行', async () => {
  const service = new StatementHandlerService(new KafkaSQSHandler(), /* 另一个依赖的实例 */);
  await service.storeAndSend();
  
  expect(KafkaSQSHandler).toHaveBeenCalled();
  expect(KafkaSQSHandler.mock.instances[0].sendToKafkaSQS).toHaveBeenCalled();
});

默认导出类的情况 #

如果原模块是默认导出：

// KafkaSQSHandler.js
export default class KafkaSQSHandler { /* ... */ }

调整mock的结构，针对default属性处理：

jest.mock('./KafkaSQSHandler', () => ({
  default: jest.fn().mockImplementation(() => ({
    sendToKafkaSQS: jest.fn().mockResolvedValue('模拟返回值')
  }))
}));

import StatementHandlerService from './StatementHandlerService';
import KafkaSQSHandler from './KafkaSQSHandler';

// 测试逻辑同上

场景2：使用__mocks__目录进行mock #

确保__mocks__下的文件正确返回带有方法的类实例：

// __mocks__/KafkaSQSHandler.js
export class KafkaSQSHandler {
  // 直接给实例添加mock方法
  sendToKafkaSQS = jest.fn().mockResolvedValue('模拟返回值');
}

// 或者用构造函数方式
// export const KafkaSQSHandler = jest.fn().mockImplementation(() => ({
//   sendToKafkaSQS: jest.fn().mockResolvedValue('模拟返回值')
// }));

然后在测试文件中只需调用：

jest.mock('./KafkaSQSHandler');
// 后续导入和测试逻辑同上

场景3：依赖注入模式（构造函数传入实例） #

如果StatementHandlerService是通过构造函数接收依赖实例，无需mock整个模块，直接创建mock实例传入更简单：

// StatementHandlerService.test.js
import { StatementHandlerService } from './StatementHandlerService';

test('storeAndSend方法正常执行', async () => {
  // 创建mock实例
  const mockKafkaSQSHandler = {
    sendToKafkaSQS: jest.fn().mockResolvedValue('模拟返回值')
  };
  const mockAnotherDependency = { /* 另一个依赖的mock方法 */ };

  const service = new StatementHandlerService(mockKafkaSQSHandler, mockAnotherDependency);
  await service.storeAndSend();
  
  expect(mockKafkaSQSHandler.sendToKafkaSQS).toHaveBeenCalled();
});

常见误区排查 #

1. 混淆默认导出与命名导出：mock时必须匹配原模块的导出方式，否则mock的类不会被正确替换。
2. 仅mock类构造函数，未添加实例方法：Jest默认mock的类构造函数返回空对象，必须手动定义实例上的方法。
3. this指向错误：检查StatementHandlerService中是否正确将依赖实例赋值给this.KafkaSQSHandler，比如构造函数中是否遗漏赋值。

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