[TIL] #10. 스프링 타입 컨버터

프로젝트 시작

🔗 코드 확인하기

실행 결과

스프링 타입 컨버터 소개

애플리케이션을 개발하다 보면

• 문자 → 숫자
• 숫자 → 문자

처럼 타입을 변환해야 하는 경우가 있다.

HelloController - 문자 타입 숫자로 타입으로 변환

 @GetMapping("/hello-v1")
 public String helloV1(HttpServletRequest request) {
     String data = request.getParameter("data"); //문자 타입 조회
     Integer intValue = Integer.valueOf(data); //숫자 타입으로 변경
     System.out.println("intValue = " + intValue);
     return "ok";
}

• String data = request.getParameter("data")
  • HTTP 요청 파라미터는 모두 문자로 처리된다.
  • 요청 파라미터를 자바에서 다른 타입으로 변환해서 사용하고 싶으면 변환 과정이 필요하다!
• Integer intValue = Integer.valueOf(data)
  • data를 숫자 타입으로 변환해준다.

실행 결과

localhost:8080/hello-v1?data=10

@RequestParam 사용

@GetMapping("/hello-v2")
public String helloV2(@RequestParam Integer data) {
    System.out.println("data = " + data);
    return "ok";
}

스프링이 제공하는 @RequestParam을 사용하면 data를 숫자 타입으로 편리하게 변환해준다!

실행 결과

localhost:8080/hello-v2?data=10

스프링의 타입 변환

✔ 스프링의 타입 변환 적용 예

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

✔ 스프링과 타입 변환

스프링은 중간에 타입 변환기를 사용해서 타입을 변환해준다.
그런데 만약 개발자가 새로운 타입을 만들어서 이 타입으로 변환하고 싶을 때는 어떻게 해야할까?

✔ 컨버터 인터페이스

package org.springframework.core.convert.converter;
public interface Converter<S, T> {
    T convert(S source);
}

스프링은 확장 가능한 컨버터 인터페이스를 제공한다.

• 그래서 스프링에 추가적인 타입 변환이 필요한 경우, 이 컨버터 인터페이스를 구현해서 등록하면 된다.
• 이 컨버터 인터페이스는 모든 타입에 적용할 수 있다.

타입 컨버터 - Converter

타입 컨버터 사용법에 대해서 알아보자!

위에서 언급한 것처럼, 타입 컨버터를 사용하려면 Converter 인터페이스를 구현하면 된다.

StringToIntegerConverter

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

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

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

• String → Integer로 변환하기 때문에 소스가 String이 된다.
• Integer.ValueOf(source)를 사용해서 숫자로 변경한 다음, 변경한 숫자를 반환하면 된다.

IntegerToStringConverter

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

위와 비슷하다! 코드 참고하기 ⬇

🔗 전체 코드 확인하기

테스트 실행 결과

📌 참고

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

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

컨버전 서비스 - 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는 Conversion 인터페이스를 구현한 것으로, 컨버터를 등록하는 기능도 제공한다.

✔ 등록과 사용 분리

• 컨버터를 등록할 때는 StringToIntegerConverter 같은 타입 컨버터를 명확하게 알아야 한다.
• 컨버터를 사용할 때는 타입 컨버터를 전혀 몰라도 된다!

✔ 인터페이스 분리 원칙 - ISP

클라이언트가 자신이 이용하지 않은 메서드에 의존하지 않아야 한다.

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

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

이렇게 인터페이스를 분리하면

• 컨버터를 사용하는 클라이언트와
• 컨버터를 등록하고 관리하는 클라이언트의

관심사를 명확하게 분리할 수 있다.

스프링에 Converter 적용하기

이제 웹 어플리케이션에 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에 컨버터를 추가해준다.

실행 결과

localhost:8080/hello-v2?data=10

직접 등록한 StringToIntegerConverter가 작동한다!

하지만 사실 StringToIntegerConverter를 등록하지 않아도 이 코드는 잘 수행되는데, 스프링이 내부에서 수많은 기본 컨버터들을 제공하기 때문이다!

