SpringBoot [Bean Validation]

 

Bean Validation이란?

유효성을 검사하는 JAVA의 유효성 검사 표준 기술이다. Bean Validation은 특정한 구현체가 아니라 Bean Validation 2.0이라는 기술 표준이다. 검증 애노테이션과 여러 인터페이스의 모음이다. 

 

 

⭐ 일단 bean validation을 사용하기 전에 의존관계를 추가해주어야 한다!

Maven

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

Gradle

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

 

 

🟪 어노테이션 정리

• @NotBlank : 빈 값 + 공백만 있는 경우를 허용하지 않음
• @NotNull :  null을 허용하지 않음
• @Range(min = 10, max = 100) :  10부터 100 범위 안의 값만 허용함
• @Max(100) : 최대 100까지만 허용함
• @Email : email형식을 갖추어야 함
• @NotEmpty : null을 허용하지 않으며 공백 문자열을 허용하지 않음

이외의 다른 어노테이션들은 아래 사이트에 접속하면 된다.

Hibernate Validator 6.2.3.Final - Jakarta Bean Validation Reference Implementation: Reference Guide

 

◾ 어노테이션 어떻게 쓰는지 확인해보기

@Data
public class Item {

    @NotBlank
    private String itemName;

    @NotNull
    @Range(min = 10, max = 1000)
    private Integer price;

    @NotNull
    @Max(value = 1000)
    private Integer quantity;

}

아이템 이름은 빈칸 또는 공백이어서는 안 된다.
가격은 10 이상 1000 이하의 값이어야 한다.
수량은 1000을 넘어가면 안 된다.

 

🟪 유효성 검사를 해보자면 

    public String addItem(@Validated @ModelAttribute Item item, BindingResult bindingResult) {
    
        if (bindingResult.hasErrors()) {
            log.info("errors={}", bindingResult);
            return "items/addForm";
        }
    }

👉 유효성을 검사하기 위해서는 @Valid 또는 @Validated 어노테이션을 붙여주면 된다.

@Validated으로 검증한 객체가 유효하지 않은 객체라면 Controller의 메서드의 파라미터로 있는 BindingResult 인터페이스를 확장한 객체로 들어온다. 따라서 bindingResult.hasError() 메서드는 유효성 검사에 실패할 경우 true를 반환해서 검증하는 것이다. 바인딩에 성공한 필드만 Bean Validation을 적용한다. typeMismatch 같은 경우는 FieldError에 추가해서 BindingResult에 담는 것 같다!

 

⭐ @Valid vs @Validated의 차이점

@Valid와 @Validated모두 유효성 검사를 할 때 사용 가능한 어노테이션이다. 하지만 @Valid는 Java에서 지원하는 어노테이션이고 @Validated은 Spring에서 지원하는 어노테이션이다. 나중에 groups를 사용할 경우에는 @Valid를 사용하면 안 된다! 이건 Spring에서 지원하는 기능이기 때문에! 웬만해서는 유용한 기능이 많은 @Validated을 쓰는 게 좋을 것 같다.

 

 

 

🟪 에러 코드 수정

bean validation을 이용하면 기본적으로 디폴트 에러코드가 존재한다! 하지만 더 간결하거나 보기 좋게 바꾸고 싶으면 에러코드를 수정하면 된다.

 

errors.properties에 이런 식으로 추가시켜주면 된다.

NotBlank={0} 공백X
Range={0}, {2} ~ {1} 허용
Max={0}, 최대 {1}

{0}은 필드명을 의미한다. itemName, price, quantity 같은 거!

근데 위의 방법은 가장 우선순위가 낮다!

저거보다 우선순위를 높게 하려면 애초에 

@NotBlank(message = "공백은 입력할 수 없습니다.")

bean validation 어노테이션 입력할 때 message 속성을 사용하면 된다.

아니면 errors.properties에 더 자세한 경로로 지정해주면 된다.

typeMismatch.java.lang.Integer="숫자를 입력해주세요"

 

 

🟪 Bean Validation 한계

만약 데이터를 등록할 때와 수정할 때의 요구사항이 다를 경우에는 문제가 발생한다. 

ex) 회원가입을 할 때에는 나이가 필수 입력 값이나 수정할 때는 나이를 적지 않아도 괜찮은 경우!

이럴 경우에는 서로 충돌하게 되면서 문제가 생긴다!!

 

이를 해결할 방안은 두 가지이다

 

⚫ groups

groups를 사용하면 역할을 분리시킬 수 있다. 등록과 수정을 각각 다른 그룹으로 나누는 것이다.

위에서 말했듯이 이건 스프링이 제공해주는 기능이기 때문에 @Validated를 사용해야 한다!

 

등록용 인터페이스

public interface SaveCheck {}

 

수정용 인터페이스

public interface UpdateCheck {}

 

이렇게 각각 만들어주고 bean validation 어노테이션에 사용할 그룹을 지정해주면 된다.

@Data
public class Members {
    @NotNull(groups = {SaveCheck.class, UpdateCheck.class})
    private String name;
    
    @NotNull(groups = SaveCheck.class)
    private Integer age;
}

이 의미는 name에는 두 그룹 모두 @NotNull 어노테이션을 적용시키고, age는 회원을 등록할 때만 적용시킨다는 의미

 

그럼 컨트롤러에도 그룹을 지정해주어야 한다.

    public String addMember(@Validated(SaveCheck.class)) {}

 

 

⭐ 근데 이 방법은 너무 코드가 복잡해 보인다. 그래서 실무에서 잘 안 쓴다고 한다!

컨트롤러를 분리해서 적용하는 방법이 더 간단하고 좋다 

 

다시 Members 컨트롤러를 원래대로 바꾸어주고,

@Data
public class Members {
    private String name;
    private Integer age;
}

@Data
public class MemberSaveForm {

    @NotNull
    private String name;
    
    @NotNull
    private Integer age;
}

@Data
public class MemberUpdateForm {

    @NotNull
    private String name;
    
    private Integer age;
}

이렇게 폼을 두 개로 나누어주고 나서

 

    public String addItem(@Validated @ModelAttribute("Members") memberSaveForm form, BindingResult bindingResult, RedirectAttributes redirectAttributes) {

        if (bindingResult.hasErrors()) {
            log.info("errors={}", bindingResult);
            return "Members/addForm";
        }

        //성공 로직
        Members members = new Members();
        members.setMemberName(form.getMemberName());
        members.setAge(form.getAge());

        Members savedMember = membersRepository.save(members);
        redirectAttributes.addAttribute("itemId", savedMember.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/items/{itemId}";
    }

이런 식으로 컨트롤러를 수정하면 된다. 

@ModelAttribute를 왜 수정했냐, 폼을 두 개로 나누고 나서 적용해야 하는 bean validation 어노테이션이 다른데, model attribute에 ("Members")를 안 해주게 되면

model.addAttribute("memberSaveForm", form);

이렇게 memberSaveForm이라는 MVC Model에 담기게 되기 때문에 꼭 이름을 넣어주어야 한다.