如何用class-validation将单条目查询字符串转换为数组？

我有一个可正常运行的查询字符串：

http://127.0.0.1:1000/api/cars/4?include=ford

但后续逻辑执行失败，因为我期望include参数是数组类型。请问如何用class-validation配合转换，让单个条目时自动转为数组？

相关代码如下：

export declare enum CarManuf {
  Ford = "ford",
  Chevy = "chevy",
  Honda = "honda"
}

export class CarsGetApiDto {
  //@Transform((value) => (Array.isArray(value)? value : [value]), { toClassOnly: true })
  @IsOptional()
  @IsEnum(CarManuf, { each: true })
  include?: CarManuf[];
  
  ...
}

启用注释里的@Transform装饰器后，会收到错误提示：

include中的每个值必须是以下值之一：ford, chevy, honda

解决方案 #

问题根源在于验证与转换的执行顺序：class-validation默认会优先执行校验逻辑，此时单个字符串类型的include还没被转为数组，直接触发IsEnum({ each: true })的校验错误。

调整装饰器顺序并修正转换逻辑即可解决：

import { Transform } from 'class-transformer';
import { IsOptional, IsEnum } from 'class-validator';

export declare enum CarManuf {
  Ford = "ford",
  Chevy = "chevy",
  Honda = "honda"
}

export class CarsGetApiDto {
  // 先执行转换，将单个值转为数组
  @Transform(({ value }) => Array.isArray(value) ? value : [value], { toClassOnly: true })
  @IsOptional()
  // 此时校验的是数组中的每个元素
  @IsEnum(CarManuf, { each: true })
  include?: CarManuf[];
  
  ...
}

额外注意事项 #

1. 确保项目已正确配置class-transformer的自动转换：比如在NestJS中，需要在ValidationPipe里开启transform: true，这样请求参数会先被转换为DTO实例，再执行验证。
2. 如果转换仍不生效，可以尝试调整Transform的配置选项，比如将toClassOnly改为toPlainOnly: false，确保转换逻辑在类实例化阶段执行。

内容的提问来源于stack exchange，提问作者Gina Marano