스프링 포맷터(Formatter)

참고자료

https://develop-writing.tistory.com/105

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

 

스프링 포맷터(Formatter)

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

ex)

숫자 1000 -> "1,000" => 쉼표를 넣어서 출력

"1,000" -> 1000

날짜 객체"2021-01-01 10:50:11" 출력 or 반대

 

Formatter ProtoType

Locale : 날짜 숫자의 표현 방법은 Locale 현지화 정보가 사용됨.

// 객체를 문자로 변경
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> {
}

 

Converter vs Formatter

Converter는 범용(객체 <-> 객체)

Formatter는 문자에 특화(객체 -> 문자, 문자 -> 객체) + 현지화(Locale)

 

ex) 숫자 1000을 문자 "1,000" Format 적용(반대도 처리)

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<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(format);
    }
    
    @Override
    public String print(Number object object, Locale locale) {
    	log.info("object={}, locale={}", object, locale);
        return NumberFormat.getInstance(locale).foramt(object);
    }
}

 

// 테스트 검증
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");
    }

}

 

컨버전 서비스(ConversionService)

- 포맷터를 지원

- 컨버전 서비스에 포맷처를 추가할 수 있음 -> 어댑터 패턴을 사용

 

* 어댑터 패턴 - 디자인 패턴의 일종, 호환되지 않는 인터페이스들을 연결하는 디자인 패턴

 

우선순위: 컨버터 > 포맷터

 

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를 내부에서 사용합니다.

 

* formatter를 spring boot에 적용

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 StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());
        
        registry.addFormatter(new MyNumberFormatter());
    }
}

// ConvertController
@Slf4j
@Controller
public class ConvertController {
	@GetMapping("/converter-view")
    public String converterView(Model model) {
    	model.addAttribute("number", 10000);
        model.addAttribute("ipPort", new IpPort("127.0.0.1", 8080));
        return "convert-view";
    }
}