Validation - @NotNull, @NotEmpty, @NotBlank

Intro

---

클라이언트에서 넘어온 데이터를 객체에 바인딩할 때 @Valid, @Validated 어노테이션을 통해서 유효성 검사를 진행할 수 있다.

유효성 검사를 적용할 필드에 여러가지 어노테이션을 적용할 수 있는데 그 중 비슷해보이는 @NotNull, @NotEmpty, @NotBlank 어노테이션을 구분해보고자 한다.

이유는 프로젝트를 진행하면서 적용 가능한 타입이 아닌 곳에 사용하다 에러를 겪은 상황이 있기에 용도에 맞게 사용할 수 있도록 하기 위함이다.

@NotNull

---

@NotNull은 Annotation Type NotNull 에 보면 말 그대로 Null만 허용하지 않는다고 되어있다.

하지만 비어있는 것은 상관없으므로 ""나 " "는 가능하다.

자바에서 ""는 보통 초기화된 String에 사용하고, " "는 공백 문자를 의미한다.

따라서, 공백 문자와 초기화를 포함한 어떤 값이라도 상관없지만, Null이 들어왔을 때 문제가 생기는 경우에 사용한다.

그리고, @NotNull은 모든 타입에 적용할 수 있다.

@NotEmpty

---

@NotEmpty는 Annotation Type NotEmpty 에서

The annotated element must not be null nor empty라고 명시되어 있다.

이 말은 ""의 빈 값은 불가능하다는 뜻이다.

한가지 추가적으로, @NotEmpty는 모든 타입에 다 적용되는 것이 아니다.

CharSequence, Collection, Map, Array 타입에만 적용된다.

@NotBlank

---

@NotBlank는 Annotation Type NotBlank 에서

Null이 아니고, 최소 한 개 이상의 공백 문자가 아닌 문자를 포함해야 한다고 되어있다.

그렇기 때문에 " "도 불가능하다.

@NotBlank는 validation 중 강도가 가장 높은 수준이다.

마지막으로, 🚨 제일 중요한 부분인데 @NotBlank는 CharSequence 타입에만 적용할 수 있다. 그렇기 떄문에, CharSequence의 구현 클래스인 String엔 적용할 수 있지만 Integer, Long, Double과 같은 타입엔 적용할 수 없다. 🚨

그럴 땐, 모든 타입에 적용할 수 있는 @NotNull을 사용하는 것이 바람직하다.

References

• [Spring] @Valid, @Validated 사용법
• @NotNull, @NotEmpty, @NotBlank 의 차이점 및 사용법
• Difference Between @NotNull, @NotEmpty, and @NotBlank Constraints in Bean Validation
• Bean Validation