Spring Validation - @NotNull, @NotEmpty, @NotBlank

📎 Spring Validation - @NotNull, @NotEmpty, @NotBlank

안녕하세요, 이번 시간에 정리할 내용은 spring-boot-starter-validation의 @NotNull, @NotEmpty, @NotBlank 어노테이션 입니다. 평소 도메인 클래스에 제약 조건으로 Validation을 사용하는데, 위 어노테이션들은 이름만 봐서는 비슷한 역할을 할 것 같은데 정확히 무엇이 다른지 궁금해서 포스팅을 하게 되었습니다. 🤔

아래 예제의 코드는 깃허브에서 확인하실 수 있습니다 :)

의존성 추가 - Maven

<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-validation -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
    <version>2.5.4</version>
</dependency>

의존성 추가 - Gradle

implementation 'org.springframework.boot:spring-boot-starter-validation'

@NotNull

@NotNull 어노테이션에 대해 살펴보겠습니다.

사용할 도메인 클래스는 아래와 같습니다.

package com.example.validation.model;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;

import javax.validation.constraints.NotNull;

@Getter
@ToString
@AllArgsConstructor
public class UserNotNull {

    @NotNull(message = "name must not be null")
    private final String name;
}

@NotNull 어노테이션이 어떻게 작동하는지를 알아보기 위해 간단한 테스트 코드를 작성해보겠습니다.

package com.example.validation.model;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

import static org.assertj.core.api.Assertions.assertThat;

public class NotNullValidationTest {

    private Validator validator = null;

    @BeforeEach
    public void setupValidator() {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }

    @Test
    void name이_notNull일경우_제약조건이_존재하지_않는다() {
        // given
        UserNotNull user = new UserNotNull("JuHyun");

        // when
        Set<ConstraintViolation<UserNotNull>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(0);
    }

    @Test
    public void name이_null일경우_제약조건이_존재한다() {
        // given
        UserNotNull user = new UserNotNull(null);

        // when
        Set<ConstraintViolation<UserNotNull>> violations = validator.validate(user);

        // then
        violations.forEach(i -> System.out.println(i.getMessage()));
        assertThat(violations.size()).isEqualTo(1);
    }

    @Test
    public void name이_비어있는경우_제약조건이_존재하지_않는다() {
        // given
        UserNotNull user = new UserNotNull("");

        // when
        Set<ConstraintViolation<UserNotNull>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(0);
    }

}

위 세 코드는 모두 성공하는 테스트 코드입니다.

위 코드를 통해 @NotNull 어노테이션은 필드가 null일 경우는 허용하지 않으나, 비어있는 경우는 상관없습니다.

두 번째 메소드 name이_notNull일경우_제약조건이_존재하지_않는다() 의 출력 결과는 다음과 같습니다.

ConstraintViolation클래스의 getMessage() 메소드를 통해 name 필드에 설정한 'name must not be null' 메시지가 출력이 되는 걸 확인할 수 있습니다.

위 @NotNull 어노테이션이 사용하고 있는 NotNullValidator 클래스의 isValid() 메소드를 확인해보면 이해할 수 있습니다.

@NotEmpty

이번에는 @NotEmpty 어노테이션에 대해 살펴보겠습니다.

사용할 도메인 클래스는 아래와 같습니다.

package com.example.validation.model;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;

import javax.validation.constraints.NotEmpty;

@Getter
@ToString
@AllArgsConstructor
public class UserNotEmpty {

    @NotEmpty(message = "name must not be empty")
    private final String name;
}

이번에도 마찬가지로 테스트 코드를 작성해보겠습니다.

package com.example.validation.model;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

import static org.assertj.core.api.Assertions.assertThat;

public class NotEmptyValidationTest {

    private Validator validator = null;

    @BeforeEach
    public void setupValidator() {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }

    @Test
    void name이_비어있지_않는경우_제약조건은_존재하지_않는다() {
        // given
        UserNotEmpty user = new UserNotEmpty("JuHyun");

        // when
        Set<ConstraintViolation<UserNotEmpty>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(0);
    }

    @Test
    public void name이_비어있는경우_제약조건이_존재한다() {
        // given
        UserNotEmpty user = new UserNotEmpty("");

        // when
        Set<ConstraintViolation<UserNotEmpty>> violations = validator.validate(user);

        // then
        violations.forEach(i -> System.out.println(i.getMessage()));
        assertThat(violations.size()).isEqualTo(1);
    }