컨버터를 추가하면 추가한 컨버터가 기본 컨버터보다 높은 우선순위를 가져서 StringToIntegerConverter가 실행된 것이다.

직접 정의한 타입 IpPort 이용하기

🔗 전체 코드

실행 결과

이번에도 잘 실행된다!

처리 과정

@RequestParam은 @RequestParam을 처리하는 ArgumentResolver인
RequestParamMethodArgumentResolver에서 ConversionService를 사용해서 타입을 변환한다.

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

이번에는 뷰 템플릿에 컨버터를 적용하는 방법에 대해 알아보자!

타임리프는 렌더링 시에 컨버터를 적용해서 렌더링하는 방법을 편리하게 지원한다.

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 객체를 담아서 뷰 템플릿에 전달한다.

convert-view

<!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> 

타임리피는 ${{...}}를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해준다.

• 변수 표현식: ${...}
• 컨버전 서비스 적용: {{...}}

실행 결과

localhost:8080/converter-view

• ${{number}}: 뷰 템플릿은 데이터를 문자로 출력한다. Integer 타입을 String 타입으로 변환해야 하므로 IntegerToStringConverter가 실행된다.
• ${{ipPort}}: IpPortToStringConverter가 적용되어 String 타입인 127.0.0.1:8080이 출력된다.

폼에 적용하기

🔗 코드로 확인하기

실행 결과

localhost:8080/converter/edit

• GET /converter/edit
  • th:field가 자동으로 컨버전 서비스 적용하여 ${{ipPort}}처럼 적용됨!
    따라서 IpPort → String으로 변환된다.
• POST /converter/edit
  • @ModelAttribute를 사용해서 String → IpPort로 변환된다.

포맷터 - Formatter

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

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

• 숫자 (1000) ↔ 문자 (1,000)
• 날짜 객체 ↔ 문자
  • 추가로 날짜 숫자의 표현 방법은 Locale 현지화 정보가 사용될 수 있다.

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

Converter vs Formatter

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

Formatter 만들기

🔗 전체 코드 확인하기

• "1,000"처럼 숫자 중간에 쉼표를 적용하려면 자바가 기본으로 제공하는 NumberFormat 객체 사용!
  • Locale 정보를 활용해서 나라별로 다른 숫자 포맷을 만들어준다.
• parse(): 문자 → 숫자
• print(): 객체 → 문자

실행 결과

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

컨버전 서비스에는 컨버터만 등록할 수 있다. 포맷터는 ❌!

그럼 포맷터는 컨버전 서비스를 쓸 수 없나요😢? 포맷터는 문자에 특화된 특별한 컨버터라고 했는데?!

사실 ConversionService는 안되지만, FormattingConversionService를 사용하면 됩니다! 😉

• FormattingConversionService: 포맷터를 지원하는 컨버전 서비스
• DefaultFormattingConversionService: FormattingConversingService + 기본적인 통화, 숫자 관련 몇 가지 기본 포맷터를 추가해서 제공하는 컨버전 서비스

FormattingConversionService 사용하기

🔗 전체 코드 확인하기

DefaultFormattingConversionService 상속 관계

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

실행 결과

포맷터 적용하기

포맷터 사용법을 알아봤으니 이번에는 웹 애플리케이션에 적용해보자!

🔗 전체 코드 확인하기

실행 결과

localhost:8080/converter-view

MyNumberFormatter(객체 → 문자)가 적용되어 10,000 문자가 출력된다!

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

포맷터는 기본 형식이 지정되어 있어 객체의 각 필드마다 다른 형식으로 포맷을 지정하기 어렵다.

그래서 스프링은 굉장히 유용한 포맷터 두 가지를 기본으로 제공한다.

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

🔗 전체 코드 확인하기

실행 결과

localhost:8080/formatter/edit

제출 버튼을 누르면 ⬇

지정한 포맷대로 출력된다!