新闻中心

Nest.js自定义验证器中TypeORM Repository的正确注入方法

2025-10-31
浏览次数:
返回列表

Nest.js自定义验证器中TypeORM Repository的正确注入方法

本文详细介绍了在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<Parking>,
  ) {}

  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'; // 假设使用 GraphQL
import { 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的依赖注入容器识别和管理。这需要进行以下两个关键步骤:

  1. 将验证器类标记为可注入: 使用 @Injectable() 装饰器标记 UniqueNameConstraint 类。
  2. 将验证器注册为模块提供者: 在相应的 Nest.js 模块中,将 UniqueNameConstraint 添加到 providers 数组中。
  3. 为实体导入 TypeORM 功能模块: 确保该模块通过 TypeOrmModule.forFeature() 导入了 Parking 实体。

步骤一:更新自定义验证器类

为 UniqueNameConstraint 添加 @Injectable() 装饰器。

Mureka Mureka

Mureka是昆仑万维最新推出的一款AI音乐创作工具,输入歌词即可生成完整专属歌曲。

Mureka 1091 查看详情 Mureka
import { Injectable } from '@nestjs/common'; // 导入 Injectable
import { 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<Parking>,
  ) {}

  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的正确注入方法的详细内容,更多请关注其它相关文章!


# 自带  # 外贸推广营销产品有哪些  # 铜仁营销推广费用  # seo网站优化软  # 流量优化的网站  # 产品推广营销包括什么方面  # 河北网站建设加推广服务  # 网站后台搜索优化设置  # 郑州优化型网站建设  # 济南谷歌关键词排名是什么  # 宜兴抖音关键词排名  # 回调  # word  # 它是  # 数据库查询  # 并在  # 是在  # 文档  # 如何实现  # 器中  # 自定义  # ai  # app  # js 


相关栏目: 【 科技资讯46185 】 【 网络学院92790


相关推荐: c++如何使用折叠表达式(Fold Expressions)_c++17可变参数模板新技巧  在Runstone环境中高效处理TasteDive API的JSON数据  J*aScript数据结构转换:将对象数组按类别分组  谷歌google账号怎么注册账号 谷歌账号注册官方流程  极兔快递快件信息查询系统 极兔快递官网运单号追踪  内存疯狂猛猛涨价:主板销量直接腰斩!  将HTML动态表格多行数据保存到Google Sheet的教程  使用Python高效删除Word宏并转换DOCM为DOCX格式  Odoo 16:在表单视图中基于当前记录动态修改Tree视图属性  J*a里如何实现订单支付与库存同步功能_支付库存同步项目开发方法说明  Win11怎么查看电脑配置_Win11硬件配置检测工具使用  一加 Nord 5 隐私权限异常_一加 Nord 5 系统安全优化  J*aScript中向JSON对象添加新属性的正确姿势  C++如何进行游戏物理模拟_使用Box2D库为C++游戏添加2D物理效果  CSS自定义字体样式被系统字体替换怎么办_font-face方式指定font-display控制渲染策略  Go语言中JSON数据解析与字段访问教程  腾讯视频怎么举报不良内容_腾讯视频内容举报流程与违规信息处理方法  新三国志曹操传110级星符试炼夏侯渊极难攻略  钉钉视频会议声音异常如何处理 钉钉会议音频修复技巧  Adobe PDF表单中利用J*aScript解析与格式化日期组件的教程  PostgreSQL海量数据高效导入策略:Python与Django实践指南  随机参数递归函数的基准调用次数与时间复杂度探究  Fabric模组开发:自定义物品与物品组的现代管理方法  J*aScript Promise链中如何正确终止后续.then执行并处理错误  NVIDIA股价11月重挫12%:下月有望好转 但难回5万亿美元巅峰  Angular Material 垂直步进器:实现底部到顶部排序的教程  极速漫画官方主页网址 极速漫画漫画在线浏览官网链接  Angular响应式表单:实现提交后表单及按钮的禁用与只读化  qq邮箱日历功能怎么用_创建日程与会议邀请的技巧  PowerPoint如何制作滚动字幕结尾彩蛋_PowerPoint路径动画实现平滑滚动字幕效果  Win11如何使用Windows Sandbox Win11沙盒功能开启与使用教程【详解】  Lar*el如何生成PDF或Excel文件_Lar*el文档导出工具与使用教程  在J*a中如何捕获IndexOutOfBoundsException_索引越界异常防护方法说明  漫画星球免费下拉式入口 漫画星球免费漫画在线阅读网站  Angular中单选按钮的正确使用与常见陷阱解析  css元素hover动画延迟生效怎么办_使用animation-delay调整触发时间  Golang如何使用bytes.Split分割字节切片_Golang bytes切片分割方法  126邮箱账号注册 电脑版登录入口  响应式CSS Grid布局:优化网格项在小屏幕下的堆叠与宽度适配  word中如何让数字纵向排列_Word数字纵向排列方法  J*a最大堆Heapify方法修复:索引计算与边界条件深度解析  J*aScript设计模式实践_j*ascript代码优化  优化MinIO list_objects_v2 操作的性能瓶颈与最佳实践  如何使用spryker/configurable-bundles-products-resource-relationship模块解决复杂产品捆绑关系难题  Mudbox图层蒙版怎么用_Mudbox图层蒙版数字雕刻应用技巧  厨房不锈钢水槽发黑生锈怎么处理_水槽用可乐+锡纸2分钟抛亮如新  离线运行Go语言之旅:本地部署与GOPATH配置指南  提升屏幕阅读器对“m”时间单位的播报准确性:HTML与CSS组合解决方案  sublime如何配置Go语言开发环境_sublime搭建Golang编译运行系统  高德地图公交到站提醒失败如何解决 高德提醒权限设置 

搜索