[스프링 부트] BindingResult 사용 - 25

기존에 @Valid로 유효성 검사를 했으나

이번에 배운 BindingResult를 적용해보고자 다시 수정해보았다.

 

글로벌 에러와 타입 에러를 적용해보고자

뜬금 없지만 게시글 작성시 키와 몸무게도 입력하게 바꿨다.

 

키와 몸무게 컬럼 추가

ALTER TABLE poster ADD height bigint;
ALTER TABLE poster ADD weight bigint;

 

BindingResult 사용

@PostMapping("/posters/{category}")
public String write(@ModelAttribute Poster poster, BindingResult bindingResult){

        if(poster.getHeight()!=null && poster.getWeight()!=null) {
            Long height = poster.getHeight();
            Long weight = poster.getWeight();

            if(height+weight<150) {
                //bindingResult.addError(new ObjectError("poster", "키와 몸무게의 합은 150이상이여야 합니다."));
                bindingResult.addError(new ObjectError("poster", null, null, "키와 몸무게의 합은 150이상이여야 합니다."));
            }
        }

        // input의 type=text는 아무것도 입력하지 않아도 null이 되진 않음을 주의.
        if(poster.getTitle().equals("")) {
            bindingResult.addError(new FieldError("poster", "title", "제목을 입력하세요."));
        }
        
        if(bindingResult.hasErrors()) {
            return "posters/createPosterForm";
        }
        
        ...
    }

주의사항!

BindingResult 파라미터의 위치는 @ModelAttribute 다음에 있어야한다.

BindingResult 사용시 뷰에 Model에 담아 Model.addAttribute("errors", bindingResult)로 보내줄 필요없다.

BindingResult는 자동으로 뷰에 담아준다.

 

1. 글로벌 에러

if(poster.getHeight()!=null && poster.getWeight()!=null) {
    Long height = poster.getHeight();
    Long weight = poster.getWeight();

    if(height+weight<150)
        bindingResult.addError(new ObjectError("poster", "키와 몸무게의 합은 150이상이여야 합니다."));
}

특정 필드가 아닌 에러는 ObjectError 객체를 생성하여 에러를 추가한다.

 

ObjectError 생성자

public ObjectError(String objectName, @Nullable String defaultMessage) {
    this(objectName, null, null, defaultMessage);
}

• objectName: @ModelAttribute의 이름을 작성한다.

 

2. 필드 에러

if(poster.getTitle().equals("")) {
    bindingResult.addError(new FieldError("poster", "title", "제목을 입력하세요."));
}

특정 필드의 에러는 FieldError 객체를 생성하여 에러를 추가한다.

 

FieldError 생성자

public FieldError(String objectName, String field, String defaultMessage) {
    this(objectName, field, null, false, null, null, defaultMessage);
}

• field: ObjectError와 다르게 에러가 발생한 필드명을 넣어준다.

 

게시글 작성 HTML

<form class="w-50 h-50" th:action method="post" th:object="${poster}">

    <!-- 필드 에러 -->
    <input placeholder="제목" type="text" name="title" th:field="*{title}">
    <label>제목</label>
    <span th:errors="*{title}"></span>


    <!-- 글로벌 에러 -->
    <div th:if="${#fields.hasGlobalErrors()}">
    <p th:each="error : ${#fields.globalErrors()}" th:text="${error}"></p>
    </div>
</form>

 

타임리프는 스프링의 BindingResult의 기능을 지원한다.

• #fields : #fields로 BindingResult에 접근한다.
• th:errors : 해당 필드에 오류가 있는 경우 태그를 출력하며(th:if와 유사) defaultMessage 텍스트가 출력이된다.

 

어떻게 에러가 발생한 입력 값을 유지하는걸까?

th:field="*{title}"는 정상적인 상황에서는 모델 객체의 값을 사용하며. 에러가 발생한 필드에 대해서는 FieldError에서 보관한 값을 사용

 

그렇다 현재는 @ModelAttribute에 입력 값이 바인딩되는 시점에 에러가 발생했기에

사용자가 입력한 값을 유지하기 어려운 상황이다.

 

FieldError, ObjectError의 다른 생성자를 사용해서 문제를 해결할 수 있다.

 

ObjectError 다른 생성자 사용

bindingResult.addError(new ObjectError("poster", null, null, "키와 몸무게의 합은 150이상이여야 합니다."));

 

ObjectError 생성자

public ObjectError(String objectName, @Nullable String[] codes, @Nullable Object[] arguments, @Nullable String defaultMessage) 
{ ... }

• codes: 메시지 코드
• arguments: 메시지에 사용하는 인자
• defaultMessage: 기본 오류 메시지

 

FieldError 다른 생성자 사용

bindingResult.addError(new FieldError("poster", "height", poster.getHeight(), false, null, null, "키는 100이상이어야 합니다."));

 

FieldErorr 생성자

public FieldError(String objectName, String field, @Nullable Object rejectedValue, boolean bindingFailure,
			@Nullable String[] codes, @Nullable Object[] arguments, @Nullable String defaultMessage) {

• rejectedValue: 사용자가 입력한 값(입력 데이터 유지시 사용)
• bindingFailure: 바인딩 에러의 종류를 작성한다. 타입 에러와 같은 바인딩 에러인지, 검증 실패인지
  • 현재 타입 에러로 바인딩 에러가 발생한 것이 아니라 검증에서 실패한 상황이므로 false를 사용했다. 

 

앞전에 유효성 검사로 사용한 Errors와 BindingResult의 차이점이 있을까?

if(errors.hasErrors()) {
    ...
}

앞전에 Errors 파라미터도 받고 BindingResult.hasErrors()와 유사한 errors.hasErrors()를 사용했다. 뭐가 다를까?

 

BindingResult는 인터페이스이며 Errors 인터페이스를 상속받는다.

Errors 인터페이스에 추가적인 기능을 추가한게 BindingResult이다.

실제 구현체로는 BeanPropertyBindingResult이다.