NestJS中class-validator实现多类型Period字段验证问题

错误原因分析 #

你之前的验证逻辑存在两个核心问题：

1. @Min()/@Max()是用于数值类型的验证装饰器，但你的period字段定义为string类型，传入字符串形式的数字时会触发类型不匹配的错误。
2. @IsEnum(Object.keys(PeriodEnum))仅允许枚举中定义的"trial"和"lifetime"字符串值，完全排除了数字字符串的情况；且正则拼接时错误使用数组直接转字符串，生成了逗号分隔的无效正则分组。

方案一：自定义验证器（推荐，灵活易维护） #

自定义验证器可以清晰处理"枚举值或1-24数字字符串"的或逻辑，步骤如下：

1. 创建自定义验证器类

import { ValidatorConstraint, ValidatorConstraintInterface } from 'class-validator';
import { PeriodEnum } from './your-enum-file-path';

@ValidatorConstraint({ name: 'periodValidator', async: false })
export class PeriodValidator implements ValidatorConstraintInterface {
  validate(value: string): boolean {
    // 优先检查是否为枚举有效值
    if (Object.values(PeriodEnum).includes(value)) {
      return true;
    }
    // 检查是否为1-24的数字字符串
    const numValue = parseInt(value, 10);
    return !isNaN(numValue) && numValue >= 1 && numValue <= 24;
  }

  defaultMessage(): string {
    return 'period 必须是 "trial"、"lifetime" 或 1-24之间的数字字符串';
  }
}

2. 在DTO中使用验证器

import { IsNotEmpty, Validate } from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
import { PeriodEnum } from './your-enum-file-path';
import { PeriodValidator } from './period.validator';

export class YourDto {
  @IsNotEmpty()            
  @ApiProperty(CustomersConfigSwagger.API_PROP_REF_PERIOD)
  @Validate(PeriodValidator)
  period: string;
}

方案二：动态生成正则验证 #

如果偏好简洁的正则方案，需要正确拼接枚举值生成包含所有合法情况的正则：

import { IsNotEmpty, Matches } from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
import { PeriodEnum } from './your-enum-file-path';

// 动态生成正则：枚举值 | 1-9 | 10-19 | 20-24
const periodValidRegex = new RegExp(
  `^(${Object.values(PeriodEnum).join('|')}|[1-9]|1[0-9]|2[0-4])$`
);

export class YourDto {
  @IsNotEmpty()            
  @ApiProperty(CustomersConfigSwagger.API_PROP_REF_PERIOD)
  @Matches(periodValidRegex, {
    message: 'period 必须是 "trial"、"lifetime" 或 1-24之间的数字字符串'
  })
  period: string;
}

注意事项 #

• 确保period字段接收的是字符串类型（如果前端传入数值，需要在接口层转换为字符串，或者将字段定义为string | number并调整验证逻辑）。
• 若后续枚举值有变更，自定义验证器只需维护枚举，正则方案会自动同步枚举值，无需额外修改正则内容。

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