使用class-transformer的@Transform转换嵌套实体至DTO遇异常求解决

场景说明 #

使用TypeORM定义了User、Role、Status关联实体，需要将User实体转换为UserDto，要求role和status字段直接映射为关联实体的id数值。但在使用class-transformer的@Transform装饰器时，转换逻辑被执行两次：第一次传入完整的关联实体对象，第二次传入第一次返回的id数值，导致第二次访问value.id时出现undefined。

相关实体定义 #

User实体

@Entity({
  name: 'user',
})
export class User extends RootBaseEntity {
  @Column({ type: String })
  uid: string;

  @Index()
  @Column({ type: String, unique: true })
  email: string;

  @Column()
  @Exclude({ toPlainOnly: true })
  password: string;

  @Index()
  @Column({ type: String, name: 'first_name' })
  firstName: string | null;

  @Index()
  @Column({ type: String, name: 'last_name' })
  lastName: string | null;

  @ManyToOne(() => Role, (role) => role.users, {
    eager: true,
  })
  @JoinColumn({ name: 'role_id', referencedColumnName: 'id' })
  role: Role;

  @ManyToOne(() => Status, (status) => status.users, {
    eager: true,
  })
  @JoinColumn({ name: 'status_id', referencedColumnName: 'id' })
  status: Status;
}

Role和Status实体

@Entity({
  name: 'role',
})
export class Role extends RootBaseEntity {
  @Column({
    type: 'enum',
    enum: RoleEnum,
    name: 'name',
  })
  @Index({
    unique: true,
  })
  name: string;

  @OneToMany(() => User, (user) => user.role)
  @JoinColumn({ referencedColumnName: 'id' })
  users: User[];
}

@Entity({
  name: 'status',
})
export class Status extends RootBaseEntity {
  @Column({
    type: 'enum',
    enum: StatusEnum,
    name: 'name',
  })
  @Index({
    unique: true,
  })
  name: string;

  @OneToMany(() => User, (user) => user.status)
  @JoinColumn({ referencedColumnName: 'id' })
  users: User[];
}

当前UserDto定义 #

@Exclude()
export class UserDto {
  @Expose()
  @IsString()
  uid: string;

  @Expose()
  @IsString()
  email: string;

  @Expose()
  @IsString()
  firstName: string;

  @Expose()
  @IsString()
  lastName: string;

  @Expose()
  @Type(() => RoleDto['id'])
  @Transform(({ value }) => {
    console.log(value);
    return value.id;
  })
  role: RoleDto['id'];

  @Expose()
  @Type(() => StatusDto)
  @Transform(({ value }) => value.id)
  status: StatusDto['id'];

  @Expose()
  @IsDate()
  createdAt: Date;
}

@Exclude()
export class RoleDto {
  @Expose()
  @IsNumber()
  id: number;
}

@Exclude()
export class StatusDto {
  @Expose()
  @IsNumber()
  id: number;
}

问题现象 #

@Transform逻辑被执行两次：

1. 第一次传入完整的Role/Status实体对象，返回value.id；
2. 第二次传入第一次返回的id数值，此时value.id不存在，导致最终role/status字段变为undefined。

解决方案 #

方案1：修正Transform逻辑，兼容两种输入类型 #

在@Transform中先判断输入值的类型，对象取id，数值直接返回：

@Exclude()
export class UserDto {
  // 其他字段保持不变

  @Expose()
  @Transform(({ value }) => {
    return typeof value === 'object' && value !== null ? value.id : value;
  })
  @IsNumber()
  role: number;

  @Expose()
  @Transform(({ value }) => {
    return typeof value === 'object' && value !== null ? value.id : value;
  })
  @IsNumber()
  status: number;

  // createdAt字段保持不变
}

同时可以去掉@Type(() => RoleDto['id'])和@Type(() => StatusDto)，因为无需再转换为DTO对象，直接提取id即可。

方案2：直接使用@Expose的name属性映射嵌套字段 #

利用class-transformer的@Expose特性，直接关联实体的嵌套字段，无需额外@Transform：

@Exclude()
export class UserDto {
  @Expose()
  @IsString()
  uid: string;

  @Expose()
  @IsString()
  email: string;

  @Expose()
  @IsString()
  firstName: string;

  @Expose()
  @IsString()
  lastName: string;

  @Expose({ name: 'role.id' })
  @IsNumber()
  role: number;

  @Expose({ name: 'status.id' })
  @IsNumber()
  status: number;

  @Expose()
  @IsDate()
  createdAt: Date;
}

这种方式更简洁，直接从源对象的嵌套字段取值，避免了@Transform重复执行的问题。

方案3：通用提取Id转换函数（复杂场景适用） #

定义通用转换函数复用逻辑：

const extractId = ({ value }: { value: any }) => {
  return typeof value === 'object' && value !== null ? value.id : value;
};

@Exclude()
export class UserDto {
  // 其他字段保持不变

  @Expose()
  @Transform(extractId)
  @IsNumber()
  role: number;

  @Expose()
  @Transform(extractId)
  @IsNumber()
  status: number;
}

关键原因分析 #

重复执行@Transform的核心原因：

1. 首先class-transformer会对role/status字段应用@Type指定的转换器，将实体转换为RoleDto/StatusDto；
2. 随后再执行@Transform装饰器，此时输入的是转换后的id数值，导致第二次访问value.id出错。

去掉不必要的@Type装饰器，或让@Transform兼容两种输入类型，即可解决问题。

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