[Spring] 스프링 타입 컨버터 - 2

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

 

 

6. 포맷터 - Formatter

개발자 입장에서는 문자를 다른 타입으로 변환하거나, 다른 타입을 문자로 변환하는 상황이 대부분이다.

 

화면에 숫자를 출력해야 하는데, Integer => String 출력 시점에 숫자 1000 문자 "1,000" 이렇게 1000 단위에 쉼표를 넣어서 출력하거나,

또는 "1,000" 라는 문자를 1000 이라는 숫자로 변경해야 한다.

 

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

포맷터는 컨버터의 특별한 버전이다!

 

Formatter 는 문자에 특화된 컨버터(객체 문자, 문자 객체) + 현지화(Locale).

추가로 날짜 숫자의 표현 방법은 Locale 현지화 정보가 사용될 수 있다.

 

● 포맷터 - Formatter 만들기

포맷터는 객체 => 문자, 문자 => 객체 로 변경하는 2가지 역할을 다한다.

 

- 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"으로 만들어 보고, 그 역도 적용해 보자.

 

● MyNumberFormatter

@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);
        NumberFormat instance = NumberFormat.getInstance(locale);
        return instance.format(object);
    }
}

 

"1,000" 처럼 숫자 중간의 쉼표를 적용하려면 자바가 기본으로 제공하는 NumberFormat 객체를 사용하면 된다.

이 객체는 Locale 정보를 활용해서 나라별로 다른 숫자 포맷을 만들어준다.

 

문자를 숫자로 변환 => parse() 사용

객체를 문자로 변환 => print() 사용

 

● MyNumberFormatterTest

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

 

정상적으로 테스트가 통과됨을 알 수 있다.

로그가 다음과 같이 확인된다.

 

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

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

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

 

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

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

FormattingConversionService 는 ConversionService 관련 기능을 상속받기 때문에 결과적으로 컨버터도 포맷터도 모두 등록할 수 있다. 그리고 사용할 때는 ConversionService 가 제공하는 convert 를 사용하면 된다.

 

우리는 테스트 코드를 통해 DefaultFormattingConversionService를 사용하여 포멧터를 등록해 보자!

 

● 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 를 상속 받은 WebConversionService 를 내부에서 사용한다.

 

8. 포맷터 적용하기

포맷터를 웹 어플리케이션에서 사용하기 위해 WebConfig에 등록해 주자!

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

 

컨버터의 우선순위가 포맷터보다 더 높다. 따라서 기존의 컨버터 2개를 주석처리 해주었다.

 

/converter-view 에 요청시 다음과 같은 결과를 얻을 수 있다.

컨버전 서비스가 적용되어 포맷터를 사용했기 때문에 문자 10,000이 출력된다.

 

이제 반대로 문자를 객체로 변환해 보자!

http://localhost:8080/hello-v2?data=10,000 과 같이 요청을 보냈다!

MyNnumberFormatter가 작동하여 문자열 "10,000"을 객체(숫자) 10000으로 변환하였다.

 

9. 스프링이 제공하는 기본 포멧터

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

 

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

 

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

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

 

예제 컨트롤러를 만들어 결과를 확인해 봅시다!

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

 

처음 GetMapping으로 들어왔을때, model에 Form 객체를 전달하기 때문에, 뷰를 만들때 객체 => 문자열 로의 변환이 이루어 집니다. 결과는 다음과 같습니다.

Form 객체가 원하는 형식으로 잘 변환된것을 확인할 수 있습니다.

 

이번에는 역으로 문자열 => 객체의 변환을 봐야겠죠?

위에서 제출 버튼을 누르면 Post 방식으로 Form이 전달될것 입니다. 이후 view에 다시 전달되어 다음처럼 보이게 됩니다.

${{...}}을 사용했더니 컨버전 서비스가 적용되어 확인할수 있음을 알수있다.