[nestjs] ClassSerializerInterceptor 전체 적용하기

웹어플리케이션은 요청에 대한 응답결과를 client에 object 또는 object의 array 형태로 전달합니다

 

그런데 이러한 값을 뭔가 특정 룰에 의해 공통적으로 관리하고 싶습니다

 

 

예를 들면 password같은 결코 response 되어야 하지 말아야할 값을 숨겨야하기도 하고

 

특정값을 어떤 연산에 의해서 조작을 하여 리턴을 하거나,

 

조합을 통해 만든 특정값을 추가적으로 리턴하고 싶기도 하죠

 

real world에서는 이러한 케이스가 정말 많습니다

 

 

이러한 행위를 이러한 필요가 발생할때마다 반복적으로 코드를 작성하지 않고

 

통합적으로 관리할수 있다면 참 좋겠죠?

 

nestjs는 리턴되는 response object 를 관리할수 있는 라이프사이클을 가지고 있는데요

 

interceptor가 바로 좋은 위치입니다

 

ClassSerializerInterceptor 는 이러한 역할을 도와줄 좋은 nestjs 빌트인 기능입니다

 

response 되는 entity를 감지하여 해당 entity에 데이터를 변경하여 최종적으로 client에게 response 합니다

 

 

UserEntity가 있다고 가정합니다

 

그 안에는 민감한 password 필드가 있는데 이 값은 절대로 유저에게 노출되어서는 안됩니다

 

이때 해당 필드위에 @Exclude 를 사용하세요

 

이 값은 response시에 노출되지 않게됩니다

 

import { Exclude } from 'class-transformer';

export class UserEntity {
  id: number;
  firstName: string;
  lastName: string;

  @Exclude()
  password: string;

  constructor(partial: Partial<UserEntity>) {
    Object.assign(this, partial);
  }
}

 

Entity의 기존 필드에는 존재하지 않지만 

 

firstName과 lastName을 합친 fullName이라는 값을 추가적으로 리턴하고 싶습니다

 

그럴땐 @Expose() 사용합니다

 

@Expose()
get fullName(): string {
  return `${this.firstName} ${this.lastName}`;
}

 

그리고 내가 원하는 전체 컨트롤러 또는 개별 라우터에 ClassSerializerInterceptor 인터셉터를 적용합니다

@UseInterceptors(ClassSerializerInterceptor)
@Get()
findOne(): UserEntity {
  return new UserEntity({
    id: 1,
    firstName: 'Kamil',
    lastName: 'Mysliwiec',
    password: 'password',
  });
}

 

이때의 결과값은

 

{
  "id" : 1,
  "firstName" : "Kamil",
  "lastName" : "Mysliwiec",
  "fullName" : "Kamil Mysliwiec"
}

 

이렇게 나오게 될거예요

 

참 좋죠?

 

 

https://docs.nestjs.com/techniques/serialization

Documentation | NestJS - A progressive Node.js framework

 

이러한 인터셉터는 컨트롤러나 라우터 단위로도 설정을 할수 있고

 

앱 전체에 대해서 global로 적용이 가능합니다

 

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