@Valid와 BindingResult의 관계 및 처리 방법

@Valid와 BindingResult는 Spring Framework에서 데이터 유효성 검증을 처리하는 데 핵심적인 역할을 하는 어노테이션과 인터페이스
이 둘은 밀접하게 연관되어 함께 사용되며, 컨트롤러에서 클라이언트로부터 받은 데이터를 검증하고 그 결과를 처리하는 데 활용된다.

1. @Valid 어노테이션:

• 역할: @Valid 어노테이션은 컨트롤러의 메서드 파라미터에 적용되어 해당 파라미터로 전달되는 객체에 대해 유효성 검증을 수행하도록 Spring에게 지시
• 적용 대상: 주로 @RequestBody, @ModelAttribute 등으로 바인딩되는 객체에 적용
• 동작 방식:
  • @Valid가 적용된 객체가 컨트롤러 메서드에 전달되기 전에, Spring은 해당 객체에 설정된 **유효성 검증기(Validator)**를 찾아서 실행
  • 유효성 검증기는 해당 객체의 필드에 적용된 유효성 어노테이션(예: @NotNull, @Size, @Email, @Min, @Max 등)을 기반으로 검증을 수행
  • 검증 결과, **유효성 위반 사항(errors)**이 발생하면 해당 정보는 BindingResult 객체에 담는다

2. BindingResult 인터페이스:

• 역할: BindingResult는 유효성 검증 결과를 담는 객체. 컨트롤러 메서드의 파라미터로 선언하여 유효성 검증 과정에서 발생한 오류 정보를 확인할 수 있다.
• 위치: @Valid 어노테이션이 적용된 객체 파라미터 바로 다음에 위치해야 합니다. 순서가 중요
• 제공 기능:
  • 오류 존재 확인: hasErrors(), hasFieldErrors(String fieldName) 등을 통해 전체 또는 특정 필드에 오류가 있는지 확인할 수 있다.
  • 오류 목록 접근: getAllErrors(), getFieldErrors(), getGlobalErrors() 등을 통해 발생한 모든 오류, 필드별 오류, 글로벌 오류 목록에 접근할 수 있다.
  • 특정 오류 정보 접근: getFieldError(String fieldName), getGlobalError() 등을 통해 특정 필드 또는 글로벌 오류 정보를 얻을 수 있다.
  • 오류 코드 및 메시지 접근: 각 FieldError나 ObjectError 객체를 통해 오류 코드(getCode()), 기본 메시지(getDefaultMessage()), 오류 발생 필드(getField()) 등의 정보를 얻을 수 있다.

3. @Valid와 BindingResult의 관계:

• @Valid 어노테이션이 유효성 검증을 트리거한다.
• BindingResult는 @Valid에 의해 수행된 유효성 검증의 결과를 담는 컨테이너 역할
• 반드시 함께 사용되어야 한다. @Valid만 사용하고 BindingResult 파라미터를 생략하면 유효성 검증 실패 시 예외(MethodArgumentNotValidException)가 발생하여 정상적인 오류 처리가 불가능하다.

4. 유효성 검증 처리 방법:

컨트롤러 메서드에서 @Valid와 BindingResult를 함께 사용하여 유효성 검증 결과를 처리하는 일반적인 방법은 다음과 같다.

import javax.validation.Valid;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/api")
public class MyController {

    @PostMapping("/users")
    @ResponseBody
    public String createUser(@Valid @RequestBody UserRequestDto userRequestDto, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            // 유효성 검증 실패 시 처리 로직
            StringBuilder errorMessage = new StringBuilder();
            bindingResult.getFieldErrors().forEach(error -> {
                errorMessage.append(error.getField())
                            .append(": ")
                            .append(error.getDefaultMessage())
                            .append("<br>");
            });
            return "Validation Failed:<br>" + errorMessage.toString(); // 예시: 에러 메시지 반환
            // 또는 에러 정보를 담은 DTO를 생성하여 반환
            // return ErrorResponse.of(bindingResult);
        }

        // 유효성 검증 성공 시 처리 로직
        // User 생성 서비스 호출 등
        return "User created successfully!";
    }
}

처리 단계:

1. 데이터 바인딩: 클라이언트로부터 전송된 데이터는 @RequestBody 또는 @ModelAttribute 등을 통해 UserRequestDto 객체에 바인딩한다.
2. 유효성 검증 실행: @Valid 어노테이션에 의해 UserRequestDto 객체에 대한 유효성 검증이 수행
3. 오류 확인: BindingResult 객체의 hasErrors() 메서드를 사용하여 유효성 검증 실패 여부를 확인
4. 오류 처리:
   • bindingResult.hasErrors()가 true를 반환하면, BindingResult 객체에서 발생한 오류 정보를 추출하여 적절한 방식으로 처리한다.
   • 일반적으로 오류 메시지를 클라이언트에게 반환하거나, 오류 정보를 로깅하거나, 특정 에러 페이지로 리다이렉트하는 등의 작업을 수행한다.
   • getFieldErrors()를 통해 필드별 오류 정보를 얻고, getDefaultMessage()를 통해 유효성 어노테이션에 설정된 기본 오류 메시지를 확인할 수 있다.
5. 성공 처리: bindingResult.hasErrors()가 false를 반환하면, 유효성 검증이 성공했으므로 정상적인 비즈니스 로직(예: 데이터베이스 저장, 서비스 호출 등)을 수행한다.

5. 추가적인 고려 사항:

• 글로벌 유효성 검증: 특정 필드에 국한되지 않은 객체 레벨의 유효성 검증이 필요한 경우, Validator 인터페이스를 직접 구현하고 @InitBinder를 통해 컨트롤러에 등록하여 사용할 수 있다. 이때 발생한 글로벌 오류는 bindingResult.getGlobalErrors()를 통해 접근할 수 있다.
• 오류 메시지 관리: 유효성 어노테이션에 기본 오류 메시지 대신 message 속성을 사용하여 사용자 정의 오류 메시지를 설정할 수 있다. 또한, messages 소스 파일(messages.properties 등)을 사용하여 오류 코드를 기반으로 다국어 처리된 오류 메시지를 관리하는 것이 일반적이다.
• API 응답 형식: RESTful API를 개발할 때는 유효성 검증 실패 시 일관된 형식의 에러 응답(예: JSON 형태의 에러 코드, 메시지, 필드별 오류 정보 등)을 클라이언트에게 반환하는 것이 좋다.

결론적으로, @Valid는 유효성 검증을 시작하는 트리거 역할을 하며, BindingResult는 그 검증 결과를 담아 처리할 수 있도록 제공하는 핵심 인터페이스 이 둘을 함께 사용하여 Spring 애플리케이션에서 효과적인 데이터 유효성 검증을 구현할 수 있다.