如何检测请求中存在对应DTO未定义的查询参数？

这个问题在TypeScript后端开发（尤其是用NestJS这类框架）里挺常见的，我给你几个实用的解决办法：

1. 利用框架自带的验证管道（推荐，以NestJS为例） #

如果你用的是NestJS，结合class-validator和class-transformer的配置就能轻松实现——不仅能过滤多余参数，还能直接抛出错误提示。

步骤： #

首先给你的DTO加上基础验证装饰器：

import { IsString } from 'class-validator';

export class GetCustomersQueryDTO {
  @IsString()
  readonly firstName: string;

  @IsString()
  readonly lastName: string;
}

然后在全局或模块级别配置ValidationPipe，开启forbidNonWhitelisted选项：

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe({
    whitelist: true, // 自动过滤DTO中未定义的属性
    forbidNonWhitelisted: true, // 遇到未定义参数时直接抛出400错误
    transform: true, // 自动将查询参数转换为DTO实例
  }));
  await app.listen(3000);
}
bootstrap();

当请求/customers?name=jon时，会返回清晰的错误响应：

{"statusCode":400,"message":["property name should not exist"],"error":"Bad Request"}

2. 手动对比查询参数与DTO属性 #

如果需要自定义错误逻辑或者不用框架的验证管道，可以手动获取原始查询参数，和DTO的属性列表做对比。

以NestJS控制器为例：

import { Controller, Get, Query, BadRequestException, createParamDecorator, ExecutionContext } from '@nestjs/common';
import { GetCustomersQueryDTO } from './dto/get-customers-query.dto';

// 自定义装饰器获取原始查询参数
export const RawQuery = createParamDecorator(
  (_: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request.query;
  },
);

@Controller('customers')
export class CustomersController {
  @Get()
  getCustomers(
    @Query() _validatedQuery: GetCustomersQueryDTO,
    @RawQuery() rawQuery: Record<string, any>
  ) {
    // 获取DTO的所有属性键
    const allowedParams = Object.keys(new GetCustomersQueryDTO());
    // 找出不在允许列表中的参数
    const extraParams = Object.keys(rawQuery).filter(key => !allowedParams.includes(key));

    if (extraParams.length > 0) {
      throw new BadRequestException(`不允许的查询参数：${extraParams.join(', ')}`);
    }

    // 后续业务逻辑...
    return { message: '查询参数验证通过' };
  }
}

3. 通用TypeScript反射方案（不依赖框架） #

如果是在非框架场景下，可以用reflect-metadata库通过反射获取DTO的属性列表，再和查询参数对比。

步骤： #

1. 安装依赖：

npm install reflect-metadata

2. 在tsconfig.json中启用装饰器元数据：

{
  "compilerOptions": {
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true
  }
}

3. 编写检查函数：

import 'reflect-metadata';

export function detectExtraParams<T>(dtoClass: new () => T, query: Record<string, any>): string[] {
  // 获取DTO的属性列表
  const dtoProperties = Object.keys(new dtoClass());
  const queryParams = Object.keys(query);
  
  return queryParams.filter(param => !dtoProperties.includes(param));
}

// 使用示例
const incomingQuery = { firstName: 'Jon', name: 'Jon' };
const extraParams = detectExtraParams(GetCustomersQueryDTO, incomingQuery);

if (extraParams.length > 0) {
  console.error(`发现未定义的查询参数：${extraParams.join(', ')}`);
}

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