Link Search Menu Expand Document
melodist Dev Records

10. 스프링 타입 컨버터

스프링 타입 컨버터 소개

스프링의 타입 변환 적용 예

  • 스프링 MVC 요청 파라미터
  • @RequestParam, @ModelAttribute, @PathVariable
  • @Value 등으로 YML 정보 읽기
  • XML에 넣은 스프링 빈 정보를 변환
  • 뷰를 렌더링 할 때

컨버터 인터페이스

public interface Converter<S, T> {
  T convert(S source);
}
  • 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현해서 등록
  • 컨버터 인터페이스는 모든 타입에 적용 가능. 필요하면 X → Y 타입으로 변환하는 컨버터 인터페이스를 만들고, 또 Y → X 타입으로 변환하는 컨버터 인터페이스를 만들어서 등록

    참고 과거에는 PropertyEditor라는 것으로 타입을 변환했다. PropertyEditor는 동시성 문제가 있어서 타입을 변환할 때 마다 객체를 계속 생성해야 하는 단점이 있다. 지금은 Converter의 등장으로 해당 문제들이 해결되었고, 기능 확장이 필요하면 Converter를 사용하면 된다.

타입 컨버터 - Converter

타입 컨버터를 사용하려면 org.springframework.core.convert.converter.Converter 인터페이스를 구현하면 됨

StringToIntegerConverter - 문자를 숫자로 변환하는 타입 컨버터

@Slf4j
public class StringToIntegerConverter implements Converter<String, Integer> {
  
    @Override
    public Integer convert(String source) {
        log.info("convert source={}", source);
        return Integer.valueOf(source);
    }
}
  • String → Integer로 변환하기 때문에 소스가 String
  • 이 문자를 Integer.valueOf(source)를 사용해서 숫자로 변경한 다음에 변경된 숫자를 반환

IntegerToStringConverter - 숫자를 문자로 변환하는 타입 컨버터

@Slf4j
public class IntegerToStringConverter implements Converter<Integer, String> {
    @Override
    public String convert(Integer source) {
        log.info("convert source={}", source);
        return String.valueOf(source);
    }
}
  • 숫자가 입력되기 때문에 소스가 Integer
  • String.valueOf(source)를 사용해서 문자로 변경한 다음 변경된 문자를 반환

ConverterTest - 타입 컨버터 테스트 코드

class ConverterTest {
  
    @Test
    void stringToInteger() {
        StringToIntegerConverter converter = new StringToIntegerConverter();
        Integer result = converter.convert("10");
        assertThat(result).isEqualTo(10);
    }
  
    @Test
    void integerToString() {
        IntegerToStringConverter converter = new IntegerToStringConverter();
        String result = converter.convert(10);
        assertThat(result).isEqualTo("10");
    }
}

사용자 정의 타입 컨버터 127.0.0.1:8080과 같은 IP, PORT를 입력하면 IpPort 객체로 변환하는 컨버터

IpPort

@Getter
@EqualsAndHashCode
public class IpPort {
  
    private String ip;
    private int port;
  
    public IpPort(String ip, int port) {
        this.ip = ip;
        this.port = port;
    }
}
  • 롬복의 @EqualsAndHashCode를 넣으면 모든 필드를 사용해서 equals(), hashcode()를 생성
  • 따라서 모든 필드의 값이 같다면 a.equals(b)의 결과가 참

StringToIpPortConverter - 컨버터

@Slf4j
public class StringToIpPortConverter implements Converter<String, IpPort> {
  
    @Override
    public IpPort convert(String source) {
        log.info("convert source={}", source);
        String[] split = source.split(":");
        String ip = split[0];
        int port = Integer.parseInt(split[1]);
      
        return new IpPort(ip, port);
    }
}

127.0.0.1:8080 같은 문자를 입력하면 IpPort 객체를 만들어 반환

IpPortToStringConverter

@Slf4j
public class IpPortToStringConverter implements Converter<IpPort, String> {
  
    @Override
    public String convert(IpPort source) {
        log.info("convert source={}", source);
        return source.getIp() + ":" + source.getPort();
    }
}

IpPort 객체를 입력하면 127.0.0.1:8080 같은 문자를 반환

ConverterTest - IpPort 컨버터 테스트 추가

