Spring - Formatter, ConversionService

2024.01.02 - [Spring] - Spring - 타입 컨버터 (Converter, ConversionService)

Spring - 타입 컨버터 (Converter, ConversionService)

앞선 글에 이어서 작성하는 점 참고 바람

---

Formatter

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

그러나 웹 애플리케이션 환경을 생각해보면, 문자를 다른 객체로 변환하거나 객체를 문자로 변환하는 일이 대부분이다.

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

 

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

• 화면에 숫자를 출력해야 하는데, Integer String 출력 시점에 숫자 1000 문자 "1,000" 이렇게 1000 단위에 쉼표를 넣어서 출력하거나, 또는 "1,000" 라는 문자를 1000 이라는 숫자로 변경해야 한다.
• 날짜 객체를 문자인 "2021-01-01 10:50:11" 와 같이 출력하거나 또는 그 반대의 상황
  • 날짜 숫자의 표현 방법은 Locale 현지화 정보가 사용될 수 있다.

 

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

 

Formatter 만들기

Formatter 는 객체를 문자로 변경하고, 문자를 객체로 변경하는 두 가지 기능을 모두 수행한다.

 

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

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

 

 

숫자 1000 을 문자 "1,000" 으로 그러니까, 1000 단위로 쉼표가 들어가는 포맷을 적용해보자.

그리고 그 반대도 처리해주는 포맷터를 만들어보자.

 

@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 정보를 활용해서 나라별로 다른 숫자 포맷을 만들어준다.

 

실행해주면 아래와 같이 로그가 남는다.

MyNumberFormatter - text=1,000, locale=ko_KR
MyNumberFormatter - object=1000, locale=ko_KR

 

---

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

컨버전 서비스에는 컨버터만 등록할 수 있고, 포맷터를 등록할 수 는 없다.

그러나, 포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있다.

(내부에서 어댑터 패턴을 사용해서 Formatter가 Converter처럼 작동하도록 함.)

 

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

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

 

DefaultFormattingConversionService를 사용하자.

public class FormattingConversionServiceTest {

 @Test
 void formattingConversionService() {
 
 DefaultFormattingConversionService conversionService = new
DefaultFormattingConversionService();

 //컨버터 등록
 conversionService.addConverter(new StringToIpPortConverter());
 
 //포맷터 등록
 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);
 }
 
}

addFormatter를 통해 등록 가능

convert를 통해 사용 가능

( Converter처럼 등록과 사용이 분리되어 있음 )

 

---

포맷터 적용

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

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

앞서 테스트를 위해서 작성해둔 Converter들은 주석처리해주자.

컨버터가 포멧터보다 우선순위를 가지기 때문에, 포맷터가 적용되지 않음.

 

그런데 위에서 예시로 들은, "1000" 을 1,000 으로 바꿔준다거나 날짜 형식을 바꿔주는 예시들은 스프링에서 해당 기능들을 제공할 법 하다.

관련 기능이 있을까?

---

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

스프링은 자바에서 기본으로 제공하는 타입들에 대해 수 많은 포맷터를 기본으로 제공한다.

 

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

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

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

 

 

templates/formatter-view.html

<ul>
 <li>${form.number}: <span th:text="${form.number}" ></span></li>
 <li>${{form.number}}: <span th:text="${{form.number}}" ></span></li>
 <li>${form.localDateTime}: <span th:text="${form.localDateTime}" ></span></li>
 <li>${{form.localDateTime}}: <span th:text="${{form.localDateTime}}" ></span></li>
</ul>

 

 

출력 결과

• ${form.number}: 10000
• ${{form.number}}: 10,000
• ${form.localDateTime}: 2021-01-01T00:00:00
• ${{form.localDateTime}}: 2021-01-01 00:00:00

 

 

@NumberFormat(pattern=" ###,###")

@DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")

뷰 템플릿을 렌더링할 때, 애노테이션에서 지정한 Format 형식대로 잘 적용되었다.

---

참고

> https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#format-CustomFormatAnnotations

Redirecting...

 

---

정리

컨버터를 사용하든, 포맷터를 사용하든 등록 방법은 다르지만, 사용할 때는 컨버전 서비스를 통해서 일관성 있게 사용할 수 있다. ( 사용과 등록이 분리되어있음 )

스프링이 제공하는 @NumberFormat, @DateTimeFormat 를 잘 활용하자.

 

 

※ 메시지 컨버터( HttpMessageConverter )에는 컨버전 서비스가 적용되지 않는다.

객체를 JSON으로 변환할 때 메시지 컨버터를 사용하면서 이 부분을 많이 오해하는데, HttpMessageConverter 의 역할은 HTTP 메시지 바디의 내용을 객체로 변환하거나 객체를 HTTP 메시지 바디에 입력하는 것

→ JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정해야 한다.

 

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