Nest.js获取用户数据时无法排除password字段问题求助

问题根源 #

你当前的代码中，虽然声明UserService.geOneCustomer返回UserSerializer类型，但TypeScript的类型提示仅在编译阶段生效，运行时userRepository.findOne返回的仍是UserEntity实例。ClassSerializerInterceptor只会识别返回对象所属类的装饰器规则，而UserEntity未排除password字段，因此拦截器无法应用UserSerializer中的@Exclude()配置。

解决方案 #

使用class-transformer库的plainToInstance方法，将UserEntity实例转换为UserSerializer类的实例，让拦截器能正确读取序列化规则。

步骤1：确保UserSerializer正确引入装饰器 #

// user.serializer.ts
import { Exclude } from 'class-transformer';
import { IUser } from './your-interface-path'; // 替换为实际的IUser路径

export class UserSerializer implements IUser {
  firstname: string;
  lastname: string;
  username: string;
  email: string;
  isEmailVerified: boolean;
  isPhoneVerified: boolean;
  phoneNumber: string;
  nationalCode: string;
  shebaCode: string;
  roles: string[];

  @Exclude()
  password: string;
}

步骤2：修改UserService转换实例 #

// user.service.ts
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { plainToInstance } from 'class-transformer';
import { UserEntity } from './user.entity';
import { UserRepository } from './user.repository';
import { UserSerializer } from './user.serializer';
import { NotFoundResponse } from './your-error-response-path'; // 替换为实际路径

@Injectable()
export class UserService {
  constructor(@InjectRepository(UserEntity) private userRepository: UserRepository) {}

  async geOneCustomer(userId: string): Promise<UserSerializer> {
    const result = await this.userRepository.findOne({
      where: { id: userId }
    });
    if (!result) throw new NotFoundResponse({ result:[], message:'Ooops! Not found Such A User!', statusCode:404, metaData:[] });
    
    // 将Entity实例转换为Serializer实例
    return plainToInstance(UserSerializer, result);
  }
}

步骤3：确认拦截器配置（无需修改） #

你的UserController中已经正确添加了@UseInterceptors(ClassSerializerInterceptor)，此配置保持不变即可。

完成上述修改后，password字段会被正确排除，客户端将不会收到该字段。

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