인프런 커뮤니티 질문&답변

기혁님의 프로필 이미지
기혁

작성한 질문수

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술

Collection Bean 검증 질문입니다

해결된 질문

작성

·

338

0

안녕하세요! 영한님! 항상 강의 잘 보고 있습니다. 사실은 영한님 팬이기도 해요.

아무튼 제가 며칠 계속 고민하던 부분이 있어요.

제 목표는 컬렉션 타입과 상관 없이 컬렉션 안에 선언되어 있는 객체의 Bean Validation을 수행하고 싶어요.

@RequestBody @Validated List<ItemSaveForm> 를 사용하게 되면 ItemSaveForm에 대한 검증이 아닌 List에 대한 검증 처리가 되더라고요. 그렇다고 List<@Validated ItemSaveForm> 는 컴파일 에러가 납니다.

물론 저 스스로 해결하고자 많은 곳을 돌아 다녀 보았고 찾아낸 방법은 Validator를 구현한 객체(CollectionValidator)를 만들어서 validate 메서드 구현 을 했습니다. 이후 ItemController에서 CollectionValidation 를 주입 받아 collectionValidator.validate(itemList, bindingResult);를 통해서 검증 처리를 하는 법을 알아냈습니다.

하지만 모든 Collection 마다 주입과 collectionValidator.validate 코드를 넣는게 비효율적이라 생각해서 어노테이션으로 만들거나 인터셉터에서 처리하고 싶었습니다.

  1. 인터셉터에서 처리하고 싶었지만 CollectionValidation의 validate 메서드는 Errors 객체를 인자로 받는데 HandlerMethodArgumentResolver의 resolveArgument인자에서 errors 객체를 뽑아낼 방법이 안보이네요.

  2. 어노테이션으로 만들고자 한 부분은 어노테이션 안에 Errors 객체를 선한 할 수가 없어서 CollectionValidator를 불러낼 수가 없었습니다.

다른 해결 책이 있을 까요? 아니면 제가 보지 못한 부분이 있었던 걸까요?

혹시 결국 스프링 입문때 잠시 다루었던 AOP를 통해서만 해결할 수 있는 걸까요? 어노테이션 만들기를 검색하다보니 AOP를 결국 다뤄야 하더라고요 ㅜㅜ

아래 제 코드와 함께 올리겠습니다.

@Data
public class PatternDto {
     //이 어노테이션에게 검증을 맡기고자 합니다.
    @Pattern(regexp = "^01(?:0|1|[6-9])[.-]?(\\d{3}|\\d{4})[.-]?(\\d{4})$", message ="잘못된 번호 형식입니다.")
    private String phoneNumber;

}
@RestController
public class ValidationItemApiController {

    //private final CollectionValidator validator;
    @PostMapping("/list")
    public Object addList(@RequestBody List<PatternDto> request, BindingResult bindingResult){
        //validator.validate(request, bindingResult); -> 이 부분을 어노테이션이나 인터셉터로 처리하고 싶어요.
        log.info("list valid");

        if(bindingResult.hasErrors()){
            log.error("검증 오류 발생 {}", bindingResult);
            return bindingResult.getAllErrors();
        }

        log.info("성공 로직 실행");
        return request;
    }
}
@Component
@Slf4j
public class CollectionValidator implements Validator {
    private SpringValidatorAdapter validator;

    public CollectionValidator() {
        this.validator = new SpringValidatorAdapter(
                Validation.buildDefaultValidatorFactory().getValidator()
        );
    }
    @Override
    public boolean supports(Class<?> clazz) {
        return true;
    }

    @Override
    public void validate(Object target, Errors errors) {
        if(target instanceof Collection){
            Collection collection = (Collection) target;

            for (Object o : collection) {
                validator.validate(o,errors);
            }
        }
        else validator.validate(target,errors);
    }
}
//이 검증기를 통해 List<@Valid PatternDto>와 같이 검증하고 싶었지만
//validtor.validate에게 검증을 위임하려고 할때(많은 검증 로직들이 간소화 되기 때문에) validate메서드의 두번째 인자인 errors
//에 넣을 값을 찾지 못한게 문제였습니다.
//ArgumentResolver를 통해 해결하고자 했지만 이때도 validate의 errors 인자를 넣을 값을 못찾았습니다.
@Component
@Slf4j
@RequiredArgsConstructor
public class CustomValidator implements ConstraintValidator<CustomValid, List<PatternDto>> {

    private final CollectionValidator validator;

    @Override
    public void initialize(CustomValid constraintAnnotation) {
        ConstraintValidator.super.initialize(constraintAnnotation);
    }

    @Override
    public boolean isValid(List<PatternDto> values, ConstraintValidatorContext context) {
        log.info("validator 로직 실행");
        validator.validate(values,null);
        //null 대신에 어떤 값을 넣어야 할까요? 이 부분만 해결 되어도 문제가 해결 될거 같아요.

        return true;
    }
}

답변 1

기혁님의 프로필 이미지
기혁
질문자

안녕하세요 David님!

답변 감사해요. 하지만 이미 저 두 글은 다 봤던 글이에요.

제가 첫번째 링크로 올리신 블로그를 참고해서 검증 로직을 수행했었어요. 일단은 블로그와는 다르게 List배열 DTO를 따로 만들지 않아도 수행 가능 하더라고요.

제 질문은 Controller 코드에 validator.validate(DTO,bindingResult); 이 코드를 넣게 되는데, 컬랙션 객체마다 반복되는 코드를 넣고 싶지 않아서 어노테이션으로 만들고자 했었어요. 이 부분에서 막혔던 겁니다.

두번째 링크로 봤던 공식 문서에는 custom 검증 규칙을 만들고 등록해서 List<@Valid DTO>와 같이 <>안에 @Valid를 넣는 내용인데 이 방식을 제가 고려하지 않은 이유는 collection 안에 들어있는 객체마다 검증 규칙을 만들어 주어야 한다는 것과 어노테이션을 이용한 검증을 할수 없다는 점 때문에 선택하지 않았습니다.

정리하자면 제 질문의 요점은 어떠한 Collection 안에 있는 DTO 객체들에 대한 검증을 DTO에 선언되어 있는 validation.constraint를 통해 검증하고 싶었어요.

제가 질문을 어렵게 한거 같네요! 답변 감사합니다. 코드를 같이 첨부해서 질문하도록 할께요.

우선, 예상하신대로 AOP를 사용하는 방법이 있네요.

별도의 애노테이션을 만들고, 해당 애노테이션을 감지하는 AOP를 적용하면 AOP 내부에서 Validator 사용하고, BindingResult 만들어서 validate 처리하면 될 것 같습니다.

 

validate(object, bindingResult)에서 BindingResult 부분은 BeanPropertyBindingResult, DirectFieldBindingResult를 생성해서 전달하시면 됩니다

예시를 들만한 코드를 찾다가 DataBinder 내부 코드를 살펴보았습니다. validate을 수행하기 위해 둘 중 하나를 만들어서 넘겨주고 있습니다. 참고해주세요.

image

기혁님의 프로필 이미지
기혁
질문자

감사합니다! 많은 도움이 되었네요.

AOP도 꼭 마스터 해서 적용해볼께요

기혁님의 프로필 이미지
기혁

작성한 질문수

질문하기