포맷터(Formatter)

포맷터

컨버터는 입 출력 타입에 제한이 없이 범용적으로 타입을 바꿀 수 있는 기능을 제공했습니다. 

포맷터는 컨버터 기능에서 조금 더 특화된 기능으로 객체를 문자로, 문자를 객체로 바꿀 때 Locale 객체를 이용해 현지화 정보를 사용할 수 있습니다.

 

포맷터 인터페이스

public interface Formatter<T> extends Printer<T>, Parser<T> {}

@FunctionalInterface
public interface Printer<T> {
   String print(T object, Locale locale);
}

@FunctionalInterface
public interface Parser<T> {
   T parse(String text, Locale locale) throws ParseException;
}

메소드 설명

• String print(T object , Locale locale) : Object를 String으로 변경 ( + Locale 정보 사용 가능)
• T Parse(String text, Locale locale) : String을 Object로 변경 ( + Loclae 정보 사용 가능)

 

이 포맷터 인터페이스를 구현해 print메소드로 숫자(Object) 1000을 (String)"1,000"으로 변경.

parse메소드로 1000을 (String)"1,000"을 숫자(Object) 1000으로 변경해보겠습니다.

@Slf4j
public class MyNumberFormatter implements Formatter<Number> {


    // parse : String to Object with formatting
    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        log.info("text : {} , Locale : {}",text, locale);

        // "1,000" -> 1000
        return NumberFormat.getInstance(locale).parse(text);
    }

    // print : Object To String with formatting
    @Override
    public String print(Number object, Locale locale) {
        log.info("object = {} , locale = {}", object, locale);

        // 1000 -> "1,000"
        return NumberFormat.getInstance(locale).format(object);
    }
}

print 메소드 : 1000->"1,000"

• 숫자 중간의 쉼표를 제거하기 위해서는 NumberFormat 객체를 사용해야 합니다.
• NumberFormat은 locale정보를 통해 format 메소드로 쉼표를 제거하고 Number 객체를 리턴하도록 구현되어있습니다.

parse 메소드 : "1,000"->1000

• 숫자 중간의 쉼표를 적용하기 위해서는 NumberFormat 객체를 사용해야 합니다.
• NumberFormat은 locale정보를 통해 parse 메소드로 쉼표를 추가하고 Number 객체를 리턴하도록 구현되어있습니다.

ConversionService에 포맷터 등록
컨버터를 DefaultConversionService에 등록해서 사용했다면,
포맷터는 DefaultFormattingConversionService에 등록해서 사용합니다.

 

웹 애플리케이션에 포맷터 적용하는 방법
컨버터와 동일하게 WebMvcConfigurer 인터페이스를 구현한 클래스에 addFormatters 메소드에 등록

@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도 숫자->문자, 문자->숫자로 변경하기 때문에 둘의 기능이 겹칩니다. 기능이 겹칠경우 컨버터가 우선순위가 더 높습니다.

 

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

어노테이션 기반으로 원하는 형식을 지정해서 사용할수 있는 매우 유용한 포맷터 두가지를 기본으로 제공합니다.

@NumberFormat: 숫자 관련 형식 지정 포맷터

@DateTimeFormat: 날짜 관련 형식 지정 포맷터

 

어노테이션에 패턴을 지정해 원하는 형식으로 포맷팅할 수 있습니다.

@Data
static class Form
{
    @NumberFormat(pattern="###,###")
    private Integer number;

    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime localDateTime;
}

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

 

ConversionSerice는 @RequestParam , @ModelAttribute , @PathVariable , 뷰 템플릿 등에서 사용할 수 있습니다.

주의할 점 : HttpMessageConverter(@RequestBody, @ResponseBody) 에는 ConversionService가 적용되지 않습니다.

HttpMessageConverter의 JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 JackSon 라이브러리에서 제공하는 설정을 찾아보도록 합시다.

 

<참고 자료>

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

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-2/dashboard