NestJS导入HealthModule后Users/Todos控制器ID参数为undefined

项目环境与结构 #

使用Yarn Berry管理monorepo项目，目录结构如下：

- apps
  - bff
    - src
      - users
        - users.module.ts
        - users.controller.ts
        - users.service.ts
      - todos
        - todos.module.ts
        - todos.controller.ts
        - todos.service.ts
      - app.module.ts
      - app.controller.ts
      - app.service.ts
      - main.ts
- packages
  - shared-nestjs-modules
    - src
      - health
        - health.controller.ts
        - health.service.ts
        - health.module.ts
        - index.ts
      - index.ts

异常现象 #

在apps/bff/src/app.module.ts中导入@workspace/shared-nestjs-modules下的HealthModule后：

• 访问users/:id或todos/:id接口时，控制器通过@Param('id')获取的id值为undefined
• 移除HealthModule导入后，Users/Todos控制器的id参数能正常接收
• HealthController自身的:id参数始终可以正常获取

相关代码片段 #

app.module.ts #

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { TodosModule } from '@todos/todos.module';
import { UsersModule } from '@users/users.module';
import { validate } from '@env/env.validation';
import { ConfigModule } from '@nestjs/config';
import { ApiModule } from '@api/api.module';
import { HealthModule } from '@workspace/shared-nestjs-modules';

@Module({
  imports: [
    ConfigModule.forRoot({
      validate,
      isGlobal: true,
      envFilePath: `./src/env/.env.${process.env.NODE_ENV}`
    }),
    HealthModule,  // 疑似引发问题的模块
    TodosModule,
    UsersModule,
    ApiModule
  ],
  controllers: [AppController],
  providers: [AppService]
})
export class AppModule {}

users.controller.ts（关键片段） #

@Controller('users')
export class UsersController {
  constructor(private readonly usersService: UsersService) {}

  @Get(':id')
  getOneUser(@Param('id', ParseIntPipe) id: number): User {
    console.log('id', id);     // undefined...
    return this.usersService.getOneUser(id);
  }

  // Patch/Delete方法的id参数同样为undefined
}

todos.controller.ts（关键片段） #

@Controller('todos')
export class TodosController {
  constructor(private readonly todosService: TodosService) {}

  @Get('/:id')
  getOneTodo(@Param('id', ParseIntPipe) id: number): Todo {
    console.log('id', id);  // undefined...
    return this.todosService.getOneTodo(id);
  }

  // Patch/Delete方法的id参数同样为undefined
}

health.controller.ts（正常工作的控制器） #

@Controller('health')
export class HealthController {
  constructor(private readonly healthService: HealthService) {}

  @Get(':id')
  getOneHealthCheck(@Param('id', ParseIntPipe) id: number) {
    console.log('id', id);    // 此ID参数能正常接收
    const healthCheck = this.healthService.getHealthCheck();
    return healthCheck;
  }
}

排查与解决方案 #

核心原因：模块导入顺序+全局组件冲突 #

NestJS按模块导入顺序注册路由和全局组件，若HealthModule先于Users/Todos模块导入，且其内部注册了全局管道/拦截器，可能干扰后续模块的参数解析逻辑。

具体解决步骤 #

1. 检查HealthModule的全局组件注册
   打开packages/shared-nestjs-modules/src/health/health.module.ts，查看是否全局注册了ParseIntPipe或自定义管道：

   // 错误示例：全局注册管道会干扰局部参数解析
   @Module({
     controllers: [HealthController],
     providers: [
       HealthService,
       {
         provide: APP_PIPE,
         useClass: ParseIntPipe,
       },
     ],
   })
   export class HealthModule {}
   

   若存在此类代码，删除全局注册，改为在控制器方法中局部使用ParseIntPipe。

2. 调整模块导入顺序
   在app.module.ts中将HealthModule移到Users/Todos模块之后：

   @Module({
     imports: [
       ConfigModule.forRoot({...}),
       TodosModule,
       UsersModule,
       HealthModule, // 移到后面
       ApiModule
     ],
     // ...其他配置
   })
   

   让NestJS先注册Users/Todos的路由，避免HealthModule的全局组件影响参数解析。

3. 检查全局拦截器/守卫的参数处理
   若HealthModule注册了全局拦截器，确认其未错误修改request.params：

   // 错误示例：拦截器误清空params
   @Injectable()
   export class GlobalInterceptor implements NestInterceptor {
     intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
       const request = context.switchToHttp().getRequest();
       request.params = {}; // 需删除此类代码
       return next.handle();
     }
   }
   

4. 统一依赖版本
   确保apps/bff和packages/shared-nestjs-modules中的@nestjs/*依赖版本完全一致，版本不一致可能导致内部路由逻辑冲突。可通过yarn list @nestjs/common命令验证。

验证 #

调整后重启服务，访问/users/1或/todos/1，查看控制台是否正常打印id值。

内容的提问来源于stack exchange，提问作者Jay Choi