使用NestJS消费RabbitMQ消息时触发事件处理器匹配错误

问题描述 #

从RabbitMQ管理页面向NestJS微服务发送消息时，持续触发报错：

ERROR [Server] There is no matching event handler defined in the remote service. Event pattern: undefined

即使发送简单文本/JSON消息也无法解决问题，项目代码配置如下：

Main.ts #

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { MicroserviceOptions, Transport } from '@nestjs/microservices';
import { ConfigService } from '@nestjs/config';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const configService = app.get(ConfigService);

  const rabbitMQUrl = configService.get<string>('RABBITMQ_URL') || 'amqp://localhost:5672';
  const queueName = configService.get<string>('RABBITMQ_QUEUE_NAME') || 'apply_recommendations';

  console.log(`✅ Connecting to RabbitMQ: ${rabbitMQUrl}`);
  console.log(`🎯 Listening on queue: ${queueName}`);

  app.connectMicroservice<MicroserviceOptions>({
    transport: Transport.RMQ,
    options: {
      urls: [rabbitMQUrl],
      queue: queueName,
      queueOptions: { durable: true },
    },
  });

  await app.startAllMicroservices();
  await app.listen(process.env.PORT ?? 3000);
  console.log('🚀 Microservice is running...');
}

bootstrap();

AppModule.ts #

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: '.env',
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

AppController.ts #

import { Body, Controller, Post } from '@nestjs/common';
import { AppService } from './app.service';
import { ApplyRecommendationsPayload } from './interfaces/apply-recommendations.interface';
import { EventPattern, MessagePattern, Payload } from '@nestjs/microservices';


@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Post('/apply-recommendations')
  async applyRecommendations(@Body() payload: any) {
    return this.appService.applyRecommendations(payload);
  }


  @EventPattern('apply_recommendations')
  async handleMessage(@Payload() data: any) {
    console.log('📩 Received message from RabbitMQ:', data);
  }
  
}

.env文件 #

RABBITMQ_URL=amqp://guest:guest@localhost:5672
RABBITMQ_QUEUE_NAME=apply_recommendations

原因分析 #

NestJS的RMQ传输器默认要求消息遵循特定结构：必须包含pattern字段（对应@EventPattern或@MessagePattern定义的事件名称）和data字段（消息内容）。而通过RabbitMQ管理页面直接发送的纯文本/简单JSON消息缺少这个结构，导致NestJS无法识别事件模式，从而抛出Event pattern: undefined错误。

解决方案 #

方案1：发送符合NestJS格式的消息 #

在RabbitMQ管理页面发送消息时，使用包含pattern和data的JSON结构，示例：

{
  "pattern": "apply_recommendations",
  "data": "你的消息内容"
}

发送后，NestJS的@EventPattern('apply_recommendations')处理器就能正确匹配并接收消息。

方案2：配置自定义消息转换器（自动兼容简单消息） #

如果希望兼容RabbitMQ管理页面发送的简单消息，无需手动添加pattern字段，可以在NestJS的RMQ配置中添加自定义序列化/反序列化器，自动为无pattern的消息补充默认值（比如队列名）。修改Main.ts中的微服务配置：

app.connectMicroservice<MicroserviceOptions>({
  transport: Transport.RMQ,
  options: {
    urls: [rabbitMQUrl],
    queue: queueName,
    queueOptions: { durable: true },
    // 添加自定义转换器
    serializer: {
      serialize: (value) => JSON.stringify(value),
      deserialize: (value) => {
        let parsed;
        try {
          parsed = JSON.parse(value.toString());
        } catch {
          // 处理纯文本消息
          parsed = value.toString();
        }
        // 如果没有pattern字段，默认使用队列名作为事件模式
        if (typeof parsed === 'object' && !parsed.pattern) {
          return {
            pattern: queueName,
            data: parsed,
          };
        } else if (typeof parsed !== 'object') {
          return {
            pattern: queueName,
            data: parsed,
          };
        }
        return parsed;
      },
    },
  },
});

配置完成后重启服务，即可直接发送纯文本或简单JSON消息，NestJS会自动识别并匹配对应的事件处理器。

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