本文详细介绍了在nest.js应用中使用class-validator创建自定义异步验证器时，如何正确注入typeorm repository以进行数据库操作。通过将验证器类标记为@injectable并将其注册为模块提供者，同时引入typeormmodule.forfeature，确保repository实例能被nest.js依赖注入容器管理，从而解决repository为null的问题，实现数据库查询。
在Nest.js项目中，class-validator 库提供了一种强大且灵活的方式来定义数据传输对象（DTO）的验证规则。当需要进行异步验证，例如检查数据库中某个字段的唯一性时，我们通常会创建一个自定义的验证器。然而，一个常见的问题是在自定义验证器中尝试通过 @InjectRepository 注入 TypeORM Repository 时，发现 Repository 实例始终为 null。这通常是因为自定义验证器类没有被Nest.js的依赖注入（DI）容器正确管理。
问题分析
考虑以下自定义验证器代码，其目标是检查 name 字段在 Parking 实体中是否唯一：
import { InjectRepository } from '@nestjs/typeorm';import { registerDecorator, ValidationOptions, ValidatorConstraint, ValidatorConstraintInterface, ValidationArguments,} from 'class-validator';import { Repository } from 'typeorm';import { Parking } from '../entities/parking.entity';@ValidatorConstraint({ async: true })export class UniqueNameConstraint implements ValidatorConstraintInterface { constructor( @InjectRepository(Parking) private parkingRepository: Repository, ) {} async validate(name: any, args: ValidationArguments) { // 此时 parkingRepository 为 null const parking = await this.parkingRepository.findOne({ where: { name } }); return !parking; // 如果找到，则表示不唯一，验证失败 }}export function UniqueName(validationOptions?: ValidationOptions) { return function (object: object, propertyName: string) { registerDecorator({ target: object.constructor, propertyName: propertyName, options: validationOptions, constraints: [], validator: UniqueNameConstraint, }); };}
并在 DTO 中使用：
import { Field, InputType } from '@nestjs/graphql'; // 假设使用 GraphQLimport { UniqueName } from './unique-name.validator'; // 引入自定义验证器@InputType()export class CreateEntityInput { @UniqueName({ message: 'The name already exists' }) @Field(() => String, { description: 'Name of the entity' }) name: string;}
当运行此代码时，parkingRepository 在 UniqueNameConstraint 类的 validate 方法中会是 null。其根本原因在于，class-validator 在实例化 UniqueNameConstraint 时，并不知道它是一个需要Nest.js DI容器处理的类。因此，@InjectRepository 装饰器无法发挥作用，Repository 也就无法被注入。
解决方案
要解决此问题，我们需要确保 UniqueNameConstraint 类能够被Nest.js的依赖注入容器识别和管理。这需要进行以下两个关键步骤：
将验证器类标记为可注入： 使用 @Injectable() 装饰器标记 UniqueNameConstraint 类。将验证器注册为模块提供者： 在相应的 Nest.js 模块中，将 UniqueNameConstraint 添加到 providers 数组中。为实体导入 TypeORM 功能模块： 确保该模块通过 TypeOrmModule.forFeature() 导入了 Parking 实体。
步骤一：更新自定义验证器类
为 UniqueNameConstraint 添加 @Injectable() 装饰器。
import { Injectable } from '@nestjs/common'; // 导入 Injectableimport { InjectRepository } from '@nestjs/typeorm';import { registerDecorator, ValidationOptions, ValidatorConstraint, ValidatorConstraintInterface, ValidationArguments,} from 'class-validator';import { Repository } from 'typeorm';import { Parking } from '../entities/parking.entity';@Injectable() // 添加此行@ValidatorConstraint({ async: true })export class UniqueNameConstraint implements ValidatorConstraintInterface { constructor( @InjectRepository(Parking) private parkingRepository: Repository, ) {} async validate(name: any, args: ValidationArguments) { // 此时 parkingRepository 将被正确注入 const parking = await this.parkingRepository.findOne({ where: { name } }); return !parking; }}export function UniqueName(validationOptions?: ValidationOptions) { return function (object: object, propertyName: string) { registerDecorator({ target: object.constructor, propertyName: propertyName, options: validationOptions, constraints: [], validator: UniqueNameConstraint, }); };}
步骤二：更新Nest.js模块
在 ParkingModule（或任何使用此验证器的模块）中，将 UniqueNameConstraint 添加到 providers 数组，并确保 TypeOrmModule.forFeature([Parking]) 已导入。
import { Module } from '@nestjs/common';import { TypeOrmModule } from '@nestjs/typeorm';import { Parking } from './entities/parking.entity'; // 假设 Parking 实体在这里import { UniqueNameConstraint } from './unique-name.validator'; // 引入自定义验证器@Module({ imports: [ TypeOrmModule.forFeature([Parking]) // 确保为 Parking 实体导入了 TypeORM 功能模块 ], providers: [ UniqueNameConstraint, // 将 UniqueNameConstraint 添加为提供者 // 其他服务或提供者... ], // controllers: [...], // exports: [...],})export class ParkingModule {}
如果你的 Parking 实体是在 AppModule 中直接注册的，那么 AppModule 可能需要类似地配置：
import { Module } from '@nestjs/common';import { TypeOrmModule } from '@nestjs/typeorm';import { Parking } from './entities/parking.entity';import { UniqueNameConstraint } from './unique-name.validator';@Module({ imports: [ TypeOrmModule.forRoot({ type: 'postgres', host: 'database', port: 5432, username: 'postgres', password: 'postgres', database: 'postgres', entities: [Parking], // 直接引用实体类，而不是字符串路径 synchronize: true, }), TypeOrmModule.forFeature([Parking]), // 即使在根模块也需要为实体注册forFeature ], providers: [UniqueNameConstraint],})export class AppModule {}
注意： 在 TypeOrmModule.forRoot 中使用 entities: [Parking] （直接引用类）而不是 entities: [‘dist/**/*.entity{.ts,.js}’] （字符串路径）通常是更好的实践，可以提供更好的类型安全性和开发体验。
原理说明
通过上述修改，UniqueNameConstraint 现在被Nest.js的依赖注入容器所管理。当 class-validator 需要实例化 UniqueNameConstraint 时，Nest.js会介入并负责创建这个实例，并在创建过程中解析其构造函数中的依赖（即 @InjectRepository(Parking)）。这样，parkingRepository 就能被正确地注入一个 TypeORM Repository 实例，从而允许你在自定义验证器中执行数据库查询。
总结与注意事项
依赖注入是关键： 在Nest.js中，任何需要注入其他服务或Repository的类，都必须被Nest.js的DI容器管理。这意味着它通常需要 @Injectable() 装饰器，并作为 providers 注册到模块中。TypeOrmModule.forFeature() 的作用： 这个方法告诉 TypeORM 哪些实体将在当前模块中使用，并为这些实体注册相应的 Repository。它是 @InjectRepository 装饰器能够找到并注入正确 Repository 的前提。模块划分： 建议将自定义验证器放置在与其相关的业务模块中，并在此模块中进行注册。例如，如果 UniqueNameConstraint 是用于 Parking 实体，那么将其注册到 ParkingModule 是一个良好的实践。异步验证： 确保你的 validate 方法是 async 的，并且在其中使用 await 等待数据库操作完成，因为数据库查询是异步的。
遵循这些指导原则，你就可以在Nest.js自定义验证器中成功注入 TypeORM Repository，实现强大的异步验证逻辑。
以上就是Nest.js自定义验证器中TypeORM Repository的正确注入方法的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1534054.html
微信扫一扫 
支付宝扫一扫 
