NestJS SQS消费者中ChildService依赖注入失败问题排查

问题描述 #

使用nestjs-sqs处理SQS消息时，SQSListenerService中注入的ChildService始终为undefined，调用this.childService.someMethod(data)时抛出错误：

TypeError: Cannot read properties of undefined (reading 'someMethod')

相关代码结构：

• sqs-listener.service.ts：SQSListenerService注入ChildService，并通过@SqsMessageHandler监听队列
• child.service.ts：定义了ChildService及someMethod方法
• micro-orchestrator.module.ts：已导入ChildModule，并将SQSListenerService声明为提供者
• child.module.ts：已提供并导出ChildService

完整错误栈：

TypeError: Cannot read properties of undefined (reading 'someMethod')
    at SQSListenerService.startActivity (/Users/avinash.anshu/Project/Josys/smithereens/src/infrastructure/micro-orchestrator/sqs-listener.service.ts:52:31)
    at SQSListenerService.startListening (/Users/avinash.anshu/Project/Josys/smithereens/src/infrastructure/micro-orchestrator/sqs-listener.service.ts:38:18)
    at Consumer.executeHandler (/Users/avinash.anshu/Project/Josys/smithereens/node_modules/sqs-consumer/dist/consumer.js:191:28)
    at Consumer.processMessage (/Users/avinash.anshu/Project/Josys/smithereens/node_modules/sqs-consumer/dist/consumer.js:143:24)
    at Array.map (<anonymous>)
    at Consumer.handleSqsResponse (/Users/avinash.anshu/Project/Josys/smithereens/node_modules/sqs-consumer/dist/consumer.js:125:57)
    at processTicksAndRejections (node:internal/process/task_queues:95:5)

核心原因 #

问题本质是函数上下文丢失：nestjs-sqs的底层依赖sqs-consumer在调用消息处理方法时，未绑定NestJS注入的服务实例的this上下文，导致this指向了Consumer实例而非SQSListenerService，因此this.childService为undefined。

解决方案 #

方案1：用箭头函数定义处理方法 #

箭头函数会自动绑定当前实例的this，确保上下文正确：

@Injectable()
export class SQSListenerService {
  constructor(private readonly childService: ChildService) {}

  @SqsMessageHandler('queue-name', false)
  startListening = async (message: AWS.SQS.Message) => {
    const data = JSON.parse(message.Body);
    await this.childService.someMethod(data);
  };
}

方案2：开启装饰器的bind选项 #

在@SqsMessageHandler中设置bind: true，让nestjs-sqs自动绑定上下文：

@Injectable()
export class SQSListenerService {
  constructor(private readonly childService: ChildService) {}

  @SqsMessageHandler('queue-name', { bind: true })
  async startListening(message: AWS.SQS.Message) {
    const data = JSON.parse(message.Body);
    await this.childService.someMethod(data);
  }
}

方案3：手动绑定方法到实例 #

在服务的生命周期钩子中手动绑定this：

@Injectable()
export class SQSListenerService implements OnModuleInit {
  constructor(private readonly childService: ChildService) {}

  async startListening(message: AWS.SQS.Message) {
    const data = JSON.parse(message.Body);
    await this.childService.someMethod(data);
  }

  onModuleInit() {
    this.startListening = this.startListening.bind(this);
  }
}

额外验证点 #

1. 确认ChildModule已加入MicroOrchestratorModule的imports数组，且ChildService在ChildModule中完成providers声明和exports导出
2. 检查SQSListenerService是否仅通过NestDI容器实例化，避免手动new SQSListenerService()（会绕过依赖注入流程）

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