@Test
void stringToIpPort() {
    StringToIpPortConverter converter = new StringToIpPortConverter();
    String source = "127.0.0.1:8080";
    IpPort result = converter.convert(source);
    assertThat(result).isEqualTo(new IpPort("127.0.0.1", 8080));
}
@Test
void ipPortToString() {
    IpPortToStringConverter converter = new IpPortToStringConverter();
    IpPort source = new IpPort("127.0.0.1", 8080);
    String result = converter.convert(source);
    assertThat(result).isEqualTo("127.0.0.1:8080");
}
  • 이렇게 타입 컨버터를 하나하나 직접 사용하면, 개발자가 직접 컨버팅 하는 것과 큰 차이가 없음
  • 타입 컨버터를 등록하고 관리하면서 편리하게 변환 기능을 제공하는 역할을 하는 무언가가 필요

참고 스프링은 용도에 따라 다양한 방식의 타입 컨버터를 제공한다.

Converter → 기본 타입 컨버터 ConverterFactory → 전체 클래스 계층 구조가 필요할 때 GenericConverter → 정교한 구현, 대상 필드의 애노테이션 정보 사용 가능 ConditionalGenericConverter → 특정 조건이 참인 경우에만 실행

자세한 내용은 공식 문서를 참고하자. https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#coreconvert

참고 스프링은 문자, 숫자, 불린, Enum등 일반적인 타입에 대한 대부분의 컨버터를 기본으로 제공한다. IDE에서 Converter, ConverterFactory, GenericConverter 의 구현체를 찾아보면 수많은 컨버터를 확인할 수 있다.

컨버전 서비스 - ConversionService

스프링은 개별 컨버터를 모아두고 그것들을 묶어서 편리하게 사용할 수 있는 기능을 제공하는데, 이것이 바로 컨버전 서비스( ConversionService )

ConversionService 인터페이스

package org.springframework.core.convert;

import org.springframework.lang.Nullable;

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);
}

ConversionServiceTest - 컨버전 서비스 테스트 코드

public class ConversionServiceTest {
  
    @Test
    void conversionService() {
      
        //등록
        DefaultConversionService conversionService = new
        DefaultConversionService();
        conversionService.addConverter(new StringToIntegerConverter());
        conversionService.addConverter(new IntegerToStringConverter());
        conversionService.addConverter(new StringToIpPortConverter());
        conversionService.addConverter(new IpPortToStringConverter());
      
        //사용
        assertThat(conversionService.convert("10", Integer.class)).isEqualTo(10);
        assertThat(conversionService.convert(10, String.class)).isEqualTo("10");
        IpPort ipPort = conversionService.convert("127.0.0.1:8080", IpPort.class);
        assertThat(ipPort).isEqualTo(new IpPort("127.0.0.1", 8080));
      
        String ipPortString = conversionService.convert(new IpPort("127.0.0.1", 8080), String.class);
        assertThat(ipPortString).isEqualTo("127.0.0.1:8080");
    }
}

DefaultConversionService는 ConversionService 인터페이스를 구현했는데, 추가로 컨버터를 등록하는 기능도 제공

등록과 사용 분리

  • 컨버터를 등록할 때는 StringToIntegerConverter 같은 타입 컨버터를 명확하게 알아야 함
  • 반면에 컨버터를 사용하는 입장에서는 타입 컨버터를 전혀 몰라도 됨
  • 타입 컨버터들은 모두 컨버전 서비스 내부에 숨어서 제공됨. 따라서 타입을 변환을 원하는 사용자는 컨버전 서비스 인터페이스에만 의존하면 됨.
  • 컨버전 서비스를 등록하는 부분과 사용하는 부분을 분리하고 의존관계 주입을 사용해야 함

컨버전 서비스 사용 Integer value = conversionService.convert("10", Integer.class)

인터페이스 분리 원칙 - ISP(Interface Segregation Principal) 인터페이스 분리 원칙은 클라이언트가 자신이 이용하지 않는 메서드에 의존하지 않아야 함

DefaultConversionService는 다음 두 인터페이스를 구현

  • ConversionService : 컨버터 사용에 초점
  • ConverterRegistry : 컨버터 등록에 초점

