用途 该技能用于 NestJS 微服务开发,当需要创建控制器、服务、模块、守卫、拦截器,或在认证、订单、商品等场景中应用 NestJS 模式时使用。
项目结构 项目使用 NestJS 构建三个微服务:
- apps/auth:认证服务,使用 JWT 与 Passport。
- apps/order:订单管理服务,集成 Temporal。
- apps/product:商品目录服务。 共享模块位于 packages/core。
创建新模块
- 创建模块文件:在 feature/feature.module.ts 中通过 @Module 装饰器声明 controllers、providers,并通过 exports 导出 FeatureService。
- 创建服务(仓储模式):在 feature/feature.service.ts 中使用 @Injectable 装饰器,注入来自 @projectx/db 的 PrismaService,提供 findAll、findOne、create 等方法,内部调用 prisma.feature 的 findMany、findUnique、create。
- 创建带 Swagger 的控制器:在 feature/feature.controller.ts 中使用 @ApiTags('features') 与 @Controller('features'),通过 @Get、@Get(':id')、@Post 定义路由,并用 @ApiOperation、@ApiResponse 标注摘要与响应。
DTO 与校验 在 feature/dto/create-feature.dto.ts 中定义 CreateFeatureDto,使用 class-validator 的 @IsString、@IsNotEmpty、@IsOptional 以及 @nestjs/swagger 的 @ApiProperty、@ApiPropertyOptional 对字段 name 和可选字段 description 进行校验与文档标注。
认证守卫 使用来自 @projectx/core 的守卫,例如通过 @UseGuards(JwtAuthGuard) 标注控制器,使所有路由需要认证。
异常处理 使用 NestJS 内置异常,如 NotFoundException、BadRequestException。在服务中查询不到数据时抛出 NotFoundException,并带上包含 ID 的提示信息。
测试服务 使用 @nestjs/testing 的 Test、TestingModule 编写测试。在 beforeEach 中通过 Test.createTestingModule 注册 FeatureService,并以 useValue 提供 PrismaService 的模拟实现(jest.fn() 模拟 findMany、findUnique、create)。测试中可断言服务已定义。
运行服务 使用 pnpm 命令运行指定服务或全部服务:pnpm dev:auth、pnpm dev:order、pnpm dev:product,或 pnpm dev 运行全部。
最佳实践 始终使用 DTO 进行请求/响应校验;使用 Swagger 装饰器编写 API 文档;通过 @projectx/db 的 Prisma 服务应用仓储模式;使用 NestJS 内置异常处理错误;为服务与控制器编写测试;在认证场景使用 @projectx/core 的守卫。
限制 资料未提供安装步骤、环境变量、数据库迁移、部署方式、收费信息及具体版本要求,相关内容暂未提供。