5주차 - 유효성 검사 및 실습 예제

경희대학교 컴퓨터공학부 하계 리턴 백엔드(스프링부트) 스터디 5주차 - 트랙장 최현영

0. Validation

유효성 검사가 뭐니?
- 유효성 검사란 정말 매우 매우 중요한 절차이다. 만약에 주민번호를 저장해야하나, 클라이언트가 멍청하게 주민번호가 아닌 전화번호를 입력했다고 생각해보자. 경희대 이메일만 받도록 요구하는 서비스에서 네이버 이메일을 입력했다고 생각해보자.
- 즉, 애플리케이션의 비지니스 로직이 제대로, 올바르게 동작하기 위해서는 데이터를 사전에 검증하는 작업이 필요하다. 다시말해, 데이터베이스에 전달받은 데이터를 저장하기 전에 온전한 값인지 판별하는 작업이 필요하다는 것이다.
- 이를 유효성 검사 또는 검증이라고 한다.
우리는 스프링에서 제공하는 validation 라이브러리를 통해 어노테이션만으로 클라이언트가 전달한 값이 온전한 값인지 쉽게 검증할 수 있다^^

1. Bean Validation

자바 진영에서는 Bean Validation이라는 유효성 검사 프레임워크를 지원한다.
- 명세서에 불과하다. 마치 JPA가 명세서이고 이들의 구현체인 하이버네이트를 사용했듯이.
앞전에 설명한데로 어노테이션(@)만으로 유효성 검사를 DTO나 엔티티에 적용하여 모든 아키텍처 레이어에 사용이 가능하다.

2. Hibernate Validator

Bean Validation의 구현체이다. 이 친구를 우리는 의존성 라이브러리에 추가하여 어노테이션을 통해 유효성 검사를 할 수 있게 된다.

build.gradle에 validation 라이브러리를 추가해주자.

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    runtimeOnly 'com.h2database:h2'
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    **implementation 'org.springframework.boot:spring-boot-starter-validation'//추가**
}

3. 어노테이션 종류

문자열 검증
- @Null : null 값만 허용
- @NotNull : null을 허용하지 않음. ‘’, " "는 허용
- @NotEmpty : null, ""을 허용하지 않음. " "는 허용
- @NotBlank : null, ‘’, " "을 허용하지 않음
최댓값/최솟값 검증
- @Min(value = $number): $number 이상의 값을 허용
- @Max(value = $number): $number 이하의 값을 허용
값의 범위 검증
- @Positive : 양수를 허용
- @PositiveOrZero: 0을 포함한 양수를 허용
- @Negative: 음수를 허용
- @NegativeOrZero: 0을 포함한 음수를 허용
시간에 대한 검증
- LocalDateTime 등의 타입을 지원
- @Future: 현재보다 미래의 날짜를 허용
- @FutureOrPresent: 현재를 포함한 미래의 날짜를 허용
- @Past: 현재보다 과거의 날짜를 허용
- @PastOrPresent: 현재를 포함한 과거의 날짜를 허용
이메일 검증
- @Email: 이메일 형식을 검사. "는 허용
자릿수 범위 검증
- @Digits(integer = $number1, fraction = $number2): $number1의 정수 자릿수와 $number2의 소수 자릿수를 허용
Boolean 검증
- @AssertTrue: true인지 검사.
- @AssertFalse: false인지 검사.
  - 둘다 NULL일 경우 무시한다.
문자열 길이 검증
- @Size(min = $number1, max = $number2): $number1 이상 $number2 이하의 범위를 허용합니다
정규식 커스텀
- @Pattern(regexp = “$표현식”) : 정규식을 통해 검사. ⇒ 정규 표현식은 자바의 Pattern 패키지의 형식을 따름
  - 아래 블로그 참고
  - https://adjh54.tistory.com/104
  - 여기서 잠깐, ChatGPT가 정말 잘 짜줘요!
    
    굿.