如何使用 Nestjs 验证枚举值数组答案

【问题标题】：How can I validate an array of enum values with Nestjs如何使用 Nestjs 验证枚举值数组
【发布时间】：2020-12-05 04:48:55
【问题描述】：

我觉得 this thread 和 this thread 的组合是我需要实现的，我无法将它们组合在一起。

我有一个包含 enum 的 DTO。

使用 Postman，我正在发送 FOO 的 PurchasableType 并期望得到某种错误。阅读上述链接，似乎过程相当复杂；这让我觉得我完全没有抓住重点。

如何使用验证管道确保只允许 purchasable-type.enum.ts 中的值？

感谢您的任何建议！

// create-order.dto.ts

import { IsEmail, IsNotEmpty, IsEnum } from 'class-validator';
import { PurchasableType } from '../enum/purchaseable-type.enum';

export class CreateOrderDto {
  @IsNotEmpty()
  readonly userId: string;

  @IsNotEmpty()
  readonly locationId: string;

  @IsNotEmpty()
  @IsEnum(PurchasableType)
  readonly purchasableType: PurchasableType;

  @IsNotEmpty()
  @IsEmail()
  readonly email: string;
}

// purchasable-type.enum.ts

export enum PurchasableType {
  CLINIC = 'CLINIC',
  EVENT = 'EVENT',
  LESSON = 'LESSON',
  RESERVATION = 'RESERVATION',
  TEAM = 'TEAM',
}

编辑

看来我也没有正确定义实体，这可能是主要问题。我仍然很好奇我的实现是好是坏。

// order.entity.ts

...
import { PurchasableType } from '../enum/purchaseable-type.enum';

@Entity()
export class Order extends BaseEntity {
  @PrimaryGeneratedColumn()
  id: number;

@Column({
    type: 'enum',
    enum: PurchasableType,
  })

现在，当我发送 purchasableType 或 foo 时，我收到 500 错误。如果我发送 enum 内的任何有效值，我将得到 200/201。

编辑 2

当然 - 这是我所拥有的更广泛的看法。似乎一切正常，我只是想更好地了解实际发生的情况。

// event.controller.ts

@Post('/:id/orders')
  async purchaseEventTickets(@Body() createOrderDto: CreateOrderDto): 
    Promise<Order> {
    return await this.eventService.purchaseEventTickets(createOrderDto);
  }

// create-order.dto.ts

export class CreateOrderDto {
    @IsNotEmpty()
    @IsEnum(PurchasableType)
    readonly purchasableType: PurchasableType;
}

// event.service.ts

async purchaseEventTickets(createOrderDto: CreateOrderDto): Promise<Order> {
    ...
    return await this.orderRepository.createOrder(createOrderDto);
}

// order.repository.ts

async createOrder(createOrderDto: CreateOrderDto): Promise<Order> {
    const { purchasableType } = createOrderDto;

    const order = this.create();

    order.purchasableType = purchasableType;

    try {
        await order.save();
    } catch (error) {
        this.logger.error(`Failed to create the order: ${error.stack}`);

        throw new InternalServerErrorException();
    }

    return order;
}

使用 Postman，如果我将“Foo”的无效值作为 PurchasableType 发送，我会收到预期的错误。

【问题讨论】：

您能否向我们提供更多关于您使用验证管道的方式的信息？对我来说，500 错误似乎是由 ORM 引发的，而不是验证管道，我猜这不是你所期望的
当然！我已经更新了我的问题。我希望我提供了更多信息。感谢您抽出宝贵时间提供帮助！

标签： nestjs dto

【解决方案1】：

  @IsArray()
  @IsEnum(enum, { each: true })
  prop: enum[]

【讨论】：

【解决方案2】：

我花了一段时间才找到一个好的解决方案。

@ApiProperty({
  description: 'List of enums',
  isArray: true,
  enum: MyEnum
})
@IsEnum(MyEnum, { each: true })
prop: MyEnum[];

【讨论】：

@ApiProperty 是从哪里导入的？
@KaranKumar 好问题，这是我用来创建 swagger 文档的 swagger(openapi) 装饰器。因为这个问题不相关，但它可能对那些使用 openapi 的人有用。

【解决方案3】：

这是您的 create-dto 包含 enum 的样子。

// create-order.dto.ts

import { IsEmail, IsNotEmpty, IsEnum } from 'class-validator';
import { PurchasableType } from '../enum/purchaseable-type.enum';

export class CreateOrderDto {

    ...

    @IsNotEmpty()
    @IsEnum(PurchasableType)
    readonly purchasableType: PurchasableType;
}

这是枚举文件的样子：

// purchasable-type.enum.ts

export enum PurchasableType {
  CLINIC = 'CLINIC',
  EVENT = 'EVENT',
  LESSON = 'LESSON',
  RESERVATION = 'RESERVATION',
  TEAM = 'TEAM',
}

从那里我可以自信地期望枚举的值是上述值之一。如果通过了其他值，nest 将抛出验证错误。

此外，如果您尝试使用嵌套对象（或具有多个属性或数组的对象），您可以在 DTO 中执行以下操作：

import { PurchasableType } from '../interface/purchasable-type.interface';
...

@ApiProperty()
@IsArray()
@ArrayMinSize(7)
@ArrayMaxSize(7)
@ValidateNested({ each: true })
@Type(() => PurchasableType)
@IsNotEmpty()
readonly PurchasableType: PurchasableType[];

...

【讨论】：