[Spring] 포맷터 - Formatter

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

 

숫자 1000을 문자 "1,000"으로, 1,000 단위로 쉼표가 들어가는 포맷을 적용해보면 아래와 같다.

 

MyNumberFormatter

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;

// ctrl + shift + T 로 테스트 만들기

@Slf4j
public class MyNumberFormatter implements Formatter<Number> {
    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        log.info("text={}, locale={}", text, locale);
        // "1,000" → 1000
        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

package hello.typeconverter.formatter;

import org.junit.jupiter.api.Test;

import java.text.ParseException;
import java.util.Locale;

import static org.assertj.core.api.Assertions.assertThat;

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을 넣어주어야 한다.

 

※  IntelliJ Static import

Assersions.assertThat 을 드래그 후 Alt + Enter 눌러서 선택하기

 

MyNumberFormatter - text=1,000, locale=ko_KR

MyNumberFormatter - object=1000, locale=ko_KR

 

※ 참고

스프링은 용도에 따라 다양한 방식의 포맷터를 제공한다.

Formatter 포맷터

AnnotationFormatterFactory 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터

 

자세한 내용은 아래 공식 문서에 있다.

Spring Field Formatting :: Spring Framework

Spring Field Formatting :: Spring Framework

 

 

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

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

포맷터는 객체 → 문자, 문자 → 객체로 변환하는 특별한 컨버터일 뿐이다.

 

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

내부에서 어댑터 패턴을 사용 해서 Formatter가 Converter처럼 동작하도록 지원한다.

 

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

DefaultFormattingConversionService는 FormattingConversionService에

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

 

package hello.typeconverter.formatter;

import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIntegerConverter;
import hello.typeconverter.converter.StringToIpPortConverter;
import hello.typeconverter.type.IpPort;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.format.support.DefaultFormattingConversionService;

import static org.assertj.core.api.Assertions.assertThat;

public class FormattingConversionServiceTest {

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

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

 

DefaultFormattingConversionService 상속 관계

FormattingConversionService는 ConversionService 관련 기능을 상속받기 때문에

결과적으로 컨버터도 포맷터도 모두 등록할 수 있다.

그리고 사용할 때는 ConversionService가 제공하는 convert 를 사용하면 된다.

 

추가로 스프링 부트는 DefaultFormattingConversionService 를 상속받은

WebConversionService를 내부에서 사용한다.

 

포맷터 적용하기

 

WebConfig - 수정

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) {
        // 없어도 잘 동작하는데, 그 이유는 기본적으로 스프링이 제공하기 떄문이다.
        // 사용자정의 컨버터는 직접 구현해줘야함. IP 같은 것
        // 우선순위로 인해 혼선 발생하므로 주석처리해주기
//        registry.addConverter(new StringToIntegerConverter());
//        registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());


        // 컨버터가 더 우선순위가 앞선다.
        // 추가
        registry.addFormatter(new MyNumberFormatter());

    }
}

 

※ 주의 

StringToIntegerConverter, IntegerToStringConverter를 꼭 주석처리 해야한다.

MyNumberFormatter 도 숫자 → 문자, 문자 → 숫자 로 변경하기 때문에 둘의 기능이 겹친다.

우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고 컨버터가 적용된다.

 

실행 - 객체 → 문자

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

 

실행 - 문자 → 객체

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

 

실행 로그

MyNumberFormatter : text=10,000, locale=ko_KR

data = 10000

 

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

 

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

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

IDE에서 Formatter 인터페이스의 구현 클래스를 찾아보면

수 많은 날짜나 시간 관련 포맷터가 제공되는 것을 확인할 수 있다.

 

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

 

스프링은 이런 문제를 해결하기 위해 애노테이션 기반으로 원하는 형식을 지정해서 사용할 수 있는

매우 유용한 포맷터 두 가지를 기본으로 제공한다.

 - @NumberFormat : 숫자 관련 형식 지정 포맷터 사용,

   NumberFormatAnnotationFormatterFactory

 - @DateTimeFormat : 날짜 관련 형식 지정 포맷터 사용,

   Jsr310DateTimeFormatAnnotationFormatterFactory

 

FormatterController

package hello.typeconverter.controller;

import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.format.annotation.NumberFormat;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;

import java.time.LocalDateTime;

@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-form.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form th:object="${form}" th:method="post">
    number <input type="text" th:field="*{number}"><br/>
    localDateTime <input type="text" th:field="*{localDateTime}"><br/>
    <input type="submit"/>
</form>
</body>
</html>

 

templates/formatter-view.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<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>
</body>

 

실행

http://localhost:8080/formatter/edit

 

※ 참고

@NumberFormat, @DateTimeFormat 의 내용은 아래에 방문하면 알 수 있다.

Spring Field Formatting :: Spring Framework

Spring Field Formatting :: Spring Framework

 

컨버터를 사용하든, 포맷터를 사용하든 등록 방법은 다르지만,

사용할 때는 컨버전 서비스를 통해서 일관성 있게 사용할 수 있다.

 

※ 주의

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

특히 객체를 JSON으로 변환할 때 메시지 컨버터를 사용하면서 이 부분을 많이 오해하는데,

HttpMessageConverter 의 역할은 HTTP 메시지 바디의 내용을 객체로 변환하거나

객체를 HTTP 메시지 바디에 입력하는 것이다.

 

예를 들어서 JSON을 객체로 변환하는 메시지 컨버터는 내부에서 Jackson 같은 라이브러리를 사용 한다.

 

객체를 JSON으로 변환한다면 그 결과는 이 라이브러리에 달린 것이다.

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

포맷을 지정해야 한다.

 

결과적으로 이것은 컨 버전 서비스와 전혀 관계가 없다

 

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