NestJS Get接口自定义Pipe获取Query值为空问题求助

问题根源 #

1. ValidationPipe的whitelist过滤：你全局注册了开启whitelist: true的ValidationPipe，如果控制器方法没有通过@Query()装饰器接收查询参数，也没有定义对应的DTO声明允许的字段，ValidationPipe会自动过滤掉所有未声明的查询参数，导致后续FilterStringPipe拿到的value是空对象。
2. 正则生成逻辑错误：当前Pipe中把字段名（比如username）作为正则匹配内容，而不是用户传入的实际参数值，这会导致MongoDB查询逻辑完全不符合预期。

解决方案 #

1. 确保控制器正确接收查询参数 #

在Get接口方法中必须用@Query()装饰器接收参数，推荐定义DTO来声明允许的字段，避免ValidationPipe误过滤：

定义查询DTO

// src/users/dto/user-filter.dto.ts
export class UserFilterDto {
  roles?: string;
  name?: string;
  username?: string;
  email?: string;
}

在控制器中使用DTO

@Get('/api/v1/users/admin/list')
getAdminUsers(@Query() filter: UserFilterDto) {
  // 处理后的参数可直接用于MongoDB查询
  return this.userService.find(filter);
}

如果不想定义DTO，至少要显式用@Query()接收参数：

@Get('/api/v1/users/admin/list')
getAdminUsers(@Query() filter: any) {
  return this.userService.find(filter);
}

2. 修复FilterStringPipe的正则转换逻辑 #

修改Pipe代码，使用用户传入的参数值生成正则表达式，而不是字段名：

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

const targetKeys = ['name', 'username', 'email'];

@Injectable()
export class FilterStringPipe implements PipeTransform {
  transform(value: any, metadata: ArgumentMetadata) {
    const { type } = metadata;

    // 非query类型或无参数时直接返回
    if (type !== 'query' || !value) return value;

    // 遍历参数，转换指定字段为MongoDB正则格式
    for (const key of Object.keys(value)) {
      if (targetKeys.includes(key) && typeof value[key] === 'string') {
        value[key] = { $regex: new RegExp(value[key], 'i') };
      }
    }

    return value;
  }
}

3. 验证效果 #

当请求{{baseUrl}}/api/v1/users/admin/list?roles=ADMIN&username=super时，经过Pipe处理后，最终传递给控制器的参数会变成：

{
  roles: 'ADMIN',
  username: { $regex: /super/, $options: 'i' }
}

可以直接作为MongoDB的查询条件使用。

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