타입 컨버터(Type Converter)

스프링 타입 컨버터

애플리케이션을 개발하다 보면, 문자를 숫자로 변환하거나 숫자를 문자로 변환하는 것처럼 타입을 변환해야 하는 경우가 상당히 많습니다.

@GetMapping("/hello-v1")
public String helloV1(@RequestParam Integer data)
{
    System.out.println("data = " + data);
    return "Ok";
}

스프링은 기본적으로 문자 -> 숫자(String To Integer) , 숫자 -> 문자 (Long,Int .. To String) 변환의 경우에서는 자동적으로 변환해 주지만, 개발자가 새로 만든 타입을 String으로 변환한다던지, String을 새로만든 타입으로 변환하고 싶은 경우에 제공하는 도구가 바로 컨버터입니다.

 

컨버터 인터페이스는 이렇습니다.

@FunctionalInterface
public interface Converter<S, T> {

   /**
    * Convert the source object of type {@code S} to target type {@code T}.
    * @param source the source object to convert, which must be an instance of {@code S} (never {@code null})
    * @return the converted object, which must be an instance of {@code T} (potentially {@code null})
    * @throws IllegalArgumentException if the source cannot be converted to the desired target type
    */
   @Nullable
   T convert(S source);

   /**
    * Construct a composed {@link Converter} that first applies this {@link Converter}
    * to its input, and then applies the {@code after} {@link Converter} to the
    * result.
    * @param after the {@link Converter} to apply after this {@link Converter}
    * is applied
    * @param <U> the type of output of both the {@code after} {@link Converter}
    * and the composed {@link Converter}
    * @return a composed {@link Converter} that first applies this {@link Converter}
    * and then applies the {@code after} {@link Converter}
    * @since 5.3
    */
   default <U> Converter<S, U> andThen(Converter<? super T, ? extends U> after) {
      Assert.notNull(after, "After Converter must not be null");
      return (S s) -> {
         T initialResult = convert(s);
         return (initialResult != null ? after.convert(initialResult) : null);
      };
   }

}

• 스프링은 확장 가능한 컨버터 인터페이스를 제공합니다.
• 개발자는 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현 및 스프링 부트에 등록하면 됩니다.
• <S,T> 에서 S는 대상 타입, T는 변환할 타입
• 타입변환 로직을 convert 메소드에 구현하면 됩니다.

ex) Integer -> String

@Slf4j
public class IntegerToStringConverter implements Converter<Integer,String> {

    @Override
    public String convert(Integer source) {
        log.info("convert source = {}",source);
        return String.valueOf(source);
    }
}

문자를 숫자로, 숫자를 문자로 변환해주는 컨버터는 사실 스프링이 기본적으로 제공하는 컨버터로 이미 등록되어 있습니다.

하지만 추가한 컨버터가 기본 컨버터보다 높은 우선순위를 가지기 때문에 만약 이 컨버터를 등록해서 사용하면 이 컨버터가 적용됩니다.

 

이번에는 사용자 정의 타입을 String으로 변환하는 컨버터를 만들어보겠습니다.

IpPort( 사용자 정의 타입 ) -> String

public class IpPort {

    private String ip;
    private int port;

    public IpPort(String ip, int port) {
        this.ip = ip;
        this.port = port;
    }
}

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

S : IpPort ▶︎ T : String

반대로 String을 IpPort로 바꿀수도 있습니다. 

String -> IpPort(사용자 정의 타입)

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

이렇게 사용자가 컨버터 인터페이스를 구현해 사용자가 정의한 타입을 컨버팅해보았습니다.

Conversion Service 

스프링은 위에서 만든 타입 컨버터를 등록하고 관리하는 기능을 제공합니다. ▶︎ ConversionService

public interface ConversionService {

  	boolean canConvert(@Nullable Class<?> sourceType, Class<?> targetType);

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

	@Nullable
	<T> T convert(@Nullable Object source, Class<T> targetType);

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

}

• ConversionService 인터페이스는 단순히 canConvert를 통해 컨버팅이 가능한지 확인하는 기능과 convert를 통해 컨버팅하는 기능을 제공합니다.
• ConversionServcie 인터페이스를 구현한 DefaultFormattingConversionService를 사용하면 컨버터를 등록하고 사용할 수 있습니다.

 

ConverterRegistry - 컨버터 등록 인터페이스
ConversionService - 컨버터 사용 인터페이스 
인터페이스 분리 원칙 (ISP)를 적용한 것을 볼 수 있습니다.

스프링은 내부에서 ConversionService를 사용해서 타입을 변환합니다. 

만든 Converter를 스프링에 적용하려면 WevMvcConfigurer가 제공하는 addFormatters()를 사용해 추가하고 싶은 컨버터를 ConversionService에 추가할 수 있습니다.

웹 애플리케이션에 컨버터 적용하는 방법
WebMvcConfigurer 인터페이스를 구현한 구현체에 addFormatters 메소드를 오버라이딩해 registry.addConverter(new 적용할 컨버터()); 로 웹 애플리케이션에 만든 컨버터를 적용할 수 있습니다.

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

}

- String To Integer, Integer To String은 기존에 스프링부트에 있던 컨버터를 무시하고 우선순위로 적용

 

String To IpPort

@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";
}

http://localhost:8080/ip-port?ipPort=127.0.0.1:8080

파라미터로 입력받은 127.0.0.1:8080 String이 객체 타입으로 변환된 것을 확인할 수 있습니다.

Thymeleaf 뷰 템플릿에 컨버터 적용하는 방법
${{...}}를 사용하면 자동으로 ConversionService를 사용해서 변환된 결과를 보여줍니다.
변수 표현식 : ${...}
컨버전 서비스 적용한 변수 표현식 : ${...}

<li>${{ipPort}}: <span th:text="${{ipPort}}" ></span></li>

폼에 컨버터 적용하는 방법
th:field로 지정하면 id, name도 동일하게 지정해줄 뿐만 아니라 컨버전 서비스도 적용됩니다. 

렌더링 전 

<form th:object="${form}" th:method="post">
    th:field <input type="text" th:field="*{ipPort}"><br/>
    th:value <input type="text" th:value="*{ipPort}">(보여주기 용도)<br/> <input type="submit"/>
</form>

렌더링 후 소스코드

<form method="post">
    th:field <input type="text" id="ipPort" name="ipPort" value="127.0.0.1:8080"><br/>
    th:value <input type="text" value="hello.typeconverter.type.IpPort@59cb0946">(보여주기 용도)<br/> <input type="submit"/>
</form>