NestJS中DTO@Transform默认值未生效问题排查

问题背景 #

我创建了一个接收POST请求的NestJS控制器，其中sort和contentType为可选参数，希望通过DTO的@Transform装饰器设置默认值（sort默认{date: -1}，contentType默认'json'）。但当请求未传入这两个参数时，服务中获取到的这两个值均为undefined，不符合预期。

我的配置与代码 #

1. Main.ts配置

const app = await NestFactory.create(AppModule);
// ...其他配置
app.useGlobalPipes(
  new ValidationPipe({
    transform: true,
    transformOptions: { enableImplicitConversion: true },
    whitelist: true,
  }),
);

2. DTO定义

export class ListDto {
  // ...其他字段
  
  @IsObject()
  @IsOptional()
  @Transform(({ value }) => value ?? { date: -1 })
  sort?: Record<string, SortOrder>; // 类型已提前定义，此处省略
            
  @IsString()
  @IsOptional()
  @IsIn(['json', 'xlsx', 'csv'], {
    message: 'contentType must be one of: json, xlsx, csv',
  })
  @Transform(({ value }) => value ?? 'json')
  contentType?: Extension;
} 

3. 控制器代码

@Post('list')
async list(@Body() list: ListDto): Promise<any> {
  try {
    console.log(list.sort) // 期望得到装饰器中定义的默认值，但实际是undefined
    console.log(list.contentType) // 期望得到装饰器中定义的默认值，但实际是undefined
    return await this.someService.list(list);
  } catch (error) {
    // ...错误处理
  }
}

4. 请求体

{
  "param1" : "Some value",
  "param2" : "Some other"
  // 未传入sort或contentType
}

5. 服务方法

async list({
  // ...其他参数
  sort,
  contentType,
}: ListDto): Promise<List> {
  console.log(contentType) // 期望看到装饰器中的默认值，但实际是undefined
  console.log(sort) // 期望看到装饰器中的默认值，但实际是undefined
  // ...业务逻辑实现
}

问题原因 #

当请求体中完全不存在某个可选字段时，class-validator的@Transform装饰器不会被触发——因为该字段根本没进入转换流程。你当前的@Transform只在字段存在但值为null/undefined时生效，完全缺省的场景覆盖不到。

解决方案 #

方案1：使用class-transformer的@Default装饰器（推荐） #

class-transformer提供了专门的@Default装饰器，用来处理字段未提供时的默认值，和@Transform配合可以覆盖“字段缺省”和“字段值为空”两种场景。修改DTO如下：

import { Default } from 'class-transformer'; // 导入装饰器

export class ListDto {
  // ...其他字段
  
  @IsObject()
  @IsOptional()
  @Default({ date: -1 }) // 添加入口默认值
  @Transform(({ value }) => value ?? { date: -1 }) // 兜底处理字段值为null的情况
  sort?: Record<string, SortOrder>;
            
  @IsString()
  @IsOptional()
  @IsIn(['json', 'xlsx', 'csv'], {
    message: 'contentType must be one of: json, xlsx, csv',
  })
  @Default('json') // 添加入口默认值
  @Transform(({ value }) => value ?? 'json') // 兜底处理字段值为null的情况
  contentType?: Extension;
}

注意：确保你的ValidationPipe配置中transform: true已开启（你当前的配置已经满足），这样class-transformer的装饰器才能正常工作。

方案2：在DTO构造函数中初始化默认值 #

如果不想额外引入@Default，也可以在DTO的构造函数里直接设置默认值：

export class ListDto {
  // ...其他字段
  
  @IsObject()
  @IsOptional()
  @Transform(({ value }) => value ?? { date: -1 })
  sort?: Record<string, SortOrder>;
            
  @IsString()
  @IsOptional()
  @IsIn(['json', 'xlsx', 'csv'], {
    message: 'contentType must be one of: json, xlsx, csv',
  })
  @Transform(({ value }) => value ?? 'json')
  contentType?: Extension;

  constructor() {
    this.sort = { date: -1 };
    this.contentType = 'json';
  }
}

这种方式要注意：如果请求体中传入了null或者空值，需要保留@Transform来兜底，否则会覆盖构造函数设置的默认值。

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