Written by spring-style
on 2021-12-30

스프링 포맷터(Formatter), 포맷터를 지원하는 ConversionService

728x90

스프링 포맷터란(Formatter)??

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

화면에 숫자를 출력해야 하는데, 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 { String print(T object, Locale locale); } public interface Parser { T parse(String text, Locale locale) throws ParseException; } public interface Formatter extends Printer, Parser { }

숫자 1000을 문자 "1,000"으로 그러니까, 1000 단위로 쉼표가 들어가는 포맷을 적용해보겠습니다. 그리고 그 반대도 처리해주는 포맷터를 만들겠습니다.

package hello.typeconverter.formatter; import lombok.extern.slf4j.Slf4j; import org.springframework.format.Formatter; import java.text.NumberFormat; import java.text.ParseException; import java.util.Locale; @Slf4j public class MyNumberFormatter implements Formatter { @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()를 사용해서 객체를 문자로 변환합니다.

잘 동작하는지 테스트 코드를 통해서 검증하겠습니다.

public 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을 넣어주어야 합니다.

실행 결과 로그

MyNumberFormatter - text=1,000, locale=ko_KR

MyNumberFormatter - object=1000, locale=ko_KR

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

포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있습니다. 내부에서 어댑터 패턴을 사용해서 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를 내부에서 사용합니다.

포맷터를 웹 애플리케이션에 적용하기

package hello.typeconverter; import hello.typeconverter.converter.IntegerToStringConverter; import hello.typeconverter.converter.IpPortToStringConverter; import hello.typeconverter.converter.StringToIntegerConverter; import hello.typeconverter.converter.StringToIpPortConverter; import hello.typeconverter.formatter.MyNumberFormatter; import org.springframework.context.annotation.Configuration; import org.springframework.format.FormatterRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @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도 숫자 문자, 문자 숫자로 변경하기 때문에 둘의 기능이 겹칩니다. 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용됩니다.

ConverterController

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

실행 - 객체 문자

http://localhost:8080/converter-view

• ${number}: 10000

• ${{number}}: 10,000

컨버전 서비스를 적용한 결과 MyNumberFormatter가 적용되어서 10,000 문자가 출력된 것을 확인할 수 있습니다.

HelloController.java

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

실행 - 문자 객체

http://localhost:8080/hello-v2?data=10,000

실행 로그

MyNumberFormatter : text=10,000, locale=ko_KR

data = 10000

"10,000"이라는 포맷팅 된 문자가 Integer 타입의 숫자 10000으로 정상 변환된 것을 확인할 수 있습니다.

from http://develop-writing.tistory.com/105 by ccl(A) rewrite - 2021-12-30 19:28:08

Top