[SPRING] Bean Validation

🥜 Bean Validation

검증 기능을 매번 BingdingResult처럼 코드로 구현하는건 좀 힘들다... 이렇게 되면 작은 프로젝트는 괜찮지만, 조금만 프로젝트가 커져도 Controller의 크기가 너무너무 커지며 단일 책임 원칙에 위배된다.

이 문제를 해결하기 위해 나온 방법이 바로 ⭐️Bean Validation⭐️
: 제약 조건을 설정해 올바른 값을 가지고 있는지 검증하는 표준화된 방법

1. Bean Validation은 기술 표준 인터페이스
2. 다양한 Annotation들과 여러가지 Interface로 구성
   : Bean Validation(인터페이스) 구현체인 Hibernate Validator를 사용한다.

잘 모를땐 언제나 공식 문서를 참조하자!
📄 Hibernate Validator 공식 문서

먼저 의존성을 추가해야한다

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

Annotation들

Annotation	조건
@NotNull	null ❌ / 공백(” “) ❌ / 빈값(””) ❌ / CharSequence 타입 허용
@NotBlank	null ❌ / 모든 타입
@NotEmpty	null ❌ / 빈값(””) ❌ / CharSequence, Collection, Map, Array 허용

@Range(min = 1, max = 120) 와 같은
Annotation을 적용시키는것 만으로 Validation을 핵쉽게 사용 가능하다!!( 갸뀰)

@Data
public class TestDto{
	@notBlank
    private String stringField;
    
    @NotNull
    @Range(min = 1, max = 9999)
    private Integer integerField;

단순히 Annotation을 선언해주면 검증이 완료되는 이유는 Validator가 존재하기 때문
Spring Boot는 validation 라이브러리를 설정하면
'org.springframework.boot:spring-boot-starter-validation' 자동으로 Bean Validator를
Spring에 통합되도록 설정해준다!

@Valid vs @Validated

Annotation	특징
@Valid	Java 표준 검증 어노테이션
@Validated	Spring에서 제공하는 확장 어노테이션, Group Validation 지원

@Validated를 사용하면 특정 그룹을 지정하여 검증을 수행 가능!

💭 오류 Message 수정하기

Bean Validation을 적용한 후 검증오류 확인하면 오류가 어노테이션 이름으로 등록된 것을 볼 수 있따.
근데 나는 다른 메세지를 전달하고 싶을 수도 있자나..?

그럴땐 message 속성을 사용하자

@Data
public class TestDto {
	@NotBlank(message = "메세지 수정 가능")
	private String stringField;
}

groups vs DTO 분리

만약 post할때는 가격의 범위가 100이상이어야하는데, put(수정)할때는 가격 범위가 상관없어도 된다면,, 범위 설정을 따로 해주어야할 것이다

이때 사용할 수 있는 것이 바로 Spring의 groups 기능과 DTO를 따로 분리해주는 것이다!

1. groups 사용하기

// 저장용 group
public interface SaveCheck {
}
// 수정용 group
public interface UpdateCheck {
}
@Data
public class ProductRequestDtoV2 {
	// 저장, 수정 @NotBlank Validation 적용
	@NotBlank(groups = {SaveCheck.class, UpdateCheck.class})
	private String name;
	// 사용하는 모든곳에서 @NotNull Validation 적용, 저장만 @Range 반영
    @NotNull
	@Range(min = 10, max = 10000, groups = SaveCheck.class)
	private Integer price;
 ...
 
@RestController
public class ProductController {
	@PostMapping("/v2/product")
	public String save(
	// 저장 속성값 설정
	@Validated(SaveCheck.class) @ModelAttribute ProductReques
) {
		log.info("생성 API가 호출 되었습니다.");
		// Validation 성공시 repository 저장로직 호출
		return "상품 생성이 완료되었습니다";
	}
	@PutMapping("/v2/product/{id}")
	public String update(
		@PathVariable Long id,
		// 수정 속성값 설정
		@Validated(UpdateCheck.class) 
        ...

groups를 사용하면 따로 지정해줄 수 있지만, UpdateCheck, SaveCheck처럼 따로 만들어서 각각 적용해주어야하기 때문에 코드의 가독성이 매우매우 떨어진다ㅠㅠ

만약 groups 를 사용하고 싶다면 @Valid가 아닌@Validated를 사용하도록 하자 (groups는 자바가 아니라 스프링의 기능이기 때문)

될 수 있으면 DTO를 분리해서 사용하는 방식을 사용하도록 하자

2. 👍 DTO 분리
네이밍은 일관성있게 작성하기(SaveRequestDto, UpdateRequestDto)
웬만하면 DTO를 분리하는 방향으로 작성하는게 제일 좋다!!

✅ @ModelAttribute vs @RequestBody 검증 흐름 차이

구분	@ModelAttribute	@RequestBody
데이터 바인딩	폼 데이터 (x-www-form-urlencoded, multipart/form-data)	JSON (application/json)
검증방식	BindingResult 사용 가능 (FieldError, ObjectError 직접 처리 가능)	@Valid 또는 @RequestBody 검증 실패 시 예외 발생
컨트롤러 호출 여부	오류 있어도 컨트롤러 메서드 실행	검증 오류가 있으면 컨트롤러가 실행되지 않음
오류 담는 곳	BindingResult에 저장	MethodArgumentNotValidException 발생
오류 처리 방법	bindingResult.hasErrors()로 컨트롤러에서 직접 처리 가능	@ExceptionHandler 또는 ControllerAdvice를 사용하여 예외 처리 필요

@RequestBody의 경우 오류가 생기면 컨트롤러가 호출되지 않는다!
→ @RequestBody의 검증 오류를 처리하려면 @ExceptionHandler 또는 @ControllerAdvice가 필요함.

✔ @ModelAttribute와 @RequestBody 모두 FieldError와 ObjectError를 가질 수 있음

FieldError
: 특정 필드(속성) 에 대한 검증 오류.
제약 조건(@NotNull, @NotBlank, @Size 등)을 위반하면 발생.

ObjectError
특정 필드가 아니라 객체 전체에 대한 오류.
비즈니스 로직 검증에 많이 사용됨 (예: 비밀번호 확인, 날짜 검증 등).
BindingResult.getGlobalErrors()로 확인 가능.