🚀 nestjs dto validation guide

DTO: Data Transfer Object
클라이언트 측에서 Request를 받을 때 '타입 지정'만으로 validation 할 수 없다,
따라서 기본 validation 사용 방법과 custom validation을 사용하여 검증하는 것에 대해 정리하겠다.

1. PickType 🪵

entity에서 정의된 제약 조건을 PickType 활용해 dto에서도 활용이 가능하다.

• 다음과 같이 Mail 엔티티에서 정의된 'title'과 'html' 필드를 가져와 동일한 제약조건을 설정할 수 있다.

export class CreateMailDto extends PickType(Mail, [
  'title',
  'html',
]) {
  @IsArray()
  @Validate(CheckEmailList)
  userList: string[];
}

2. class-validator decorator 🗝️

nestjs 공식 문서에서 확인해보면 class-validator 라이브러리를 활용하여 validation을 하는 것을 권장하고 있다

• https://docs.nestjs.com/techniques/validation
• 예시에서 @IsEmail(), @IsNotEmpty() 등의 라이브러리를 활용하여 원하는 validation을 진행한다.

import { IsEmail, IsNotEmpty } from 'class-validator';

export class CreateUserDto {
  @IsEmail()
  email: string;

  @IsNotEmpty()
  password: string;
}

가장 자주 사용되는 validator decorator

데코레이터	설명
@IsString()	해당 필드의 값이 문자열인지 검증
@IsNotEmpty()	필드가 비어있지 않은지 검증. 문자열, 배열 등에서 사용할 수 있으며, 공백 문자열이나 빈 배열도 유효하지 않은 값으로 간주
@IsEmail()	해당 필드의 값이 유효한 이메일 형식인지 검증
@IsOptional()	필드 값이 제공되지 않거나 undefined일 경우에 검증을 건너뜀
@MinLength() / @MaxLength()	문자열의 최소 길이와 최대 길이를 검증
@IsInt() / @IsNumber()	해당 필드의 값이 정수 또는 숫자인지 검증
@IsBoolean()	필드 값이 불리언 타입인지 검증
@IsArray()	해당 필드의 값이 배열인지 검증
@ArrayNotEmpty()	배열이 비어있지 않은지 검증
@ValidateNested()	객체 배열에서 각 객체를 검증할 때 사용합니다. @Type() 데코레이터와 함께 사용되어, 배열 내 객체의 클래스 타입을 명시하고 그 객체들이 유효한지 검증합니다.

/node_modules/class-validator/types/decorator

• 다음 폴더에서 이미 자체적으로 제공되는 validation decorator를 확인해볼 수 있다.

3. custom-validation decorator ✨

위의 기본 제공 class-validator decorator만으로는 모든 검증을 다 하기 어려운 부분이 있다.
service 단에서 dto의 값을 검증하는 방법이 있겠지만, dto 자체의 문제이므로 나는 dto 단에서 검증을 마치는 것을 선호한다.

• @ValidatorConstraint 데코레이터를 사용하여 custom validator class를 등록할 수 있다.
• @ValidatorConstraint 데코레이터를 사용하면 반드시 ValidatorConstraintInterface를 받아 구현을 진행해야하고, return으로 불리언 타입을 받아 검증을 진행할 수 있다.

@ValidatorConstraint({ name: 'IsEvenNumber' })
export class IsEvenNumber implements ValidatorConstraintInterface {
  validate(value: number): boolean {
    if (value {
      return value % 2 === 0
    }
    return false
  }
}

export class SpecificNumber {
  // 짝수인지 체크
  @Validate(IsEvenNumber, { message: 'No Even Number' })
  specificNumber: number
}