如何在NestJS中使用class-transformer序列化并排除特定字段？

在NestJS里结合class-transformer实现字段排除，最直接高效的方式是利用框架的序列化拦截器配合class-transformer的装饰器，以下是具体实现步骤：

1. 确保依赖安装 #

如果还未安装class-transformer和class-validator，先执行安装命令：

npm install class-transformer class-validator

2. 用@Exclude装饰器标记需要排除的字段 #

直接在Users类的hash字段上添加@Exclude()装饰器，标记该字段在序列化时需要被排除：

import { Exclude } from 'class-transformer';

class Users {
  id: string;
  
  @Exclude()
  hash: string;
  
  email: string;
  firstName: string;
  lastName: string;
}

3. 启用ClassSerializerInterceptor #

NestJS提供的ClassSerializerInterceptor会自动利用class-transformer的规则处理响应序列化，有两种启用方式：

局部启用（单接口生效） #

在目标控制器方法上添加@UseInterceptors(ClassSerializerInterceptor)装饰器：

import { HttpCode, Get, Query, UseInterceptors, ClassSerializerInterceptor } from '@nestjs/common';
import { HttpStatus } from '@nestjs/common';

@HttpCode(HttpStatus.OK)
@Get()
@UseInterceptors(ClassSerializerInterceptor)
async getAllUsers(@Query() userQuery: UserQueryDto) {
  const users = await this.userService.findAllByFilter(userQuery);
  return users;
}

全局启用（所有接口生效） #

在main.ts中注册全局拦截器，这样所有接口都会自动应用序列化规则：

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

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalInterceptors(new ClassSerializerInterceptor(app.get(Reflector)));
  await app.listen(3000);
}
bootstrap();

4. 灵活场景：基于分组控制字段显示 #

如果需要根据不同场景决定是否返回hash字段（比如管理员接口返回，普通接口不返回），可以结合@Expose和分组功能：

修改Users类定义分组 #

import { Exclude, Expose } from 'class-transformer';

class Users {
  @Expose({ groups: ['public', 'admin'] })
  id: string;
  
  @Expose({ groups: ['admin'] })
  hash: string;
  
  @Expose({ groups: ['public', 'admin'] })
  email: string;
  
  @Expose({ groups: ['public', 'admin'] })
  firstName: string;
  
  @Expose({ groups: ['public', 'admin'] })
  lastName: string;
}

在控制器中指定生效分组 #

通过@SerializeOptions装饰器指定当前接口使用的分组：

import { SerializeOptions } from '@nestjs/common';

@HttpCode(HttpStatus.OK)
@Get()
@UseInterceptors(ClassSerializerInterceptor)
@SerializeOptions({ groups: ['public'] })
async getAllUsers(@Query() userQuery: UserQueryDto) {
  const users = await this.userService.findAllByFilter(userQuery);
  return users;
}

5. 手动序列化（可选） #

如果需要更精细的控制，可以在代码中手动调用plainToInstance方法完成序列化：

import { plainToInstance } from 'class-transformer';

async getAllUsers(@Query() userQuery: UserQueryDto) {
  const users = await this.userService.findAllByFilter(userQuery);
  return plainToInstance(UsersResponse, users, {
    excludeExtraneousValues: true, // 只保留被@Expose标记或未被@Exclude标记的字段
  });
}

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