CreateUserDto와 UpdateUserDto로 이해한 요청 데이터 검증 흐름

@Post()
create(@Body() createUserDto: CreateUserDto) {
  return this.usersService.create(createUserDto);
}

DTO는 프론트에서 백엔드로 들어오는 데이터의 규칙이다.

{
  "email": "test@example.com",
  "password": "password1234",
  "name": "사용자",
  "phoneNumber": "01012345678"
}

{
  "email": "이메일아님",
  "password": 1234,
  "name": "",
  "role": "ADMIN"
}

email은 이메일 형식이 아니다.
password가 문자열이 아니라 숫자다.
name이 비어 있다.
role은 클라이언트가 마음대로 보내면 안 되는 값이다.

회원 생성 요청에는 어떤 필드를 받을 것인가?
각 필드는 어떤 타입이어야 하는가?
필수값과 선택값은 무엇인가?
정해진 enum 값만 받아야 하는 필드는 무엇인가?
DTO에 없는 필드가 들어오면 어떻게 할 것인가?

app.useGlobalPipes(
  new ValidationPipe({
    whitelist: true,
    forbidNonWhitelisted: true,
    transform: true,
  }),
);

프론트 요청
  ↓
ValidationPipe
  ↓
CreateUserDto 규칙 검사
  ↓
검증 통과
  ↓
UsersController 실행
  ↓
UsersService 실행

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

  @IsString()
  @IsOptional()
  password?: string;

  @IsString()
  @IsNotEmpty()
  name: string;

  @IsString()
  @IsOptional()
  @IsPhoneNumber('KR')
  phoneNumber?: string;

  @IsEnum(AuthProvider)
  @IsOptional()
  provider?: AuthProvider = AuthProvider.GUEST;

  @IsString()
  @IsOptional()
  providerId?: string;

  @IsEnum(Gender)
  @IsOptional()
  gender?: Gender;

  @IsString()
  @IsOptional()
  schoolYear?: string;

  @IsBoolean()
  @IsOptional()
  privacyAccept?: boolean = false;

  @IsBoolean()
  @IsOptional()
  marketingAccept?: boolean = false;
}

@IsEmail()
@IsString()
@IsOptional()
@IsNotEmpty()
@IsEnum()
@IsBoolean()
@IsPhoneNumber()

@IsEmail()       → 이메일 형식인지 검사
@IsString()      → 문자열인지 검사
@IsOptional()    → 값이 없어도 허용
@IsNotEmpty()    → 비어 있으면 안 됨
@IsEnum()        → enum에 있는 값만 허용
@IsBoolean()     → true/false 값인지 검사
@IsPhoneNumber() → 전화번호 형식인지 검사

@IsEmail({}, { message: '이메일 형식이 올바르지 않습니다.' })
@IsOptional()
email?: string;

@IsOptional()

@IsEmail()

email은 없어도 된다.
하지만 값이 있다면 이메일 형식이어야 한다.

{
  "email": "test@example.com"
}

{
  "email": "이메일아님"
}

@IsString()
@IsOptional()
password?: string;

@IsString()

@IsOptional()

일반 이메일 회원가입 → password 있음
게스트 사용자 → password 없을 수 있음
소셜 로그인 사용자 → password 없을 수 있음

@IsString()
@IsNotEmpty({ message: '이름은 필수 입력 항목입니다.' })
name: string;

name: string;

{
  "name": ""
}

name은 반드시 있어야 한다.
문자열이어야 한다.
빈 문자열이면 안 된다.

@IsString()
@IsOptional()
@IsPhoneNumber('KR', { message: '올바른 한국 전화번호 형식이 아닙니다.' })
phoneNumber?: string;

01012345678

{
  "phoneNumber": "01012345678"
}

phoneNumber는 없어도 된다.
하지만 값이 있다면 문자열이고, 한국 전화번호 형식이어야 한다.

@IsEnum(AuthProvider)
@IsOptional()
provider?: AuthProvider = AuthProvider.GUEST;

LOCAL
KAKAO
NAVER
GOOGLE
GUEST

{
  "provider": "LOCAL"
}

{
  "provider": "GUEST"
}

{
  "provider": "EMAIL"
}

provider?: AuthProvider = AuthProvider.GUEST;

const role = createUserDto.provider === 'GUEST'
  ? Role.GUEST
  : Role.USER;

CreateUserDto.provider
  ↓
UsersService에서 provider 확인
  ↓
role 결정
  ↓
DB 저장

@IsString()
@IsOptional()
providerId?: string;

