具有嵌套对象数组的类验证器

时间:2020-02-21 08:37:12

标签: typescript nestjs dto class-validator

我正在尝试验证nestjs中的嵌套对象数组,并且工作正常。但是,如果我发送字符串或null之类的非数组值,则会收到错误消息:

TypeError: Cannot read property 'length' of undefined.

嵌套字段:

@IsArray()
@ValidateNested({ each: true })
@Type(() => NestedDTO)
nested: NestedDTO[];

在验证嵌套对象之前,如何验证值是一个数组?

版本:

NestJS: 6.10.14
class-validator: 0.11.0

1 个答案:

答案 0 :(得分:0)

到目前为止,NestJS 中对对象数组验证的开箱即用支持很少。

请看看我的解决方案:

重点是编写并使用您的自定义 IsArrayOfObjects 装饰器,该装饰器将包含来自 @Type 模块的验证逻辑 + class-transformer 装饰器。

import { Type } from 'class-transformer';
import {
  IsString,
  registerDecorator,
  ValidateNested,
  ValidationArguments,
  ValidationOptions,
} from 'class-validator';

export function IsArrayOfObjects(validationOptions?: ValidationOptions) {
  return (object: unknown, propertyName: string) => {
    registerDecorator({
      name: 'IsArrayOfObjects',
      target: object.constructor,
      propertyName,
      constraints: [],
      options: validationOptions,
      validator: {
        validate(value: any): boolean {
          return (
            Array.isArray(value) &&
            value.every(
              (element: any) =>
                element instanceof Object && !(element instanceof Array),
            )
          );
        },
        defaultMessage: (validationArguments?: ValidationArguments): string =>
          `${validationArguments.property} must be an array of objects`,
      },
    });
  };
}

假设我们有这个 NestedDTO

export class NestedDTO {
  @IsString()
  someProperty: string;
}

然后我们可以简单地用它来定义like:

@IsArrayOfObjects()
@ValidateNested()
@Type(() => NestedDTO)
nested: NestedDTO[];

但是,此解决方案将允许传递空数组。然后您可以在 IsArrayOfObjects 中添加额外的条件,例如 value.length > 0 并更正其 defaultMessage