NestJS 객체 변환

Info

24년 5월 초 작업 내용을 간단히 요약한 글입니다.

Entity와 DTO

Entity는 단순 의미로는 관리가 필요한 데이터의 집합이지만, 일반적으로 DB 관련 데이터 형식을 정의할 때 사용합니다.
DTO(Data Transfer Object)란 프로세스 간에 데이터를 전송할 때 사용하는 객체를 말합니다.
이 글에서 중요하게 다루는 개념은 아니기 때문에 자세한 설명은 생략하도록 하겠습니다.

문제 상황

업무 코드에서 Entity는 TypeORM을 사용해 테이블 정보와 동일하게 정의하고, DTO는 API를 위해 별도로 정의해 사용하고 있습니다.

문제는 Entity에서 DTO로 변환하거나 그 반대의 과정이 필요한데, 기존 코드는 겹치는 속성이 많음에도 단순히 JSON 객체를 새로 생성하는 식으로 처리하고 있어 코드의 양도 많아지고 깔끔하지 않았습니다.

// DB function
const foos = await this.getFooList();
 
return foos.map((foo) => ({
  name: foo.name,
  description: foo.description,
  bar: someProcess(foo.bar),
  // ..
}));

해결 방안

class-transformer 패키지의 plainToClass 함수를 사용했습니다. 패키지 버전이 낮아서 이렇게 해도 문제가 없었는데, 최신 버전에서는 plainToInstance 함수를 대신 사용하면 됩니다.

// DB function
const foos = await this.getFooList();
 
return foos.map((foo) =>
  plainToClass(FooDto, {
    ...foo,
    bar: someProcess(foo.bar),
  })
);

이 방법도 완전한 방법은 아니지만 불필요한 코드를 많이 줄일 수 있었고, 별도의 처리가 필요할 경우 필요한 값만 교체하면 되기 때문에 대처를 할 수 있었습니다.

그 외에도 타입 안정성을 보장하는 방법 등 여러 활용법이 있습니다.
계속 사용하면서 안정성을 판단해야 할 필요는 있을 것 같네요.