provider   = KAKAO
providerId = 카카오에서 내려준 사용자 고유 ID

@IsEnum(Gender)
@IsOptional()
gender?: Gender;

MALE
FEMALE

{
  "gender": "MALE"
}

{
  "gender": "FEMALE"
}

{
  "gender": "남자"
}

화면 표시값과 서버 저장값은 다를 수 있다.

@IsString()
@IsOptional()
schoolYear?: string;

{
  "schoolYear": "중3"
}

{
  "schoolYear": "아무값"
}

중1
중2
중3
기타

@IsBoolean()
@IsOptional()
privacyAccept?: boolean = false;

{
  "privacyAccept": true
}

{
  "privacyAccept": false
}

{
  "privacyAccept": "true"
}

privacyAccept: true

privacyAccept?: boolean = false;

privacyAccept가 없어도 허용된다.
값이 있다면 boolean이어야 한다.
값이 없으면 기본값은 false다.

@IsBoolean()
@IsOptional()
marketingAccept?: boolean = false;

privacyAccept   → 개인정보 처리 동의
marketingAccept → 마케팅 정보 수신 동의

marketingAccept는 없어도 된다.
값이 있다면 boolean이어야 한다.
값이 없으면 기본값은 false다.

@IsOptional()
email?: string;

@IsOptional() → 없어도 된다.
?             → TypeScript 기준으로 선택값이다.

@IsString()
@IsNotEmpty()
name: string;

name: string;

import { PartialType } from '@nestjs/mapped-types';
import { CreateUserDto } from './create-user.dto';

export class UpdateUserDto extends PartialType(CreateUserDto) {}

CreateUserDto의 필드와 검증 규칙을 재사용하되,
모든 필드를 optional로 바꾼 UpdateUserDto를 만든다.

{
  "name": "수정된 이름"
}

{
  "phoneNumber": "01099998888"
}

export class UpdateUserDto extends PartialType(CreateUserDto) {}

CreateUserDto에 있는 모든 필드를 가져온다.
단, 수정 요청에 맞게 전부 optional로 바꾼다.

@IsString()
@IsNotEmpty()
name: string;

{
  "phoneNumber": "01099998888"
}

@IsString()
@IsOptional()
password?: string;

async update(id: string, updateUserDto: UpdateUserDto) {
  return this.prisma.user.update({
    where: { id },
    data: updateUserDto,
  });
}

{
  "password": "new-password"
}

updateUserDto에 password가 있는지 확인
  ↓
password가 있으면 bcrypt.hash() 실행
  ↓
해시된 password로 data 재구성
  ↓
DB 업데이트

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

forbidNonWhitelisted: true

{
  "name": "사용자",
  "role": "ADMIN"
}

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

{
  "role": "ADMIN"
}

email
→ 없어도 된다.
→ 값이 있다면 이메일 형식이어야 한다.

password
→ 없어도 된다.
→ 값이 있다면 문자열이어야 한다.

name
→ 필수값이다.
→ 문자열이어야 한다.
→ 빈 문자열이면 안 된다.

phoneNumber
→ 없어도 된다.
→ 값이 있다면 문자열이어야 한다.
→ 한국 전화번호 형식이어야 한다.

provider
→ 없어도 된다.
→ 값이 있다면 AuthProvider enum 값이어야 한다.
→ 기본값은 GUEST다.

providerId
→ 없어도 된다.
→ 값이 있다면 문자열이어야 한다.

gender
→ 없어도 된다.
→ 값이 있다면 Gender enum 값이어야 한다.

schoolYear
→ 없어도 된다.
→ 값이 있다면 문자열이어야 한다.

privacyAccept
→ 없어도 된다.
→ 값이 있다면 boolean이어야 한다.
→ 기본값은 false다.

marketingAccept
→ 없어도 된다.
→ 값이 있다면 boolean이어야 한다.
→ 기본값은 false다.

프론트 요청
  ↓
ValidationPipe
  ↓
DTO 규칙 검사
  ↓
Controller 실행
  ↓
Service 실행

어떤 필드를 받을 것인지
필수값은 무엇인지
선택값은 무엇인지
각 필드는 어떤 형식이어야 하는지

export class UpdateUserDto extends PartialType(CreateUserDto) {}

whitelist
→ DTO에 정의된 필드만 허용한다.

forbidNonWhitelisted
→ DTO에 없는 필드가 들어오면 요청을 거절한다.

DTO
→ 들어오는 데이터의 형식을 검증한다.

Service
→ 검증된 데이터를 바탕으로 실제 비즈니스 로직을 처리한다.