# NestJS 框架与 Drizzle ORM ## 概述该技能为使用 TypeScript 构建 NestJS 应用程序提供了全面的指导，包括与 Drizzle ORM 集成以进行数据库操作。它涵盖了 NestJS 开发的所有主要方面，从基本模块结构到微服务和 GraphQL 等高级模式。 ## 何时使用 * 使用 NestJS 构建 REST API 或 GraphQL 服务器 * 设置认证和授权 * 实现中间件、防护程序或拦截器 * 使用数据库（TypeORM、Drizzle ORM） * 创建微服务架构 * 编写单元和集成测试 * 设置 OpenAPI/Swagger 文档 ## 说明 1. **从模块结构开始**：以清晰的边界定义您的功能模块 2. **实现控制器**：创建控制器来处理HTTP请求并定义路由 3. **创建服务**：在可注入服务类中构建业务逻辑 4. **配置数据库**：使用正确的模式定义设置 Drizzle ORM 5. **添加验证**：使用类验证器实现 DTO 以进行输入验证 6. **Implement Guards** ：根据需要添加身份验证和授权守卫 7. **编写测试**：为所有组件创建单元和 e2e 测试 8. **配置OpenAPI**：为API文档添加Swagger装饰器 ## 示例 ### 创建完整的 CRUD 模块 // 1. 定义实体模式（使用 Drizzle）导出常量产品 = pgTable('产品', { id: 序列号('id').primaryKey(), 名称: 文本('名称').notNull(), 价格：real('价格').notNull(), 创建时间：时间戳('created_at').defaultNow(), }); // 2.创建DTO 导出类 CreateProductDto { @IsString() @IsNotEmpty() 名称：字符串； @IsNumber() @最小(0) 价格：数量； } // 3. 实现服务 @Injectable() 导出类 ProductsService { 构造函数（私有数据库：DatabaseService）{} 异步创建（dto：CreateProductDto）{ 返回 this.db.database.insert(products).values(dto).returning(); } } // 4. 创建控制器 @Controller('产品') 导出类 ProductsController { 构造函数（私有服务：ProductsService）{} @Post() 创建（@Body（）dto：CreateProductDto）{ 返回 this.service.create(dto); } } ## 限制和警告 * **数据库连接** ：始终使用连接池进行生产 * **异步操作** ：所有数据库操作都是异步的；正确处理错误 * **需要 DTO** ：绝不接受控制器中的原始对象；始终使用 DTO * **模块导入** ：小心模块之间的循环依赖关系 * **守卫命令**：身份守卫应在角色守卫之前运行 * **事务范围** ：使事务尽可能短，以避免死锁 * **环境变量**：切勿对数据库凭据或秘密进行硬编码 ## 核心架构 ### 模块结构从'@nestjs/common'导入{模块}； @模块({ 导入：[/* 其他模块 */], 控制器：[/* 控制器 */], 提供者：[/*提供者*/]，导出：[/* 导出的提供程序 */], }) 导出类FeatureModule {} ### 控制器模式从 '@nestjs/common' 导入 { Controller, Get, Post, Body, Param, Query }; @Controller('用户') 导出类 UsersController { @Get() findAll(@Query() 查询：任意) { return '这将返回所有用户'; } @Get(':id') findOne(@Param('id') id: 字符串) { return `这将返回用户 #${id}`; } @Post() 创建（@Body（）createUserDto：任何）{ return '这创建了一个用户'; } } ### 带有依赖注入的服务从“@nestjs/common”导入{可注入}； @Injectable() 导出类 UsersService { 构造函数(/* 注入依赖项 */) {} 查找全部() { return '用户服务逻辑'; } } ## 与 Drizzle 的数据库集成 ### 使用 Drizzle ORM 设置 ####安装 # 使用 npm npm 安装 drizzle-orm pg npm install -D drizzle-kit tsx @types/pg # 使用纱线纱线添加毛毛雨-orm pg 纱线添加-D drizzle-kit tsx @types/pg #### 配置 // 毛毛雨.config.ts 导入“dotenv/config”；从'drizzle-kit'导入{defineConfig}；导出默认的defineConfig({ out: './毛毛雨', 模式：'./src/db/schema.ts'，方言：'postgresql'，数据库凭据：{ url: process.env.DATABASE_URL!, }, }); #### 数据库架构 // src/db/schema.ts 从 'drizzle-orm/pg-core' 导入 { pgTable、serial、text、timestamp}；导出常量用户 = pgTable('用户', { id: 序列号('id').primaryKey(), 名称: 文本('名称').notNull(), 电子邮件：文本（'电子邮件'）.notNull（）.unique（），创建时间：时间戳('created_at').defaultNow(), }); #### 数据库服务 // src/db/database.service.ts 从“@nestjs/common”导入{可注入}；从 'drizzle-orm/node-postgres' 导入 { drizzle }；从'pg'导入{池}；从'./schema'导入*作为模式； @Injectable() 导出类DatabaseService { 私有数据库：ReturnType<细雨类型>；构造函数（）{ 常量池=新池（{ 连接字符串：process.env.DATABASE_URL， }); this.db = 毛毛雨(池, { schema }); } 获取数据库（）{ 返回这个.db； } } #### 用户存储库与 Drizzle // src/users/user.repository.ts 从“@nestjs/common”导入{可注入}；从'../db/database.service'导入{DatabaseService}；从'../db/schema'导入{用户}；从 'drizzle-orm' 导入 { eq }; @Injectable() 导出类 UserRepository { 构造函数（私有数据库：DatabaseService）{} 异步findAll() { 返回 this.db.database.select().from(users); } 异步 findOne(id: 数字) { const 结果 = 等待 this.db.database .select() .来自（用户） .where(eq(用户.id, id)) .限制(1); 返回结果[0]； } 异步创建（数据：用户类型。$inferInsert）{ const 结果 = 等待 this.db.database .插入（用户） .值（数据） .return(); 返回结果[0]； } 异步更新（id：数字，数据：部分<用户类型。$ inferInsert>）{ const 结果 = 等待 this.db.database .更新（用户） .set(数据) .where(eq(用户.id, id)) .return(); 返回结果[0]； } 异步删除（id：数字）{ const 结果 = 等待 this.db.database .删除（用户） .where(eq(用户.id, id)) .return(); 返回结果[0]； } } #### 完整的用户模块 // src/users/users.module.ts 从'@nestjs/common'导入{模块}；从'./users.controller'导入{UsersController}；从'./users.service'导入{UsersService}；从 './user.repository' 导入 { UserRepository }；从'../db/database.service'导入{DatabaseService}； @模块({ 控制器：[UsersController]，提供者：[UsersService、UserRepository、DatabaseService]、导出：[UserService]， }) 导出类 UsersModule {} #### 用户服务实施 // src/users/users.service.ts 从“@nestjs/common”导入{可注入}；从 './user.repository' 导入 { UserRepository }；从 './interfaces/user.interface' 导入 { User }； @Injectable() 导出类 UsersService { 构造函数（私有 userRepository：UserRepository）{} 异步 findAll(): Promise { 返回 this.userRepository.findAll(); } async findOne(id: number): Promise { const user = wait this.userRepository.findOne(id); 如果（！用户）{ 抛出新错误（'找不到用户'）； } 返回用户； } 异步创建（userData：部分<用户>）：Promise <用户> { 返回 this.userRepository.create(userData); } 异步更新（id：数字，userData：部分<用户>）：Promise <用户> { 等待 this.findOne(id); // 验证用户是否存在返回 this.userRepository.update(id, userData); } 异步删除（id：数字）：Promise<用户> { 等待 this.findOne(id); // 验证用户是否存在返回 this.userRepository.remove(id); } } ## 身份验证和授权 ### JWT 身份验证卫士从 '@nestjs/common' 导入 { Injectable, CanActivate, ExecutionContext }; 从'@nestjs/jwt'导入{JwtService}； @Injectable() 导出类 JwtAuthGuard 实现 CanActivate { 构造函数（私有 jwtService：JwtService）{} 可以激活（上下文：ExecutionContext）{ const request = context.switchToHttp().getRequest(); const token = request.headers.authorization?.split(' ')[1]; 如果（！令牌）{ 返回假； } 尝试{ const 解码 = this.jwtService.verify(token); request.user = 已解码；返回真； } 抓住 { 返回假； } } } ### 基于角色的守卫从 '@nestjs/common' 导入 { Injectable, CanActivate, ExecutionContext }; 从'@nestjs/core'导入{Reflector}； @Injectable() 导出类 RolesGuard 实现 CanActivate { 构造函数（私有反射器：反射器）{} canActivate(上下文: ExecutionContext): 布尔值 { const requiredRoles = this.reflector.get('roles', context.getHandler()); if (!requiredRoles) { 返回真； } const { user } = context.switchToHttp().getRequest(); return requiredRoles.some((role) => user.roles?.includes(role)); } } ## 使用管道进行验证 ### 验证管道从 '@nestjs/common' 导入 { PipeTransform、Injectable、ArgumentMetadata、BadRequestException }；从“类验证器”导入{验证}；从 'class-transformer' 导入 { plainToClass } ； @Injectable() 导出类 ValidationPipe 实现 PipeTransform { 异步转换（值：任意，{元类型}：ArgumentMetadata）{ if (!metatype || !this.toValidate(metatype)) { 返回值； } const object = plainToClass(元类型, 值); const 错误 = 等待验证（对象）； if (errors.length > 0) { 抛出新的 BadRequestException（错误）； } 返回值； } 私人toValidate（元类型：函数）：布尔值{ const 类型：Function[] = [String、Boolean、Number、Array、Object]； return !types.includes(元类型); } } ## 异常处理 ### 全局异常过滤器从 '@nestjs/common' 导入 { ExceptionFilter, Catch, ArgumentsHost, HttpException }; 从'express'导入{请求，响应}； @Catch(HttpException) 导出类 HttpExceptionFilter 实现 ExceptionFilter { catch（异常：HttpException，主机：ArgumentsHost）{ const ctx = host.switchToHttp(); const 响应 = ctx.getResponse(); const request = ctx.getRequest(); const status = 异常.getStatus(); 响应.status(状态).json({ 状态代码：状态，时间戳：new Date().toISOString(), 路径：请求.url，消息：异常.消息， }); } } ## 测试模式 ### 单元测试服务从'@nestjs/testing'导入{测试，测试模块}；从'./users.service'导入{UsersService}；从 './user.repository' 导入 { UserRepository }；描述('UsersService', () => { 让服务：UsersService；让存储库：jest.Mocked; beforeEach(异步() => { 常量模拟存储库 = { findAll: jest.fn(), findOne: jest.fn(), 创建：jest.fn(), 更新：jest.fn(), 删除：jest.fn(), } 一样； const 模块：TestingModule =等待Test.createTestingModule({ 提供者：[ 用户服务， { 提供：用户存储库， useValue：模拟存储库， }, ], }).compile(); 服务 = module.get(UsersService); 存储库 = module.get(UserRepository); }); it('应该返回所有用户', async () => { const ExpectedUsers = [{ id: 1, 姓名: 'John', 电子邮件: 'john@example.com' }]; repository.findAll.mockResolvedValue(expectedUsers); const 结果 = 等待服务.findAll(); 期望(结果).toEqual(expectedUsers); 期望(repository.findAll).toHaveBeenCalled(); }); }); ### 使用 Drizzle 进行 E2E 测试从'@nestjs/testing'导入{测试，测试模块}；从 '@nestjs/common' 导入 { INestApplication }；根据“supertest”的要求导入*；从'./../src/app.module'导入{AppModule}；从'../src/db/database.service'导入{DatabaseService}；从 'drizzle-orm/node-postgres' 导入 { drizzle }；从 'drizzle-node-postgres/migrator' 导入 { migrate }; 从 'drizzle-orm/node-postgres/migrator' 导入 { 迁移为 drizzleMigrate }；描述（'UsersController（e2e）'，（）=> { 让应用程序：INestApplication；让db：数据库服务； beforeAll(异步() => { const moduleFixture：TestingModule =等待Test.createTestingModule（{ 导入：[AppModule]， }).compile(); 应用程序 = moduleFixture.createNestApplication(); db = moduleFixture.get(DatabaseService); // 运行迁移等待 drizzleMigrate(db.database, { MigrationsFolder: './drizzle' }); 等待应用程序.init(); }); 毕竟（异步（）=> { 等待应用程序.close(); }); beforeEach(异步() => { // 清理数据库等待 db.database.delete(users).execute(); }); it('/用户 (POST)', () => { 常量 createUserDto = { name: '测试用户', 电子邮件：'test@example.com'， }; 返回请求(app.getHttpServer()) .post('/用户') .send(createUserDto) .期望(201) .expect((res) => { 期望(res.body).toMatchObject(createUserDto); 期望(res.body).toHaveProperty('id'); }); }); it('/users (GET)', async () => { // 首先创建一个用户等待 db.database.insert(users).values({ name: '测试用户', 电子邮件：'test@example.com'， }); 返回请求(app.getHttpServer()) .get('/用户') .期望(200) .expect((res) => { 期望(Array.isArray(res.body)).toBe(true); 期望(res.body).toHaveLength(1); }); }); }); ## 毛毛雨的迁徙 ### 生成迁移 npx drizzle-kit 生成 ### 运行迁移 // src/migrations/migration.service.ts 从“@nestjs/common”导入{可注入}；从 'drizzle-orm/node-postgres/migrator' 导入 { migrate }; 从'../db/database.service'导入{DatabaseService}； @Injectable() 导出类 MigrationService { 构造函数（私有数据库：DatabaseService）{} 异步 runMigrations() { 尝试{ 等待迁移（this.db.database，{migrationsFolder：'./drizzle'}）； console.log('迁移成功完成'); } 捕获（错误）{ console.error('迁移失败：', error); 抛出错误； } } } ## 配置管理 ### 环境配置 // src/config/configuration.ts 导出默认值 () => ({ 数据库：{ url: process.env.DATABASE_URL, }, 智威汤逊：{ 秘密：process.env.JWT_SECRET || '默认秘密', 过期时间：process.env.JWT_EXPIRES_IN || '24 小时', }, 应用程序：{ 端口：parseInt(process.env.PORT, 10) || 3000, }, }); ## 高级模式 ### 自定义装饰器从 '@nestjs/common' 导入 { createParamDecorator, ExecutionContext }; 导出 const User = createParamDecorator( （数据：字符串，ctx：ExecutionContext）=> { const request = ctx.switchToHttp().getRequest(); const 用户 = request.user; 返回数据？用户？.[数据]：用户； }, ）； ### 日志拦截器从 '@nestjs/common' 导入 { Injectable, NestInterceptor, ExecutionContext, CallHandler }; 从 'rxjs' 导入 { Observable } ；从 'rxjs/operators' 导入 { tap }; @Injectable() 导出类 LoggingInterceptor 实现 NestInterceptor { 拦截（上下文：ExecutionContext，下一个：CallHandler）：Observable { const request = context.switchToHttp().getRequest(); const { 方法, url } = 请求; const now = Date.now(); console.log(`[${method}] ${url} - 开始`); 返回下一个 .handle() .管道( tap(() => console.log(`[${method}] ${url} - 结束 ${Date.now() - now}ms`)), ）； } } ## 微服务 ### TCP 微服务 // main.ts 从'@nestjs/core'导入{NestFactory}；从“@nestjs/microservices”导入{ Transport，MicroserviceOptions }；从'./app.module'导入{AppModule}；异步函数 bootstrap() { const app = 等待 NestFactory.createMicroservice( 应用程序模块， { 传输：传输.TCP，选项：{ 主机：'本地主机'，端口：8877， }, }, ）；等待应用程序.listen(); } 引导程序（）； ## GraphQL 集成 ### GraphQL 解析器与 Drizzle 从“@nestjs/graphql”导入{解析器、查询、突变、参数}；从 './user.repository' 导入 { UserRepository }； @Resolver(() => 用户) 导出类 UsersResolver { 构造函数（私有 userRepository：UserRepository）{} @Query(() => [用户]) 异步用户() { 返回 this.userRepository.findAll(); } @Mutation(() => 用户) 异步 createUser(@Args('input') 输入：CreateUserInput) { 返回 this.userRepository.create(input); } } ## 最佳实践 1. **始终使用构造函数注入** \- 切勿使用属性注入 2. **使用DTO进行数据传输** \- 定义请求/响应的接口 3. **实施正确的错误处理** \- 使用异常过滤器 4. **验证所有输入** \- 使用验证管道 5. **保持模块专注** \- 单一职责原则 6. **使用环境变量** \- 切勿对凭据进行硬编码 7. **编写综合测试** \- 单元和集成测试 8. **使用事务进行复杂操作** \- 保持数据一致性 9. **实施适当的日志记录** \- 使用拦截器来处理横切关注点 10. **使用类型安全** \- 利用 TypeScript 功能 ## 毛毛雨的常见模式 ### 交易异步transferFunds（fromId：数字，toId：数字，金额：数字）{ 返回 this.db.database.transaction(async (tx) => { // 从账户中扣除等待发送 .更新（帐户） .set({ 余额: sql`${accounts.balance} - ${金额}` }) .where(eq(accounts.id, fromId)); // 记入账户等待发送 .更新（帐户） .set({ 余额: sql`${accounts.balance} + ${金额}` }) .where(eq(accounts.id, toId)); }); } ### 软删除导出常量用户 = pgTable('用户', { id: 序列号('id').primaryKey(), 名称: 文本('名称').notNull(), 电子邮件：文本（'电子邮件'）.notNull（）.unique（），删除时间：时间戳（'deleted_at'）， }); 异步软删除（id：数字）{ 返回 this.db.database .更新（用户） .set({deletedAt: new Date() }) .where(eq(users.id, id)); } ### 带关系的复杂查询异步 getUsersWithPosts() { 返回 this.db.database .select() .来自（用户） .leftJoin(posts, eq(posts.userId, users.id)); }

携带

包含技能