이렇게 인터페이스를 분리하면 컨버터를 사용하는 클라이언트와 컨버터를 등록하고 관리하는 클라이언트의 관심사를 명확하게 분리할 수 있음. 특히 컨버터를 사용하는 클라이언트는 ConversionService만 의존하면 되므로, 컨버터를 어떻게 등록하고 관리하는지는 전혀 몰라도 됨. 결과적으로 컨버터를 사용하는 클라이언트는 꼭 필요한 메서드만 알게 됨.

ISP 참고: https://ko.wikipedia.org/wiki/%EC%9D%B8%ED%84%B0%ED%8E%98%EC%9D%B4%EC%8A%A4%EB%B6%84%EB%A6%AC%EC%9B%90%EC%B9%99

스프링은 @RequestParam 같은 곳에서 ConversionService 를 사용해서 타입을 변환

스프링에 Converter 적용하기

WebConfig - 컨버터 등록

@Configuration
public class WebConfig implements WebMvcConfigurer {
  
    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToIntegerConverter());
        registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());
    }
}
  • 스프링은 내부에서 ConversionService를 제공
  • 개발자는 WebMvcConfigurer가 제공하는 addFormatters()를 사용해서 추가하고 싶은 컨버터를 등록
  • 이렇게 하면 스프링은 내부에서 사용하는 ConversionService에 컨버터를 추가
  • 스프링은 내부에서 수많은 기본 컨버터들을 제공
  • 컨버터를 추가하면 추가한 컨버터가 기본 컨버터 보다 높은 우선순위

HelloController - 추가

@GetMapping("/ip-port")
public String ipPort(@RequestParam IpPort ipPort) {
    System.out.println("ipPort IP = " + ipPort.getIp());
    System.out.println("ipPort PORT = " + ipPort.getPort());
    return "ok";
}

실행 로그

StringToIpPortConverter : convert source=127.0.0.1:8080
ipPort IP = 127.0.0.1
ipPort PORT = 8080

?ipPort=127.0.0.1:8080 쿼리 스트링이 @RequestParam IpPort ipPort 에서 객체 타입으로 잘\변환됨

처리 과정 @RequestParam은 @RequestParam을 처리하는 ArgumentResolver인 RequestParamMethodArgumentResolver에서 ConversionService를 사용해서 타입을 변환 부모 클래스와 다양한 외부 클래스를 호출하는 등 복잡한 내부 과정을 거치기 때문에 대략 이렇게 처리되는 것으로 이해해도 충분

뷰 템플릿에 컨버터 적용하기

ConverterController

@Controller
public class ConverterController {
  
    @GetMapping("/converter-view")
    public String converterView(Model model) {
        model.addAttribute("number", 10000);
        model.addAttribute("ipPort", new IpPort("127.0.0.1", 8080));
        return "converter-view";
    }
}

Model에 숫자 10000와 ipPort객체를 담아서 뷰 템플릿에 전달

resources/templates/converter-view.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <ul>
        <li>${number}: <span th:text="${number}" ></span></li>
        <li>${{number}}: <span th:text="${{number}}" ></span></li>
        <li>${ipPort}: <span th:text="${ipPort}" ></span></li>
        <li>${{ipPort}}: <span th:text="${{ipPort}}" ></span></li>
    </ul>
</body>
</html>

타임리프는 ${{...}} 를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력. 물론 스프링과 통합 되어서 스프링이 제공하는 컨버전 서비스를 사용하므로, 개발자가 등록한 컨버터들을 사용할 수 있음

  • 변수 표현식 : ${...}

  • 컨버전 서비스 적용 : ${{...}}

  • ${{number}} : 뷰 템플릿은 데이터를 문자로 출력. 따라서 컨버터를 적용하게 되면 Integer 타입인 10000을 String 타입으로 변환하는 컨버터인 IntegerToStringConverter를 실행하게 된다. 이 부분은 컨버터를 실행하지 않아도 타임리프가 숫자를 문자로 자동으로 변환하기 때문에 컨버터를 적용할 때와 하지 않을 때가 같음
  • ${{ipPort}}: 뷰 템플릿은 데이터를 문자로 출력. 따라서 컨버터를 적용하게 되면 IpPort 타입을 String 타입으로 변환해야 하므로 IpPortToStringConverter가 적용. 그 결과 127.0.0.1:8080가 출력
  • 타임리프의 th:field는 id, name을 출력하는 등 다양한 기능이 있는데, 여기에 컨버전 서비스도 함께 적용

