NestJs DTO Validator

개요

NestJS 에서 DTO로 등록된 필수 파라메터 유효성 검사를 하자

일일히 컨트롤러에서 처리하는건 너무 비효율 적이기에 boot함수에서 일괄로 처리하기 위한 방법을 기록

Global Pipes 설정

whitelist : @ 프로퍼티 값 valid

forbidNonWhitelisted : 없는 값 들어올시 에러메세지

transform : 정의된 타입으로 형변환


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,
      transform: true,
    }),
  );
  await app.listen(3000);
}
bootstrap();

boot함수에 ValidationPipe클래스를 넣어주자

처음 호출을 했을시에 forbidNonWhitelisted : true 설정에 의해 내 모든 파라미터가 등록이 안되었다는 에러가 발생한다


{
    "statusCode": 400,
    "message": [
        "property user should not exist",
        "property email should not exist",
        "property password should not exist"
    ],
    "error": "Bad Request"
}

페키지 설치


$ npm i class-validator class-transformer

Valid 설정


import { IsString } from 'class-validator';
import { User } from '../entities/user.entity';

export class CreateUserDto {
  @IsString()
  readonly email: string;
  @IsString()
  readonly password: string;
  @IsString()
  readonly name: string;
  toUserEntity(): User {
    return User.from(this.email, this.password, this.name);
  }
}

위와 같이 @IsString() , @IsNumber() 등 속성 위에 decorator 하여 사용 하며 valid 체크 한다