🚶🏻#20 [Nest.js] -ValidationPipe + class-validator 사용하여 유효성 검사하기

Case

영화 데이터를 추가하려한다

title, year, genres 를 입력받고, 입력받는 값들의 Type Validation 과  입력받을수 없는 값들에 대한 Validation 을 해보려고 한다

---

Step 01 - ValidationPipe Import 하기

/* main.ts 파일 */
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ValidationPipe } from '@nestjs/common';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(
    new ValidationPipe({
      whitelist: true,
      forbidNonWhitelisted: true
    }),
  );
  await app.listen(3000);
}
bootstrap();

• @nestjs/common 에서 꺼내와서 사용할수있다
• app.useFlobalPipes 에서 ValidationPipe 로 유효성 검사를 진행한다
• whitelist, fobidNonWhitelisted 속성은 아래에서 설명하겠다

---

Step 02 - Class Validation 에 필요한 패키지 설치

/* 설치 방법 */
npm i class-validator

/* create-movie.dto.ts 파일 */
import { IsString, IsNumber, IsOptional } from 'class-validator';

export class CreateMovieDto {
  @IsString()
  readonly title: string;

  @IsNumber()
  readonly year: number;

  @IsOptional()
  @IsString({ each: true })
  readonly genres: string[];
}

• dto.ts 파일을 만들어서 Validation 을 진행한다
• class-validator 에는 다양한 유효성 검사 양식이 존재한다
• 데코레이터들은 유효성 검사를 진행할 속성들 윗줄에 적어준다

---

정리하기

• 여기까지가 ValidationPipe 와 class-validator 를 사용하여 유효성 검사를 진행하는 방법이다
• main.ts 파일의 whitelist: true 속성은 유효성 검사에 등록되지 않은 필드는 제외하고 데이터를 저장시킨다
• main.ts 파일의 forbidNonWhitelisted 은 whitelist: true 일때 사용이 가능하며, 유효성 검사를 통과하지 못하면 에러메세지를 발생시킨다

 

title, year, genres 에 유효성검사 실패하게 만든 예시

 

title, year, genres 에 유효성검사 실패하게 만든 결과