配置Kafka后gRPC服务为何显示undefined？

问题描述 #

我正尝试使用gRPC和Kafka实现微服务，但在main.ts中同时配置两者后，gRPC客户端无法在onModuleInit方法中加载。仅在配置Kafka时this.service会变为undefined，不清楚是否遗漏配置或存在错误，恳请提供相关建议！

main.ts 代码 #

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

  app.connectMicroservice<MicroserviceOptions>({
    transport: Transport.GRPC,
    options:{
      url: '0.0.0.0.:50053',
      package: protobufPackage,
      protoPath: join('./order.proto',)
    },
  });

  app.connectMicroservice<MicroserviceOptions>({
    transport: Transport.KAFKA,
    options:{
      client: {
        brokers: ['localhost:29092'],
      },
      consumer: {
        groupId: 'orders-consumer',
      },
    },
  });

  await app.startAllMicroservices();
}

提供者中的客户端代码 #

public onModuleInit(): void {
  this.service = this.clientService<ProductService>(PRODUCT_SERVICE_NAME);
}

排查与解决建议 #

• 修正gRPC配置的URL错误：你代码里gRPC的url写的是0.0.0.0.:50053，多了一个多余的点，正确格式应为0.0.0.0:50053。这个拼写错误会导致gRPC服务无法正常启动，直接引发客户端代理获取失败。
• 调整微服务初始化顺序：同时启动多个微服务时，Nest默认并行初始化，可能导致gRPC客户端依赖的服务还未就绪就执行了onModuleInit。可以改为串行初始化，确保gRPC服务先完成启动：

  const grpcMs = app.connectMicroservice<MicroserviceOptions>({ /* gRPC配置 */ });
  const kafkaMs = app.connectMicroservice<MicroserviceOptions>({ /* Kafka配置 */ });
  
  await grpcMs.init(); // 优先初始化gRPC服务
  await kafkaMs.init();
  

• 延后客户端初始化时机：onModuleInit在模块初始化完成后立即执行，此时Kafka的初始化可能占用资源导致gRPC代理未创建完成。可以将客户端初始化逻辑移到onApplicationBootstrap钩子中，这个钩子会在所有微服务启动完成后触发：

  public onApplicationBootstrap(): void {
    this.service = this.clientService<ProductService>(PRODUCT_SERVICE_NAME);
  }
  

• 验证客户端代理配置：确认clientService是通过ClientsModule.register()或@Client()装饰器正确注册的gRPC客户端代理，且PRODUCT_SERVICE_NAME与gRPC proto文件中定义的服务名称完全匹配（包括大小写、命名空间）。
• 添加日志定位问题：在关键节点添加日志，确认服务启动状态和客户端代理创建情况：

  // bootstrap函数中
  await app.startAllMicroservices();
  console.log('所有微服务启动完成');
  
  // 客户端代码中
  public onModuleInit(): void {
    console.log('开始初始化gRPC客户端');
    this.service = this.clientService<ProductService>(PRODUCT_SERVICE_NAME);
    console.log('客户端初始化结果:', this.service);
  }
  

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