如何获取Query原始值而非解析值？NestJS查询参数布尔值问题

问题场景 #

我在NestJS控制器中实现了支持分页与筛选的查询方法，代码如下：

@Get()
findAll(
      @Query('skip') skip: string,
      @Query('take') take: string,
      @Query('sortBy') sortBy: string,
      @Query('content') content: string,
      @Query('isCorrect') isCorrect?: boolean | null,
) {
  console.log(isCorrect, typeof isCorrect); // 跳过isCorrect参数时，输出false（boolean类型）
  const filters: AnswerFilters = { content, isCorrect };
  return this.answersService.offsetPaginate(Number(skip), Number(take), sortBy, filters);
}

问题在于：传入true或false时结果正常，但跳过isCorrect参数时，该参数被自动解析为false，而我需要用null来跳过该字段的筛选。

解决方案 #

方法一：手动处理参数类型转换 #

将参数类型声明为string | boolean | null，在方法内手动处理未传入的情况：

@Get()
findAll(
      @Query('skip') skip: string,
      @Query('take') take: string,
      @Query('sortBy') sortBy: string,
      @Query('content') content: string,
      @Query('isCorrect') isCorrect?: string | boolean | null,
) {
  // 处理参数：未传入则设为null，字符串类型转为布尔值
  const parsedIsCorrect = isCorrect === undefined 
    ? null 
    : typeof isCorrect === 'string' 
      ? isCorrect.toLowerCase() === 'true' 
      : isCorrect;

  const filters: AnswerFilters = { content, isCorrect: parsedIsCorrect };
  return this.answersService.offsetPaginate(Number(skip), Number(take), sortBy, filters);
}

方法二：自定义参数处理管道 #

创建一个专门处理布尔类型参数的管道，支持未传入时返回null：

// boolean-nullable.pipe.ts
import { PipeTransform, Injectable, BadRequestException } from '@nestjs/common';

@Injectable()
export class BooleanNullablePipe implements PipeTransform {
  transform(value: any): boolean | null {
    // 参数未传入时返回null
    if (value === undefined) {
      return null;
    }
    // 已经是布尔值直接返回
    if (typeof value === 'boolean') {
      return value;
    }
    // 字符串类型转为布尔值
    const lowerValue = value.toLowerCase();
    if (lowerValue === 'true') {
      return true;
    }
    if (lowerValue === 'false') {
      return false;
    }
    // 非法参数抛出异常
    throw new BadRequestException('isCorrect参数必须是true或false');
  }
}

在控制器中使用该管道：

@Get()
findAll(
      @Query('skip') skip: string,
      @Query('take') take: string,
      @Query('sortBy') sortBy: string,
      @Query('content') content: string,
      @Query('isCorrect', BooleanNullablePipe) isCorrect?: boolean | null,
) {
  const filters: AnswerFilters = { content, isCorrect };
  return this.answersService.offsetPaginate(Number(skip), Number(take), sortBy, filters);
}

方法三：全局禁用隐式类型转换 #

在全局ValidationPipe配置中关闭布尔值的隐式转换，使未传入的参数保持undefined，再手动转为null：

// 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: false,
    },
  }));
  await app.listen(3000);
}
bootstrap();

然后在控制器方法中处理参数：

@Get()
findAll(
      @Query('skip') skip: string,
      @Query('take') take: string,
      @Query('sortBy') sortBy: string,
      @Query('content') content: string,
      @Query('isCorrect') isCorrect?: boolean | undefined,
) {
  const parsedIsCorrect = isCorrect === undefined ? null : isCorrect;
  const filters: AnswerFilters = { content, isCorrect: parsedIsCorrect };
  return this.answersService.offsetPaginate(Number(skip), Number(take), sortBy, filters);
}

问题原因 #

NestJS默认启用的ValidationPipe（当transform: true时）会对布尔类型参数进行隐式转换，根据JavaScript的类型转换规则，undefined会被转为false，导致未传入参数时得到的是false而非预期的null。通过上述方法可以干预参数转换逻辑，实现未传入时返回null的需求。

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