포맷터 - Formatter

  • Converter는 입력과 출력 타입에 제한이 없는, 범용 타입 변환 기능을 제공
  • 일반적인 웹 애플리케이션 환경에서는 불린 타입을 숫자로 바꾸는 것 같은 범용 기능보다는 개발자 입장에서는 문자를 다른 타입으로 변환하거나, 다른 타입을 문자로 변환하는 상황이 대부분

웹 애플리케이션에서 객체를 문자로, 문자를 객체로 변환하는 예

  • 화면에 숫자를 출력해야 하는데, Integer → String 출력 시점에 숫자 1000 → 문자 "1,000" 이렇게 1000 단위에 쉼표를 넣어서 출력하거나, 또는 "1,000"라는 문자를 1000이라는 숫자로 변경
  • 날짜 객체를 문자인 "2021-01-01 10:50:11"와 같이 출력하거나 또는 그 반대의 상황

Locale 여기에 추가로 날짜 숫자의 표현 방법은 Locale 현지화 정보가 사용될 수 있음

이렇게 객체를 특정한 포멧에 맞추어 문자로 출력하거나 또는 그 반대의 역할을 하는 것에 특화된 기능이 포맷터( Formatter). 포맷터는 컨버터의 특별한 버전

Converter vs Formatter

  • Converter는 범용(객체 → 객체)
  • Formatter는 문자에 특화(객체 → 문자, 문자 → 객체) + 현지화(Locale)
    • Converter의 특별한 버전

포맷터 - Formatter 만들기

포맷터( Formatter )는 객체를 문자로 변경하고, 문자를 객체로 변경하는 두 가지 기능을 모두 수행

  • String print(T object, Locale locale): 객체를 문자로 변경
  • T parse(String text, Locale locale): 문자를 객체로 변경

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> {
}

MyNumberFormatter

@Slf4j
public class MyNumberFormatter implements Formatter<Number> {
  
    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        log.info("text={}, locale={}", text, locale);
        NumberFormat format = NumberFormat.getInstance(locale);
        return format.parse(text);
    }
  
    @Override
    public String print(Number object, Locale locale) {
        log.info("object={}, locale={}", object, locale);
        return NumberFormat.getInstance(locale).format(object);
    }
}
  • "1,000"처럼 숫자 중간의 쉼표를 적용하려면 자바가 기본으로 제공하는 NumberFormat 객체를 사용. 이 객체는 Locale 정보를 활용해서 나라별로 다른 숫자 포맷을 생성
  • parse()를 사용해서 문자를 숫자로 변환. 참고로 Number 타입은 Integer, Long과 같은 숫자 타입의 부모 클래스
  • print()를 사용해서 객체를 문자로 변환

MyNumberFormatterTest

class MyNumberFormatterTest {
  
    MyNumberFormatter formatter = new MyNumberFormatter();
  
    @Test
    void parse() throws ParseException {
        Number result = formatter.parse("1,000", Locale.KOREA);
        assertThat(result).isEqualTo(1000L); //Long 타입 주의
    }
  
    @Test
    void print() {
        String result = formatter.print(1000, Locale.KOREA);
        assertThat(result).isEqualTo("1,000");
    }
}

parse() 의 결과가 Long이기 때문에 isEqualTo(1000L)을 통해 비교할 때 마지막에 L 을 넣어야 함

참고 스프링은 용도에 따라 다양한 방식의 포맷터를 제공한다. Formatter 포맷터 AnnotationFormatterFactory 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터

자세한 내용은 공식 문서를 참고하자. https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#format

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

  • 컨버전 서비스에는 컨버터만 등록할 수 있고, 포맷터를 등록할 수 없음
    • 그런데 생각해보면 포맷터는 객체 → 문자, 문자 → 객체로 변환하는 특별한 컨버터
  • 포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있음
  • 내부에서 어댑터 패턴을 사용해서 Formatter가 Converter처럼 동작하도록 지원
  • FormattingConversionService는 포맷터를 지원하는 컨버전 서비스
  • DefaultFormattingConversionService는 FormattingConversionService에 기본적인 통화, 숫자 관련 몇가지 기본 포맷터를 추가해서 제공
public class FormattingConversionServiceTest {
  
