[SpringBoot] @NotNull, @NotEmpty, @NotBlank 차이점, 그만 헷갈리기로 해요

@NotNull, @NotEmpty, @NotBlank 세 어노테이션은 DTO 필드의 유효성 검증에 사용된다. 

 

@NotNull

@NotNull은 필드에 Null 값을 허용하지 않는다는 것을 유추할 수 있다.

실제로도 @NotNull 이 붙은 필드는 null 값만 허용하지 않을 뿐, "" 나 "  " 같은 빈값, 공백값은 할당 받을 수 있다.

 

 

하지만 @NotEmpty 와 @NotBlank 는 왠지 모르겠지만 매번 헷갈린다.

둘의 차이가 헷갈림 -> 구글링 -> 오케이 확인 -> (며칠 후) 둘의 차이가 헷갈림 -> 구글링 -> ...

이젠 그만 헷갈리기로 하자.

 

 

@NotEmpty

Not Empty : (필드가) 비어있지 않다 <-> 그렇다면 비어있는 필드는 어떤 상태일까. 바로 null 과 "" 이다.

즉 @NotEmpty는 필드에 null 과 "" 같은 값이 할당되는 것을 방지한다.

@Getter
public class SampleDto {

    @NotEmpty
    private String phone;

}

이제 phone 필드에 null 혹은 "" 를 입력후 API 를 보내면 아래와 같은 메시지를 볼 수 있다.

유효성 검증이 잘 이뤄졌다는 의미.

{
    "timestamp": "28-01-2023 07:50:16",
    "errorCode": "BAD_REQUEST",
    "errorMessage": "공백일 수 없습니다"
}

유효성 검증이 잘 이뤄졌다는 의미다.

하지만 해당 필드에 " ",  "     " 처럼 띄어쓰기가 있어도 유효성 검증이 정상적으로 이뤄질까?

아쉽지만 공백으로만 이루어진 값은 @NotEmpty 로 검증이 불가능하다.  

 

"   " 은 공백이긴 하지만 비어있는 상태가 아니다. 뭐라도 있는 상태, 비록 그것이 공백일지라도 말이다.

때문에 필드에 "   " 처럼 공백이 할당되면 @NotEmpty로 검증할 수 없다. 실제로 사이드 프로젝트에서 사용자 휴대폰 번호 필드가 @NotEmpty 로 돼 있어 스페이스만 입력된 값이 저장된 케이스도 있었다...

 

그렇다면 "  " 처럼 스페이스로만 가득한 값은 어떻게 유효성 검증을 해야할까?

이제 이번 포스팅의 유효성 검증 끝판왕인 @NotBlank를 소개할 차례다.

 

@NotBlank

@NotBlank 는

• null
• ""
• " "
• "      "  

중 어느것도 허용하지 않는다.

회원가입할 때 정보 기입이 귀찮아 스페이스로만 입력창을 채울 때,

필드의 유효성 검증을 @NotBlank로 한다면 보기좋게 튕길 것이다.  

 

결론

@NotNull : null

@NotEmpty : null, ""

@NotBlank : null, "", " ", "     "

 

세가지 Validator 의 차이점을 알아봤다. 자칫 오해하면 항상 @NotBlank 를 사용해야 한다고 생각할 수도 있지만, 상황에 따라 공백이나 빈 값을 저장하는 경우도 분명 있을 것이다. 각 상황에 맞는 Validator 를 사용하는 것이 중요하겠다. 

 

 

 

 

끝