    @Test
    public void name이_null인경우_제약조건이_존재한다() {
        // given
        UserNotEmpty user = new UserNotEmpty(null);

        // when
        Set<ConstraintViolation<UserNotEmpty>> violations = validator.validate(user);

        // then
        violations.forEach(i -> System.out.println(i.getMessage()));
        assertThat(violations.size()).isEqualTo(1);
    }

}

위 세 코드는 모두 성공하는 테스트 코드입니다.

@NotEmpty 어노테이션은 @NotNull 클래스의 isValid() 메소드와 필드의 size/length가 0보다 큰 지를 확인합니다.

즉, 유효성을 검사하는 필드가 NotNull이여야 하고, size/length가 0보다 커야합니다.

두번째 메소드 name이_비어있는경우_제약조건이_존재한다() 의 출력 결과는 다음과 같습니다.

@NotEmpty 어노테이션은 @Size 어노테이션과 함께 설정하면 더 제한적으로 필드에 대해 유효성을 검사할 수 있습니다.

    @NotEmpty(message = "name must not be empty")
    @Size(min = 2, max = 10, message = "name must be between 2 and 10 length")
    private final String name;

@NotBlank

마지막으로 @NotBlank 어노테이션에 대해 살펴보겠습니다.

사용할 도메인 클래스는 아래와 같습니다.

package com.example.validation.model;

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;

import javax.validation.constraints.NotBlank;

@Getter
@ToString
@AllArgsConstructor
public class UserNotBlank {

    @NotBlank(message = "name must not be blank")
    private final String name;
}

마찬가지로 테스트 코드를 작성해보겠습니다.

package com.example.validation.model;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

import static org.assertj.core.api.Assertions.assertThat;

public class NotBlankValidationTest {

    private Validator validator = null;

    @BeforeEach
    public void setupValidator() {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }

    @Test
    public void name이_notBlank일경우_제약조건은_존재하지_않는다() {
        // given
        UserNotBlank user = new UserNotBlank("John");

        // when
        Set<ConstraintViolation<UserNotBlank>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(0);
    }

    @Test
    public void name이_blank일경우_제약조건이_존재한다() {
        // given
        UserNotBlank user = new UserNotBlank(" ");

        // when
        Set<ConstraintViolation<UserNotBlank>> violations = validator.validate(user);

        // then
        violations.forEach(i -> System.out.println(i.getMessage()));
        assertThat(violations.size()).isEqualTo(1);
    }

    @Test
    public void name이_비어있는경우_제약조건이_존재한다() {
        // given
        UserNotBlank user = new UserNotBlank("");

        // when
        Set<ConstraintViolation<UserNotBlank>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(1);
    }

    @Test
    public void name이_null일경우_제약조건이_존재한다() {
        // given
        UserNotBlank user = new UserNotBlank(null);

        // when
        Set<ConstraintViolation<UserNotBlank>> violations = validator.validate(user);

        // then
        assertThat(violations.size()).isEqualTo(1);
    }

}

위 코드도 모두 성공하는 테스트 코드입니다.

@NotBlank 어노테이션은 NotBlankValidator 클래스의 isValid() 메소드를 오버라이드해서 사용하고 있습니다.

필드에 공백이 존재하는 경우 위 클래스에 존재하는 trim() 메소드를 통해 제거가 됩니다.

따라서 아래 메소드는 공백이 제거되므로, 유효성 검사를 통과하지 못합니다.

    @Test
    public void name이_blank일경우_제약조건이_존재한다() {
        // given
        UserNotBlank user = new UserNotBlank(" ");

        // when
        Set<ConstraintViolation<UserNotBlank>> violations = validator.validate(user);

        // then
        violations.forEach(i -> System.out.println(i.getMessage()));
        assertThat(violations.size()).isEqualTo(1);
    }

정리

이상으로 Valid의 @NotNull, @NotEmpty, @NotBlank 어노테이션에 대해 알아보았습니다.

각각 주어진 상황에 맞게 적절한 어노테이션을 사용하면 될 것 같습니다 :)

Reference

https://www.baeldung.com/java-bean-validation-not-null-empty-blank

저작자표시

'Spring' 카테고리의 다른 글

Spring AOP - (2) AOP 개념 및 실습 (0)	2021.09.24
[Spring] - 로깅: Log4j, Log4j2, Slf4j, Logback (0)	2021.09.15
Spring Boot + MockMvc 테스트(feat. Kotlin) (0)	2021.09.07
[Spring] - @JsonProperty, @JsonNaming (2)	2021.09.02
Spring AOP - (1) 프록시 패턴, 데코레이터 패턴 (0)	2021.08.27

문의사항은 zzang9ha@naver.com 로 주세요 :)

Spring Validation - @NotNull, @NotEmpty, @NotBlank