如何使用NestJS正确解析查询参数？

针对你遇到的查询参数中JSON格式数组无法自动解析为实际数组的问题，以下是几种NestJS的标准解决方法：

方案一：自定义JSON解析管道（Pipe） #

NestJS的管道可以实现参数的转换与验证，这是框架推荐的处理方式。

1. 实现自定义管道 #

创建一个JsonParsePipe来解析JSON格式的字符串参数：

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

@Injectable()
export class JsonParsePipe implements PipeTransform {
  transform(value: any) {
    // 非字符串直接返回
    if (typeof value !== 'string') {
      return value;
    }
    try {
      return JSON.parse(value);
    } catch (error) {
      throw new BadRequestException('参数格式无效，请传入合法的JSON字符串');
    }
  }
}

2. 在控制器中使用管道 #

可以全局使用、控制器级使用或单个参数使用：

• 全局使用（所有路由生效）：在main.ts中注册

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { JsonParsePipe } from './json-parse.pipe';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new JsonParsePipe());
  await app.listen(5000);
}
bootstrap();

• 单个参数使用（更灵活）：

import { Controller, Get, Query } from '@nestjs/common';
import { JsonParsePipe } from './json-parse.pipe';
import { TestDto } from './test.dto';

@Controller('api')
export class TestController {
  @Get('test')
  getTest(
    @Query('arrayParam', new JsonParsePipe()) arrayParam?: string[],
    @Query('anotherParam') anotherParam?: string
  ) {
    return { arrayParam, anotherParam };
  }
}

此时你的原DTO验证规则就能正常生效，因为arrayParam已被转换为数组类型。

方案二：改用逗号分隔数组+内置ParseArrayPipe #

如果可以调整请求参数格式，将数组改为逗号分隔的形式（更符合HTTP查询参数的常规写法），比如：

http://localhost:5000/api/test?arrayParam=abc,def&anotherParam=value

直接使用NestJS内置的ParseArrayPipe解析：

import { Controller, Get, Query, ParseArrayPipe } from '@nestjs/common';

@Controller('api')
export class TestController {
  @Get('test')
  getTest(
    @Query('arrayParam', new ParseArrayPipe({ items: String, optional: true })) arrayParam?: string[],
    @Query('anotherParam') anotherParam?: string
  ) {
    return { arrayParam, anotherParam };
  }
}

方案三：在DTO中用class-transformer做转换 #

利用NestJS默认集成的class-transformer，在DTO中添加转换逻辑，配合ValidationPipe实现自动转换与验证。

1. 修改DTO #

import { IsOptional, IsArray, IsString } from 'class-validator';
import { Transform } from 'class-transformer';

export class TestDto {
  @IsOptional()
  @IsArray()
  @IsString({ each: true })
  @Transform(({ value }) => {
    if (typeof value === 'string') {
      try {
        return JSON.parse(value);
      } catch (e) {
        throw new Error('arrayParam必须是合法的JSON数组字符串');
      }
    }
    return value;
  })
  arrayParam?: string[];

  @IsOptional()
  @IsString()
  @Transform(({ value }) => {
    // 处理带引号的字符串参数
    if (typeof value === 'string' && value.startsWith('"') && value.endsWith('"')) {
      return value.slice(1, -1);
    }
    return value;
  })
  anotherParam?: string;
}

2. 启用全局验证与转换 #

在main.ts中配置ValidationPipe，开启自动转换：

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe({
    transform: true, // 启用自动转换
    transformOptions: { enableImplicitConversion: true }
  }));
  await app.listen(5000);
}
bootstrap();

之后控制器直接接收DTO即可：

import { Controller, Get, Query } from '@nestjs/common';
import { TestDto } from './test.dto';

@Controller('api')
export class TestController {
  @Get('test')
  getTest(@Query() query: TestDto) {
    return query;
  }
}

补充说明 #

你之前的DTO验证失败，是因为class-validator仅做类型验证，不会自动将字符串转换为数组类型。必须先通过管道或class-transformer完成类型转换，再进行验证。

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