使用nest.js控制器中的class-validator验证嵌套对象

Usa*_*hir 3 javascript node.js typescript class-validator nestjs

我想在nest.js控制器中使用class-validator验证身体有效载荷。我的currency.dto.ts文件是这样的:

import {
  IsNotEmpty,
  IsString,
  ValidateNested,
  IsNumber,
  IsDefined,
} from 'class-validator';

class Data {

  @IsNotEmpty()
  @IsString()
  type: string;

  @IsNotEmpty()
  @IsNumber()
  id: number;
}

export class CurrencyDTO {
  @ValidateNested({ each: true })
  @IsDefined()
  data: Data[];
}
Run Code Online (Sandbox Code Playgroud)

在我的nest.js控制器中,我像这样使用它。

  @Post()
  @UseGuards(new AuthTokenGuard())
  @UsePipes(new ValidationPipe())
  addNewCurrency(@Req() req, @Body() data: CurrencyDTO) {
    console.log('data', data);
  }
Run Code Online (Sandbox Code Playgroud)

我的验证管道类是这样的:

import {
  PipeTransform,
  Injectable,
  ArgumentMetadata,
  BadRequestException,
  HttpException,
  HttpStatus,
} from '@nestjs/common';
import { validate, IsInstance } from 'class-validator';
import { plainToClass, Exclude } from 'class-transformer';

@Injectable()
export class ValidationPipe implements PipeTransform<any> {
  async transform(value: any, metadata: ArgumentMetadata) {
    if (value instanceof Object && this.isEmpty(value)) {
      throw new HttpException(
        `Validation failed: No Body provided`,
        HttpStatus.BAD_REQUEST,
      );
    }
    const { metatype } = metadata;
    if (!metatype || !this.toValidate(metatype)) {
      return value;
    }
    const object = plainToClass(metatype, value);
    const errorsList = await validate(object);
    if (errorsList.length > 0) {
      const errors = [];
      for (const error of errorsList) {
        const errorsObject = error.constraints;
        const { isNotEmpty } = errorsObject;
        if (isNotEmpty) {
          const parameter = isNotEmpty.split(' ')[0];
          errors.push({
            title: `The ${parameter} parameter is required.`,
            parameter: `${parameter}`,
          });
        }
      }
      if (errors.length > 0) {
        throw new HttpException({ errors }, HttpStatus.BAD_REQUEST);
      }
    }
    return value;
  }

  private toValidate(metatype): boolean {
    const types = [String, Boolean, Number, Array, Object];
    return !types.find(type => metatype === type);
  }
  private isEmpty(value: any) {
    if (Object.keys(value).length > 0) {
      return false;
    }
    return true;
  }
}
Run Code Online (Sandbox Code Playgroud)

该验证管道对除嵌套对象以外的所有对象都适用。知道我在做什么错吗?我的身体有效载荷是这样的:

{
"data": [{
    "id": 1,
    "type": "a"
}]
}
Run Code Online (Sandbox Code Playgroud)

Kim*_*ern 8

尝试使用指定嵌套类型@Type

import { Type } from 'class-transformer';

export class CurrencyDTO {
  @ValidateNested({ each: true })
  @Type(() => Data)
  data: Data[];
}
Run Code Online (Sandbox Code Playgroud)

对于要验证的嵌套类型,它必须是类的实例,而不仅仅是普通数据对象。使用@Type装饰器,您可以告诉class-transformer在plainToClass中调用给定属性时实例化一个类VaildationPipe

如果您使用内置功能,请ValidationPipe确保已设置选项transform: true

  • 出于任何原因,此解决方案对我不起作用。我按照你说的做了,没有用。 (2认同)
  • 我想补充一点。该类验证器不需要此 \@Type 注释。这就是 Nestjs 的工作原理。它始终在 DTO 上使用类转换器,并且类转换器需要 \@Type 注释。 (2认同)
  • @LeonardoEmilioDominguez 尝试将两个类放在同一个文件中,并确保嵌套类首先出现(应该在顶部),顺序很重要。正如您所看到的,数据出现在问题中的 DataDTO 之前。 (2认同)

Xen*_*mar 8

至少就我而言,接受的答案需要更多信息。事实上,如果data请求中不存在密钥,则验证将不会运行。要获得完整的验证,请尝试:

@IsDefined()
@IsNotEmptyObject()
@ValidateNested()
@Type(() => CreateOrganizationDto)
@ApiProperty()
organization: CreateOrganizationDto;
Run Code Online (Sandbox Code Playgroud)