Formatter (포맷터)

실행 환경

버전 명시 없음 — WebMvcConfigurer#addFormatters, @NumberFormat/@DateTimeFormat 등 Spring MVC 표준 API만 사용되어 특정 버전 확정은 어려움.

Converter는 타입 간 임의의 변환(문자↔객체, 숫자↔객체 등)을 자유롭게 처리할 수 있지만, 화면에 숫자를 “1,000”처럼 천 단위 콤마로 표시하거나 날짜를 특정 패턴 문자열로 표현하는 등 “문자열로/문자열에서”의 표현 형식을 다루는 문제에는 범용 API가 다소 번거롭다. Formatter는 이런 문자열 표현 변환에 특화된 Converter의 심화 버전이다.

Formatter 란?

• Converter의 심화 버전
• Converter의 경우 제한이 없는 변환이 가능 (ex 문자 <-> 객체 , 숫자 <-> 객체  등등..)
• Formatter의 경우 문자를 기준으로 변경하는 것을 의미 ( 문자 <-> 객체 , 문자 <-> 숫자 , 문자를 기준으로 변경)

Formatter 인터페이스

public interface Formatter<T> extends Printer<T>, Parser<T> {
}
 
public interface Printer<T> {
    String print(T object, Locale locale);
}
 
public interface Parser<T> {
    T parse(String text, Locale locale) throws ParseException;
}

• Formatter 숫자 구현 ( 문자 <-> 숫자 )
  • 1000 -> 1,000 형식으로 변경
  • NumberFormat 자바에서 기본으로 제공해주는 클래스
  • Integer, Long 과 같은 숫자타입의 부모 Number 객체 사용

public class MyNumberFormatter implements Formatter<Number> {
    
    @Override
    public Number parse(String text, Locale locale) throws ParseException {
        NumberFormat format = NumberFormat.getInstance(locale);
        return format.parse(text);
    }
    
    @Override
    public String print(Number object, Locale locale) {
        return NumberFormat.getInstance(locale).format(object);     
    }
}

Formatter 등록

@Configuration
 public class WebConfig implements WebMvcConfigurer {
     
     @Override
     public void addFormatters(FormatterRegistry registry) {
         registry.addConverter(new MyNumberFormatter());
     }
}

• Convert 등록과 동일
• 단, converter도 등록이 동일하기에 우선적으로 converter가 적용된다 ( 동일 기능에 있어서는 converter가 우선적용 )
• Spring의 내부 conversionService가 Formatter보다 Converter(GenericConverter)를 먼저 조회하도록 구현되어 있기 때문으로 알려져 있다 — 그래서 같은 타입 변환을 담당하는 Converter와 Formatter를 동시에 등록하면 Converter가 우선한다.

스프링이 제공하는 포맷터

• @NumberFormat
  • 숫자 관련 형식 지정 포멧터 사용
• @DateTimeFormat
  • 날짜 관련 형식 지정 포멧터 사용

@Controller
public class FormatterController{
     
     @Data
     static class Form{
         
         @NumberFormat(pattern = "###,###")
         private Integer number;
         
         @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
         private LocalDateTime localDateTime;
     }
     
     @GetMapping("/formatter")
     public String formGetMethod(Model model){
         Form form = new Form();
         
         form.setNumber(10000);
         form.setLocalDateTime(LocalDateTime.now());
         
         model.addAttribute("form", form);
         return "formatter-form";
    }
    
    @PostMapping("/formatter")
    public String formPostMethod(@ModelAttribute Form form){
        return "formatter-view";
    }
}

관련 문서

• (학습/프레임워크/Spring Framework) Spring Type Converter (타입 형변환) — 이 노트에서 “Converter의 심화 버전”이라고 언급한 Converter<S,T> 인터페이스 자체를 다루는 노트