(Spring Boot) @Valid 유효성 처리 활용 (feat. BindingResult)

🌟 해결하고자 하는 상황

 질문 폼을 작성하여 POST request 를 날리면 Controller 에서 유효성을 확인 후 문제가 없으면 Service 로 넘겨 저장, 문제가 있으면 문제를 질문폼 View 로 넘겨서 사용자에게 알림

🌟 해결 방법

① 일단 View 로 부터 넘겨받은 값을 if null 조건문을 통해 확인, 문제가 있으면 Model 에 해당 문제의 메세지를 적어 저장 후 View 로 넘김 ➡️ 넘겨받은 모든 파라미터들에 대해 if 문을 작성해야함으로 코드가 길어짐, 또 파라미터가 추가되면 그 만큼 새로 작성해야함.

② Spring 의 @Valid 활용 ➡️  if 문을 매번 작성할 필요가 없고, 파라미터가 추가되어도 Controller 단에서는 새로 작성해야 할 내용이 없음

 

이 외에도 다양한 해결 방법이 있을 수 있겠지만 지금은 @Valid 유효성 확인 방식을 정리해보고자 한다.

🌟 해결 과정

① Valid 활용을 위한 의존성 주입

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

② 유효성 확인을 위한 제약 조건 추가

@Getter
@Setter
public static class RequestQuestionForm {
    @NotEmpty (message = "제목은 필수 사항 입니다.") // 제약 조건 (1)
    @Size(max = 100, message = "제목을 100자 이하로 입력해주세요") // 제약 조건 (2)
    private String subject;

    @NotEmpty (message = "내용은 필수 사항 입니다.") // 제약 조건 (3)
    private String content;
}

③ Contoller 에서 유효성 확인

➡️ 확인을 해야할 값에 @Valid 를 붙여주어야하고, 유효성 확인 결과를 담기위한 BindingResult 객체를 옆에 생성해주어야함

@Controller
@RequestMapping("/question")
@RequiredArgsConstructor
public class QuestionController {
 //		(생략)
    // 질문 등록 (POST)
    @PostMapping("/create")
    public String createQuestion(@Valid QuestionDto.RequestQuestionForm requestQuestionForm, BindingResult bindingResult) {
        if(bindingResult.hasErrors()) { // 유효성 확인
            return "question_form";
        }
        questionService.createQuestion(requestQuestionForm.getSubject(), requestQuestionForm.getContent());
        return "redirect:/question/list";
    }
}

@Valid 바로 옆에 BindingResult 를 두지 않으면 객체에 저장되지 않고, 그냥 에러 폼이 떠버림

④ View 에서 해당 에러 보일 수 있도록

<div layout:fragment="content" class="container my-3">
  <form method="POST" th:action="@{/question/create}" th:object="${requestQuestionForm}"  class="my-3">
<!--	(추가 시작)	-->
    <div class="alert alert-danger" role="alert" th:if="${#fields.hasAnyErrors()}">
      <div th:each="err : ${#fields.allErrors()}" th:text="${err}" />
    </div>
<!--	(추가 끝)	-->

<!--	(생략)	-->
  </form>
</div>

• 추가 (1) : form 엘리먼트 안의 th:object
• 추가 (2) : div 태그 내용

😱 문제 발생

내용만 입력하면 제목을 입력하라는 안내 문구가 뜨지만, 제목만 입력하면 안내 문구 없이 질문이 저장됨.

html 파일에서 content 에 해당하는 textarea 엘리먼트를 input 으로 바꾸니 정상적으로 처리가 되었음. textarea 일 때는 뭐가 다른가..?

➡️ (원인 파악) 이유는 알 수 없지만, textarea 의 경우 한칸의 띄어쓰기가 자동으로 들어가서 @NotEmpty 제약 조건에 걸리지 않음. 하지만 알고 보니 label 엘리먼트를 위한 for & id Mapping 과정에서 생기는 띄어쓰기 였다는...! 그냥 id & for 없애줌.

➡️ (추가 내용 정리 : 2022.10.26) : 피어리뷰를 하던 중 @NotEmpty 를 대체할 @NotBlank 를 알게되었다. 해당 어노테이션은 일반 공백 (" ") 도 허용하지 않으므로 textarea 를 쓰면서도 예외를 확인 할 수 있다!

🌟 결과

오류 메세지가 잘 나타남