    @Test
    void formattingConversionService() {
      
        DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
        //컨버터 등록
        conversionService.addConverter(new StringToIpPortConverter());
        conversionService.addConverter(new IpPortToStringConverter());
        //포맷터 등록
        conversionService.addFormatter(new MyNumberFormatter());

        //컨버터 사용
        IpPort ipPort = conversionService.convert("127.0.0.1:8080", IpPort.class);
        assertThat(ipPort).isEqualTo(new IpPort("127.0.0.1", 8080));
        //포맷터 사용
        assertThat(conversionService.convert(1000, String.class)).isEqualTo("1,000");
        assertThat(conversionService.convert("1,000", Long.class)).isEqualTo(1000L);
    }
}

DefaultFormattingConversionService 상속 관계 FormattingConversionService는 ConversionService 관련 기능을 상속받기 때문에 결과적으로 컨버터도 포맷터도 모두 등록할 수 있음. 그리고 사용할 때는 ConversionService가 제공하는 convert를 사용

추가로 스프링 부트는 DefaultFormattingConversionService를 상속 받은 WebConversionService를 내부에서 사용

포맷터 적용하기

WebConfig - 수정

@Configuration
public class WebConfig implements WebMvcConfigurer {
  
    @Override
    public void addFormatters(FormatterRegistry registry) {
        //주석처리 우선순위
        //registry.addConverter(new StringToIntegerConverter());
        //registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());
        //추가
        registry.addFormatter(new MyNumberFormatter());
    }
}

주의

  • StringToIntegerConverter, IntegerToStringConverter를 꼭 주석처리
  • MyNumberFormatter도 숫자 → 문자, 문자 → 숫자로 변경하기 때문에 둘의 기능이 겹침
  • 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용

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

  • 스프링은 자바에서 기본으로 제공하는 타입들에 대해 기본으로 포맷터를 제공
  • IDE에서 Formatter 인터페이스의 구현 클래스를 찾아보면 날짜나 시간 관련 포맷터가 제공되는 것을 확인할 수 있음
  • 그런데 포맷터는 기본 형식이 지정되어 있기 때문에, 객체의 각 필드마다 다른 형식으로 포맷을 지정하기는 어려움

  • 스프링은 이런 문제를 해결하기 위해 애노테이션 기반으로 원하는 형식을 지정해서 사용할 수 있는 매우 유용한 포맷터 두 가지를 기본으로 제공

  • @NumberFormat: 숫자 관련 형식 지정 포맷터 사용, NumberFormatAnnotationFormatterFactory
  • @DateTimeFormat: 날짜 관련 형식 지정 포맷터 사용, Jsr310DateTimeFormatAnnotationFormatterFactory

FormatterController

@Controller
public class FormatterController {
  
    @GetMapping("/formatter/edit")
    public String formatterForm(Model model) {
      
        Form form = new Form();
        form.setNumber(10000);
        form.setLocalDateTime(LocalDateTime.now());
      
        model.addAttribute("form", form);
        return "formatter-form";
    }
  
    @PostMapping("/formatter/edit")
    public String formatterEdit(@ModelAttribute Form form) {
        return "formatter-view";
    }
  
    @Data
    static class Form {
      
        @NumberFormat(pattern = "###,###")
        private Integer number;
      
        @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        private LocalDateTime localDateTime;
    }
}

참고 @NumberFormat, @DateTimeFormat의 자세한 사용법이 궁금한 분들은 다음 링크를 참고하거나 관련 애노테이션을 검색해보자. https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#format-CustomFormatAnnotations

주의! 메시지 컨버터( HttpMessageConverter )에는 컨버전 서비스가 적용되지 않는다. 특히 객체를 JSON으로 변환할 때 메시지 컨버터를 사용하면서 이 부분을 많이 오해하는데, HttpMessageConverter의 역할은 HTTP 메시지 바디의 내용을 객체로 변환하거나 객체를 HTTP 메시지 바디에 입력하는 것이다. 예를 들어서 JSON을 객체로 변환하는 메시지 컨버터는 내부에서 Jackson 같은 라이브러리를 사용한다. 객체를 JSON으로 변환한다면 그 결과는 이 라이브러리에 달린 것이다. 따라서 JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정해야 한다. 결과적으로 이것은 컨버전 서비스와 전혀 관계가 없다.

컨버전 서비스는 @RequestParam, @ModelAttribute, @PathVariable, 뷰 템플릿 등에서 사용할 수 있다.