Validation in Spring, Data Binding

두별·2021년 12월 1일

Spring

Spring Framework

목록 보기

7/18

패캠 초격차 Part1. Spring Framework-Ch.02 필기노트

Validation이란?

사용자 또는 서버의 요청(http request) 에서 잘못된 내용이 있는지 유효성 검사하는 단계

Validation의 종류

개발자가 주로 챙겨야 하는 검증은 크게 두종류

데이터 검증
- 필수 데이터의 존재 유무
- 문자열의 길이나 숫자형 데이터의 경우 값의 범위
- email, 신용카드 번호등 특정 형식에 맞춘 데이터
비즈니스 검증
- 서비스 정책에 따라 데이터를 확인하여 검증
- 예) 배달앱인 경우 배달 요청을 할때 해당 주문건이 결제 완료 상태인지 확인 등
- 경우에 따라 외부 API를 호출하거나 DB의 데이터까지 조회하여 검증하는 경우도 존재

Spring의 Validation

스프링은 웹 레이어에 종속적이지 않은 방법으로 밸리데이션을 하려고 의도하고 있다. 주로 두가지 방법을 활용하여 밸리데이션 진행 (데이터 검증에 가까움)

1. Java Bean Validation

- Java Bean 기반으로 간편하게 개별 데이터를 검증
- 요즘 가장 많이 활용되는 방법중 하나
- 아래 코드처럼 JavaBean 내에 어노테이션으로 검증방법을 명시함

public class MemberCreationRequest {
    @Size(max=64, message="이름의 최대 길이는 64자 입니다.")
    private String name;
    @Min(0, "나이는 0보다 커야 합니다.")
    private int age;
    @Email("이메일 형식이 잘못되었습니다.")
    private int email;

    // the usual getters and setters...
}

위처럼 DTO에 어노테이션으로 명시 후 아래처럼 @Valid 어노테이션을 해당 @RequestBody에 달게 되면, Java Bean Validation을 수행 한후 문제가 없을때에만 메서드 내부로 진입한다.
- 검증 실패시 Exception 발생


@PostMapping(value="/member")
public class MemberCreationResponse createMember{
    @valid @RequestBody final MemberCreationRequest memberCreationRequest){
    // member creaion logics here...
    }
}

2. Spring Validator 인터페이스 구현을 통한 validation

public class Person {
    private String name;
    private int age;

    // the usual getters and setters...
}

위처럼 Person이라는 JavaBean 객체가 있을 때 아래는 해당 인스턴스에서만 활용되는 validator이다.
인터페이스에 있는 두개의 메서드는 아래와 같은 역할을 한다.

supports : 이 validator가 동작할 조건을 정의, 주로 class 타입을 비교
validate : 원하는 검증을 진행한다.

public class PersonValidator implements Validator{
    /*
    * This Validator validates only Person instances
    */

    public boolean supports(Class clazz){
        return Person.class.equals(clazz);
    }

    public void validate(Object obj, Errors e){
        ValidationUtils.rejectIfEmpty(e, "name", "name.empty");
        Person p = (Person) obj;
        if(p.getAge() < 0){
            e.rejectValue("age", "negativevalue");
        }else if(p.getAge() > 110){
            e.rejectiveValue("age", "too.darn.old");
        }
    }
}

Validation 주의사항 및 패턴

주의사항

validation이 여러군데에 흩어져 있으면 테스트 및 유지보수성이 떨어짐
- 중복검증 : 정책 변경시 모든 중복 코드를 수정해야 함
- 다른 검증 : 여러 군데서 다른 정책을 따르는 검증이 수행될 수 있음
가능한 validation은 로직 초기에 수행 후 실패시에는 exception을 던지는 편이 처리가 편리함

실무 활용 패턴

주 사용 패턴
- request dto (요청을 받는 dto)에서 JavaBean validation을 이용해서 데이터 유무,형식등 1차 검증
- 실제 서비스 로직 초반에 비즈니스 검증을 실행 (사용자의 정상 상태, 처리를 하기위한 조건이 충족하는지
- 실패했을때는 excetion 처리로 예외를 던진다. 에러를 응답하는 식으로 처리를 한다.)

Spring validator의 장단점
장점 : JavaBean Validation에 비해 조금 더 복잡한 검증이 가능
단점
- Validation을 수행하는 코드를 찾기가 어렵다.
- 완전히 데이터만 검증하는것이 아니기 때문에 일부 비즈니스적인 검증이 들어가는 경우가 있음
  - 이 경우 비즈니스 검증 로직이 여러 군데로 흩어지기 때문에 잘못된 검증을 수행할 가능성이 높음 (중복 검증, 다른 정책을 따르는 검증)

Data Binding

사용자나 외부 서버의 요청 데이터를 특정 도메인 객체에 저장해서 프로그램 request에 담아주는 것을 뜻함

Converter<S,T> Interface

S(Source)라는 타입을 받아서 T(Target)이라는 타입으로 변환해주는 Interface

파라미터에 json 형식 문자열이 담겨오는 경우 해당 문자열을 곧바로 특정 DTO에 담고 싶을때 사용
Json은 결국 String, String을 받아서 변환을 해주는 툴 -> Converter<String, XAuthUser> 컴포넌트
헤더에 담긴 json 형식 문자열을 XAuthUser에 바로 담고 싶은 경우 Converter를 Bean으로 등록하면 된다.
이와 비슷하게 PAthParameter나 기타 특수한 경우의 데이터를 특정 객체에 담고 싶은 경우
- Converter를 만들어서 Spring에 Bean으로 등록
- 스프링 내에 ConversionService라는 내장된 서비스에서 COnverter 구현체 Bean들을 Cenverter 리스트에 등록
- 외부 데이터가 들어오고 Surce Class Type -> Target Class Type이 Converter에 등록된 형식과 일치하면 해당 Converter가 동작하는 원리