🌱 Spring MVC (7) Bean Validation 1 (입력값 검증 - Bean Validation 어노테이션, @Valid, BindingResult)

Kim Dae Hyun·2021년 7월 12일

Spring spring mvc

Spring-MVC

목록 보기

7/13

Github 소스코드

🔎 Dependencies

BeanValidation을 위한 종속성

[ build.gradle ]
implementation 'org.springframework.boot:spring-boot-starter-validation'

🔎 Bean 검증 Annotation

자주 쓰이는 Validation Annotation입니다.
공식 메뉴얼

public class Item {

    @NotNull
    private Long id;
    
    @NotEmpty(message = "상품명을 입력해주세요.")
    private String itemName;
    
    @NotNull
    @Range(min=1000, max=1000000)
    private Integer price;
    
    @NotNull
    @Range(max=100)
    private Integer quantity;
    
    @DateTimeFormat(pattern = "yyyyMMdd")
    private LocalDate createdAt;
}

🔎 @Valid

Bean Validation에서 가장 흔히 보이는 어노테이션부터 살펴볼께요.

@Valid는 요청 파라미터를 바인딩하는 객체 앞에 위치합니다.
보통 @ModelAttribute나 @RequetParam 앞이겠죠?

@PostMapping
public String test(@Valid @ModelAttribute Item item) {
	...
}

컨트롤러에 위와 같은 매개변수가 있다고 하면 item 은 요청 파라미터로 바인딩 되고 @Valid에 의해 Item 클래스에 지정된 검증 로직이 동작하는 것 입니다.
그럼 검증 결과는 어떻게 확인할 수 있을까요?

🔎 BindingResult

@Valid에 의해 검증된 결과는 BindingResult에 저장됩니다.
이름 그대로 검증 결과가 바인딩 된다고 이해해도 될 것 같아요.

@PostMapping
public String add(
	@Valid @ModelAttribute Item item, 
    	BindingResult bindingResult) {

    if (bindingResult.hasErrors()) {
        log.info("binding result = {}", bindingResult);
        return "form"; // 현재 폼을 다시 랜더링
    }

    log.info("****** 비즈니스로직 수행 ********");
	
    // 로직 성공시 요구사항 대로 redirect 또는 view를 랜더링
    return "form";
}

BindingResult는 매개변수로 받게 되는데 위치가 중요합니다.
검증하고자 하는 객체의 바로 다음에 위치해 줘야 해요.
@Valid에 의해 오류가 발생했는지 여부와 에러가 발생한 값, 에러 코드 등이 BindingResult에 바인딩 됩니다.
검증오류가 발생했다면 bindingResult.hasError()는 true를 리턴합니다.
또한 @ModelAttribute에 의해 Model에 값이 바인딩 될 때 검증에러 값도 함께 바인딩 됩니다. 그럼 View단에서 바로 검증 오류 메시지를 사용자에게 보여줄 수 있겠죠?

🔎 View단에서 검증오류 메시지 나타내기 (Thymeleaf)

상품이름(itemName)과 상품가격(price) 두 값을 입력받는 폼입니다.
폼에서 /test로 post 요청을 수행하고 해당 컨트롤로에서 검증 후 검증 결과를 Model에 담아 오류가 있다면 아래 폼을 다시 랜더링 합니다.

검증오류 발생시 다시 랜더링 되었을 때 th:errors로 해당 필드에 오류가 있는지 검사하고 있다면 지정된 에러 메시지를 나타냅니다.
th:errorclass 지정한 이름의 필드에서 검증오류 발생시 임의 class를 추가합니다. 예제에서는 클래스로 정의한 css를 검증오류 발생시 추가해줍니다.

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <style>
        .field-error {
            border-color: red;
            color: red;
        }
    </style>
</head>
<body>
<form th:action="test" th:object="${item}" method="post">

    <label for="itemName"/>
    <input type="text" id="itemName" th:field="*{itemName}" th:errorclass="itemName">
    <div th:errors="*{itemName}" class="field-error"></div>
    <br/>

    <label for="price"/>
    <input type="text" id="price" th:field="*{price}" th:errorclass="price">
    <div th:errors="*{price}" class="field-error"></div>
    <br/>

    <button type="submit">등록</button>
</form>
</body>
</html>

아무것도 입력하지 않은 상태에서 서버로 전송했을 때의 View 결과입니다.

상품명의 경우 Item의 @NotEmpty에서 지정해준 메시지가 나왔고 가격의 경우 @NotNull을 지정하고 메시지를 지정하지 않았기 때문에 Spring에서 지정한 default 메시지가 나왔습니다.

Kim Dae Hyun

좀 더 천천히 까먹기 위해 기록합니다. 🧐

이전 포스트

🌱 Spring MVC (6) 국제화 internationalization (다국어 지원)

다음 포스트

🌱 Spring MVC (8) Bean Validation 2 (View마다 다른 검증 적용 - groups, 폼 객체 분리)

1개의 댓글

Boo

2022년 6월 23일

선생님 이런 지식은 어디서 봐서 알고계신건가요? bindingresult는 매개변수 바로 다음에 오는 이런 지식이요 궁금합니다

답글 달기