[스프링 MVC] 스프링 타입 컨버터

스프링 MVC 2편의 강의 내용을 정리한 포스팅입니다.

---

스프링 타입 컨버터

문자를 숫자로 변환하거나, 숫자를 문자로 변환해야 하는 것처럼 타입을 변환해야 하는 경우가 많다.

HTTP 쿼리 스트링으로 전달되는 데이터는 문자임에도 불구하고 @RequestParam을 사용하면 문자를 Integer 타입으로도 받을 수 있다. 이것은 스프링이 중간에서 문자를 숫자로, 타입을 변환해 주었기 때문이다.

 

문자를 숫자로 바꾸는 것 외에도 숫자를 문자로 변경하거나 Boolean 타입을 숫자로 변경하는 것도 가능한데, 이는 스프링이 확장 가능한 컨버터 인터페이스를 제공하기 때문이다. 인터페이스를 구현해서 등록하면 되기 때문에 새로운 타입을 만들어서 변환하는 것 또한 가능하다.

 

 

Converter

타입 컨버터를 사용하기 위해서는 Converter 인터페이스를 구현하면 되는데, 다음과 같이 구현할 수 있다.

뿐만 아니라 String을 사용자가 정의한 타입으로 변경하는 것도 Converter<String, T> 형식의 인터페이스를 구현하면 된다.

public class IntegerToStringConverter implements Converter<Integer, String> {
    @Override
    public String convert(Integer source) {
        return String.valueOf(source);
    }
}

 

 

ConversionService

타입 컨버터만 이용할 경우 컨버터를 하나하나 직접 사용해야 하는 불편함이 있는데, 이때 타입 컨버터를 등록하고 관리하면서 편리하게 변환 기능을 제공하는 역할을 하는 것이 컨버전 서비스이다. 스프링은 컨버전 서비스를 통해 개별 컨버터를 모아두고 묶어서 편리하게 사용할 수 있는 기능을 제공한다.

public interface ConversionService {
    //컨버팅 가능 여부 확인
    boolean canConvert(@Nullable Class<?> sourceType, Class<?> targetType);

    boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor
            targetType);

    //컨버팅 기능
    <T> T convert(@Nullable Object source, Class<T> targetType);

    Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType,
                   TypeDescriptor targetType);
}

컨버전 서비스는 다음과 같이 활용할 수 있다.

public class ConversionServiceTest {
    @Test
    void conversionService() {
        DefaultConversionService conversionService = new DefaultConversionService();
        conversionService.addConverter(new StringToIntegerConverter());
        conversionService.addConverter(new IntegerToStringConverter());
        conversionService.addConverter(new StringToIpPortConverter());

        assertThat(conversionService.convert("10", Integer.class)).isEqualTo(10);
        assertThat(conversionService.convert(10, String.class)).isEqualTo("10");
    }
}

ConversionService 인터페이스를 구현한 DefaultConversionService는 추가적으로 컨버터를 등록하는 기능도 제공한다.

 

등록과 사용 분리

컨버터를 등록할 때는 StringToIntegerConverter와 같은 타입 컨버터를 명확하게 알아야 하지만, 사용하는 입장에서는 타입 컨버터에 대해 몰라도 된다. 타입 컨버터들은 컨버전 서비스 내부에 숨어서 동작하기 때문이다.(conversionService.convert() 이용)

따라서 타입을 변환하는 사용자는 컨버전 서비스 인터페이스에만 의존하면 된다.

 

인터페이스 분리 원칙(ISP)

DefaultConversionService는 두 가지 인터페이스를 구현했는데, 컨버터 사용에 초점을 맞춘 와 컨버터 등록에 초점을 맞춘 이다.

이렇게 인터페이스를 분리함으로써 컨버터를 사용하는 입장과 컨버터를 등록하고 관리하는 입장의 관심사를 명확하게 분리할 수 있기 때문에 컨버터를 사용하는 쪽에서는 자신에게 필요한 메서드만 알게 된다. 따라서 클라이언트가 자신이 이용하지 않는 메서드에 의존하지 않는 인터페이스 분리 원칙을 만족하고 있다.

 

다만 메시지 컨버터(HttpMessageConverter)에는 컨버전 서비스가 적용되지 않는데, 특히 객체를 JSON으로 변환하는 메시지 컨버터는 내부적으로 Jackson 같은 라이브러리를 사용하기 때문에 변환 결과 또한 해당 라이브러리에 달려있다. 만약 JSON으로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정해야 한다.

 

 

