NestJS集成NATS时控制器方法重复执行问题排查

可能的原因及对应解决方式 #

1. NestJS侧重复注册订阅/服务 #

• 场景：认证服务的控制器被多次添加到模块的controllers数组中，或者网关侧的ClientsModule重复导入并配置了相同的服务客户端（比如模块通过forRoot和forFeature重复加载）。
• 验证：检查认证服务的模块配置，确认带@Controller()装饰的类仅在一个模块的controllers列表中声明；网关侧排查ClientsModule.register()/registerAsync()的调用次数，确保同一服务客户端只初始化一次。
• 解决：清理重复的模块导入或控制器注册逻辑，保证每个服务/客户端仅被初始化一次。

2. NATS请求超时触发自动重发（可通过NATS配置调整） #

• 场景：网关的NATS客户端在规定时间内未收到认证服务的响应，自动触发请求重发。通常是因为客户端超时阈值设置过短，或者认证服务处理请求的耗时超过了阈值。
• 验证：对比调试日志中网关发送请求的时间戳和认证服务接收请求的时间戳，确认两次请求的间隔是否符合超时重发规律；检查网关侧NATS客户端的timeout参数配置。
• 解决：
  • 延长网关侧NATS客户端的超时时间：

    ClientsModule.register([
      {
        name: 'AUTH_SERVICE',
        transport: Transport.NATS,
        options: {
          servers: ['nats://localhost:4222'],
          timeout: 5000, // 调整为合适的超时时长，单位ms
        },
      },
    ])
    

  • 若认证服务存在性能瓶颈，同步优化服务端方法的执行效率，避免超时。

3. NATS未配置队列组（多实例场景，可通过NATS配置调整） #

• 场景：如果认证服务部署了多个实例，且未配置队列组（queue group），NATS会将同一个请求广播给所有订阅该subject的实例，导致每个实例都执行一次方法（单实例场景下此原因不适用）。
• 验证：检查认证服务的NATS微服务配置，确认是否设置了queue参数；查看@MessagePattern装饰器是否指定了队列组。
• 解决：在服务端配置中添加队列组，确保同一subject的请求仅被一个实例处理：

  // 认证服务main.ts
  app.connectMicroservice({
    transport: Transport.NATS,
    options: {
      servers: ['nats://localhost:4222'],
      queue: 'auth-service-queue', // 配置队列组
    },
  });
  

  或者直接在@MessagePattern中指定队列：

  @MessagePattern({ cmd: 'checkPhoneCode' }, { queue: 'auth-service-queue' })
  async checkPhoneCode(payload: any) {
    // 业务逻辑
  }
  

4. 业务代码误触发多次调用 #

• 场景：网关侧的代码中重复调用了client.send()方法，比如异步逻辑中重复触发、事件监听回调被多次绑定等。
• 验证：在网关调用checkPhoneCode的代码处添加日志，确认实际调用次数；排查是否存在重复的事件监听或Promise触发逻辑。
• 解决：修复业务代码，确保client.send()仅被调用一次。

是否可通过NATS配置解决？ #

部分场景可以通过调整NATS配置解决：

• 请求超时导致的重发：调整客户端timeout参数即可。
• 多实例广播导致的重复执行：配置队列组（queue group）可解决。
  但如果是NestJS模块/控制器重复注册、业务代码误调用的问题，需要调整代码或NestJS配置，无法单纯通过修改NATS配置解决。

内容的提问来源于stack exchange，提问作者Sergei Illarionov