如何在Nest.js中为@Query绑定的类设置默认参数？

问题原因 #

默认值不生效是因为Nest默认解析@Query参数时，仅会将请求携带的查询参数映射为普通对象属性，没有传入的字段会保持undefined，不会自动执行你在CreateContextQuery类中定义的构造函数默认赋值逻辑。

常用修复方案 #

方案1：官方推荐类转换方案（适配Swagger+参数校验场景） #

适合已经使用class-validator做参数校验、用Swagger生成接口文档的场景：

1. 先安装必要依赖：
   npm install class-validator class-transformer
2. 开启ValidationPipe的转换配置，可选择全局生效或单路由生效：

全局生效（推荐，所有路由通用）

在main.ts入口文件添加配置：

import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe({
    transform: true, // 开启自动转换为类实例，应用默认值
    transformOptions: {
      enableImplicitConversion: true, // 自动转换参数类型
    }
  }));
  await app.listen(3000);
}
bootstrap();

单路由生效（仅当前接口生效）

直接修改控制器的@Query装饰器即可：

@Query(new ValidationPipe({ transform: true, transformOptions: { enableImplicitConversion: true } })) 
contextQuery: CreateContextQuery,

3. 修改context.query.ts类定义，直接在属性上声明默认值：

import { ApiProperty } from '@nestjs/swagger';
import { IsOptional, IsInt, IsBoolean } from 'class-validator';

export class CreateContextQuery {
  @ApiProperty({
    description: 'Maximum number of nodes to show on the graph',
    default: 3
  })
  @IsOptional()
  @IsInt()
  maxnodes = 3;

  @ApiProperty({
    description: 'Include graph statistics',
    default: false
  })
  @IsOptional()
  @IsBoolean()
  addstats = false;
}

方案2：控制器层解构赋值（极简方案，无额外依赖） #

如果不想引入额外校验转换逻辑，直接在使用参数时解构赋值默认值即可，仅修改控制器代码：

@Post('graph')
public async createGraphForContext(
  @Body('context') contextData: CreateContextDto,
  @Query() contextQuery: CreateContextQuery,
) {
  const before = Date.now();
  const { context } = await this.contextService.createContext(contextData);
  // 解构时直接赋值默认值，同时做类型转换避免字符串参数识别错误
  const { maxnodes = 3, addstats = false } = contextQuery;
  const graph = await this.contextService.getGraphOfContext(
    context.id,
    Number(maxnodes),
    Boolean(addstats)
  );
}

注意事项 #

所有查询参数默认都是字符串类型，比如请求传addstats=false时初始值是字符串'false'，直接当作布尔值使用会被判定为真值，一定要提前做类型转换。

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