NestJS中@Query DTO的@Transform()未触发问题求助

我有一个带有可选查询参数的接口，尝试使用class-transformer的@Transform()为未传入的参数填充默认值，但该管道从未被触发，未传参的字段值始终为空。

控制器代码 #

@Get()
async findAll(
  @Query() query: ActivitiesListPATRequestDto
) {
  // ...业务逻辑
  return data;
}

DTO代码 #

export class ActivitiesListPATRequestDto extends PaginatedListRequestDto {
  @ApiPropertyOptional({ required: false, default: 'now', format: 'ISO8601' })
  @Transform(
    ({ value }: { value?: string }): string => value ?? new Date().toISOString()
  )
  @IsDateString()
  @IsOptional()
  from: string;

  @ApiPropertyOptional({
    required: false,
    default: '30 days from now',
    format: 'ISO8601',
  })
  @Transform(
    ({
      value,
      obj,
    }: {
      value?: string;
      obj: ActivitiesListPATRequestDto;
    }): string =>
      value ??
      new Date(
        new Date(obj.from).getTime() + 30 * 24 * 60 * 60 * 1000
      ).toISOString()
  )
  @IsDateString()
  @IsOptional()
  to: string;
}

全局配置 #

app.useGlobalPipes(
  new ValidationPipe({
    whitelist: true,
    transform: true,
    transformOptions: { enableImplicitConversion: true },
    forbidNonWhitelisted: true,
  })
);

已尝试的方案 #

• 用@UseInterceptors(ClassSerializerInterceptor)装饰控制器
• 用@UseInterceptors(new TransformInterceptor(ActivitiesListPATRequestDto ))装饰控制器
• 将from和to的类型从string改为Date
• 将from和to设为必填属性

解决方案 #

问题根源 #

当查询参数未传入时，该字段不会出现在原始的query对象中，class-transformer的@Transform()仅会处理原始对象中存在的字段，因此不会触发转换逻辑。

方案一：给DTO字段设置初始默认值 #

在类定义中直接为字段设置初始值，结合@Transform()处理传入的参数：

export class ActivitiesListPATRequestDto extends PaginatedListRequestDto {
  @ApiPropertyOptional({ required: false, default: 'now', format: 'ISO8601' })
  @Transform(({ value }) => value || new Date().toISOString())
  @IsDateString()
  @IsOptional()
  from: string = new Date().toISOString(); // 初始默认值

  @ApiPropertyOptional({
    required: false,
    default: '30 days from now',
    format: 'ISO8601',
  })
  @Transform(({ value, obj }) => {
    if (value) return value;
    return new Date(new Date(obj.from).getTime() + 30 * 24 * 60 * 60 * 1000).toISOString();
  })
  @IsDateString()
  @IsOptional()
  to: string = new Date(new Date().getTime() + 30 * 24 * 60 * 60 * 1000).toISOString(); // 初始默认值
}

当参数未传入时，类实例会使用初始值；若传入参数，@Transform()会覆盖初始值。

方案二：使用@Expose()配合transform选项 #

通过@Expose()的transform函数确保字段不存在时也能被处理：

import { Expose } from 'class-transformer';

export class ActivitiesListPATRequestDto extends PaginatedListRequestDto {
  @ApiPropertyOptional({ required: false, default: 'now', format: 'ISO8601' })
  @Expose({
    transform: ({ value }) => value ?? new Date().toISOString()
  })
  @IsDateString()
  @IsOptional()
  from: string;

  @ApiPropertyOptional({
    required: false,
    default: '30 days from now',
    format: 'ISO8601',
  })
  @Expose({
    transform: ({ value, obj }) => 
      value ?? new Date(new Date(obj.from).getTime() + 30 * 24 * 60 * 60 * 1000).toISOString()
  })
  @IsDateString()
  @IsOptional()
  to: string;
}

需确保ValidationPipe的transformOptions中excludeExtraneousValues为true（已开启whitelist时默认生效）。

方案三：自定义管道处理默认值 #

若上述方案无效，可自定义管道直接处理查询参数：

import { PipeTransform, Injectable, ArgumentMetadata } from '@nestjs/common';

@Injectable()
export class DefaultQueryPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    // 填充from的默认值
    if (!value.from) {
      value.from = new Date().toISOString();
    }
    // 基于from填充to的默认值
    if (!value.to) {
      value.to = new Date(new Date(value.from).getTime() + 30 * 24 * 60 * 60 * 1000).toISOString();
    }
    return value;
  }
}

在控制器中使用该管道：

@Get()
async findAll(
  @Query(DefaultQueryPipe) query: ActivitiesListPATRequestDto
) {
  // ...业务逻辑
  return data;
}

内容的提问来源于stack exchange，提问作者Jakub Gańczorz