컨버터 적용하기

스프링에 적용

아래와 같이 스프링에 컨버터를 적용할 수 있다.

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToIntegerConverter());
        registry.addConverter(new IntegerToStringConverter());
    }
}

스프링은 내부적으로 컨버전 서비스를 지원하기 때문에 WebMvcConfigurer가 제공하는 addFormatters()를 이용해 추가하고 싶은 컨버터를 등록하면 된다. 이렇게 하면 스프링은 내부에서 사용하는 컨버전 서비스에 컨버터를 추가해 준다.

 

추가적으로 스프링은 내부에서 수많은 기본 컨버터들이 제공되기 때문에 직접 컨버터를 등록하지 않아도 기본적인 타입 변환이 가능하다.

 

뷰 템플릿에 적용

타임리프는 ${{}}를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해 준다. 이때 스프링과 통합되어서 스프링이 제공하는 컨버전 서비스를 사용하므로, 사용자가 직접 등록한 컨버터를 이용할 수도 있다.

 

 

Formatter

컨버터는 입출력 타입에 제한이 없는, 범용 타입 변환 기능을 제공한다.

하지만 일반적으로 문자를 다른 타입으로 변환하거나, 다른 타입을 문자로 변환하는 상황이 다수를 차지한다. 이렇게 객체를 특정한 형식에 맞추어 문자로 출력하거나 그 반대의 역할을 하는 것에 특화된 기능이 포맷터이다. 포맷터는 컨버터의 특별한 버전이라고 할 수 있다.

public interface Printer<T> {
    String print(T object, Locale locale); //객체를 문자로 변경
}

public interface Parser<T> {
    T parse(String text, Locale locale) throws ParseException; //문자를 객체로 변경
}

public interface Formatter<T> extends Printer<T>, Parser<T> { //두 인터페이스를 구현한 포맷터
}

아래와 같이 숫자 1000을 문자 1,000으로 변환하는, 쉼표를 넣어주는 포맷을 적용해 볼 수 있다.

NumberFormat 객체는 Locale 정보를 통해 나라별로 다른 숫자 포맷을 만들어준다.

public class MyNumberFormatter implements Formatter<Number> {
    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        NumberFormat format = NumberFormat.getInstance(locale);
        return format.parse(text);
    }

    @Override
    public String print(Number object, Locale locale) {
        return NumberFormat.getInstance(locale).format(object);
    }
}

 

 

포맷터를 지원하는 컨버전 서비스

ConversionService에는 컨버터만 등록할 수 있고 포맷터를 등록할 수는 없는데, 생각해 보면 포맷터는 객체를 문자로, 문자를 객체로 변환하는 특별한 컨버터일 뿐이다. 따라서 포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있다. 내부에서 어댑터 패턴을 사용해서 포맷터가 컨버터처럼 동작하도록 지원한다.

 

FormattingConversionService는 포맷터를 지원하는 컨버전 서비스이다.

DefaultFormattingConversionService는 FormattingConversionService에 기본적인 통화, 숫자 관련 몇 가지 기본 포맷터를 추가해서 제공한다.

 

또한 FormattingConversionService는 ConversionService 관련 기능을 상속받기 때문에 결과적으로 컨버터도 포맷터도 모두 등록할 수 있다. 사용할 때는 컨버전 서비스가 제공하는 convert를 사용하면 된다. 스프링 부트의 경우 DefaultFormattingConversionService를 상속받은 WebConversionService를 내부적으로 사용한다.

 

 

스프링이 제공하는 기본 포맷터

스프링은 자바에서 기본으로 제공하는 타입에 대해 많은 포맷터를 기본으로 제공한다. 그런데 포맷터는 기본 형식이 지정되어 있어 객체의 각 필드마다 다른 형식으로 포맷을 지정하기는 어려운데, 이러한 문제를 해결하기 위해 스프링은 애노테이션 기반으로 원하는 형식을 지정해서 사용할 수 있는 유용한 포맷터 두 가지를 제공하고 있다.

 

@NumberFormat - 숫자 관련 형식 지정 포맷터

@DateTimeFormat - 날짜 관련 형식 지정 포맷터

@Data
static class Form {
    @NumberFormat(pattern = "###,###")
    private Integer number;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime localDateTime;
}