[스프링 MVC 2편] 10. 스프링 타입 컨버터

📌 스프링 타입 컨버터란?

• 문자를 숫자로 변환하거나, 반대로 숫자를 문자로 변환해야 하는 것 처럼 애플리케이션을 개발하다 보면 타입을 변환해야 하는 경우 사용

 

⚡ 문자 타입을 숫자 타입으로 변경

HelloController

package hello.typeconverter.controller;

import jakarta.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello-v1")
    public String helloV1(HttpServletRequest request){
        String data = request.getParameter("data");//문자 타입 조회
        Integer intValue = Integer.valueOf(data); //숫자 타입으로 변경
        System.out.println("intValue = " + intValue);
        return "ok";
    }
}

✔ 분석

String data = request.getParameter("data")

• HTTP 요청 파라미터는 모두 문자로 처리됨
• 요청 파라미터를 자바에서 다른 타입으로 변환해서 사용하고 싶 으면 다음과 같이 숫자 타입으로 변환하는 과정을 거쳐야 함

 

⚡ @RequestParam 사용

HelloController - 추가

    @GetMapping("/hello-v2")
    public String helloV2(@RequestParam Integer data){
        System.out.println("data = "+ data);
        return "ok";
    }

• HTTP 쿼리 스트링으로 전달하는 data=10 부분에서 10은 숫자 10이 아니라 문자 10
• 스프링이 제공하는 @RequestParam 을 사용하면 이 문자 10을 Integer 타입의 숫자 10으로 받을 수 있음

 

 

✔ @ModelAttribute 타입 변환 예시

@ModelAttribute UserData data

class UserData{
    Integer data;
}

• @RequestParam 처럼 문자 data=10을 숫자로 받을 수 있음

 

✔ @PathVariable

/users/{userId}
@PathVariable("userId") Integer data

• URL 경로는 문자
  • /users/10 -> 여기서 10도 문자
  • Integer 타입으로 받아낼 수 있음

 

✔ 스프링의 타입 변환 적용 예시

• 스프링 MVC 요청 파라미터
  • @RequestParam
  • @ModelAttribute
  • @PathVariable
• @Value 등으로 YML 정보 읽기
• XML에 넣은 스프링 빈 정보를 반환
• 뷰를 렌더링할 때

 

 

📌 타입 컨버터 - Converter

⚡ 컨버터 인터페이스

package org.springframework.core.convert.converter;
public interface Converter<S, T> {
   T convert(S source);
}

• 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현해서 등록
• 모든 타입에 적용 가능
• 필요하면 X Y 타입으로 변환하는 컨버터 인터페이스를 만들고, 또 Y X 타입으로 변환하는 컨버터 인터페이스를 만들어서 등록

 

✔ Example

• 문자로 "true" 가오면 Boolean 타입으로 받고싶으면 String Boolean 타입으로 변환되도록 컨버터 인터페이스를 만들어서 등록하고, 반대로 적용하고 싶으면 Boolean String 타입으로 변환되도록 컨버터를 추가로 만들어서 등록하면 됨

주의❗
Converter 라는 이름의 인터페이스가 많으니 조심
org.springframework.core.convert.converter.Converter 사용

 

 

⚡ StringToIntegerConverter - 문자를 숫자로 변환하는 타입 컨버터

package hello.typeconverter.converter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.convert.converter.Converter;

@Slf4j
public class StringToIntegerConverter implements Converter<String, Integer> {

    @Override
    public Integer convert(String source){
        log.info("convert source={}", source);
        return Integer.valueOf(source);
    }
}

• String -> Integer 로 변환하기 때문에 소스가 String 이 됨
• Integer.valueOf(source) 를 사용해서 숫자로 변경한 다음에 변경된 숫자를 반환

 

 

⚡ IntegerToStringConverter - 숫자를 문자로 변환하는 타입 컨버터

package hello.typeconverter.converter;

import lombok.extern.slf4j.Slf4j;
import org.springframework.core.convert.converter.Converter;

@Slf4j
public class IntegerToStringConverter implements Converter<Integer, String> {

    @Override
    public String convert(Integer source){
        log.info("convert source={}", source);
        return String.valueOf(source);
    }     
}

• 숫자를 문자로 변환하는 타입 컨버터

 

 

✔ ConverterTest - 타입 컨버터 테스트 코드

package hello.typeconverter.converter;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;

public class ConverterTest {

    @Test
    void stringToInteger(){
        StringToIntegerConverter converter = new StringToIntegerConverter();
        Integer result = converter.convert("10");
        Assertions.assertThat(result).isEqualTo(10);
    }

    @Test
    void integerToString(){
        IntegerToStringConverter converter = new IntegerToStringConverter();
        String result = converter.convert(10);
        Assertions.assertThat(result).isEqualTo("10");
    }
}

 

 

⚡ 사용자 정의 타입 컨버터

• 127.0.0.1:8080 과 같은 IP, PORT를 입력하면 IpPort 객체로 변환하는 컨버터

✔ IpPort

package hello.typeconverter.type;

import lombok.EqualsAndHashCode;
import lombok.Getter;

@Getter
@EqualsAndHashCode
public class IpPort {

    private String ip;
    private int port;

    public IpPort(String ip, int port){
        this.ip = ip;
        this.port = port;
    }
}

• 롬복의 @EqualsAndHashCode 를 넣으면 모든 필드를 사용해서 equals() , hashcode() 를 생성
• 따라서 모든 필드의 값이 같다면 a.equals(b) 의 결과가 참이 됨

 

✔ SpringToPortConverter - 컨버터

package hello.typeconverter.converter;

import hello.typeconverter.type.IpPort;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.convert.converter.Converter;

@Slf4j
public class StringToPortConverter implements Converter<String, IpPort> {

    @Override
    public IpPort convert(String source) {
        log.info("convert source={}", source);
        String[] split = source.split(":");
        String ip = split[0];
        int port = Integer.parseInt(split[1]);

        return new IpPort(ip, port);
    }
}

➡ 127.0.0.1:8080 같은 문자를 입력하면 IpPort 객체를 만들어 반환

 

 

✔ IpPortToStringConverter

package hello.typeconverter.converter;

import hello.typeconverter.type.IpPort;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.convert.converter.Converter;

@Slf4j
public class IpPortToStringConverter implements Converter<IpPort, String> {

    @Override
    public String convert(IpPort source) {
        log.info("convert source={}", source);
        return source.getIp() + ":" + source.getPort();
    }
}

➡ IpPort 객체를 입력하면 127.0.0.1:8080 같은 문자를 반환

 

 

ConverterTest - IpPort 컨버터 테스트 추가

    @Test
    void stringToIpPort(){
        StringToPortConverter converter = new StringToPortConverter();
        String source = "127.0.0.1:8080";
        IpPort result = converter.convert(source);
        assertThat(result).isEqualTo(new IpPort("127.0.0.1", 8080));
    }

    @Test
    void ipPortToString(){
        IpPortToStringConverter converter = new IpPortToStringConverter();
        IpPort source = new IpPort("127.0.0.1", 8080);
        String result = converter.convert(source);
        assertThat(result).isEqualTo("127.0.0.1:8080");
    }

• 타입 컨버터를 등록하고 관리하면서 편리하게 변환 기능을 제공하는 역할을 하는 무언가가 필요함

cf)

스프링은 용도에 따라 다양한 방식의 타입 컨버터를 제공

• Converter ➡ 기본 타입 컨버터
• ConverterFactory ➡ 전체 클래스 계층 구조가 필요할 때
• GenericConverter ➡ 정교한 구현, 대상 필드의 애노테이션 정보 사용 가능
• ConditionalGenericConverter  특정 조건이 참인 경우에만 실행
  
  참고링크

 

cf)

• 스프링은 문자, 숫자, 불린, Enum등 일반적인 타입에 대한 대부분의 컨버터를 기본으로 제공
• IDE에서 Converter , ConverterFactory , GenericConverter 의 구현체를 찾아보면 수 많은 컨버터 확인 가능

 

 

📌 컨버전 서비스 - ConversionService

➡ ConversionService : 스프링은 개별 컨버터를 모아두고 그것들을 묶어서 편리하게 사용할 수 있는 기능을 제공

 

⚡ ConversionService 인터페이스

package org.springframework.core.convert;

import org.springframework.lang.Nullable;

public interface ConversionService {
    boolean canConvert(@Nullable Class<?> sourceType, Class<?> targetType);
    boolean canConvert(@Nullable TypeDescriptor sourceType, TypeDescriptor targetType);

    <T> T convert(@Nullable Object source, Class<T> targetType);
    Object convert(@Nullable Object source, @Nullable TypeDescriptor sourceType, TypeDescriptor targetType);

}

➡ 컨버전 서비스 인터페이스는 확인하는 기능과, 컨버팅 기능을 제공

 

ConversionServiceTest - 컨버전 서비스 테스트 코드

package hello.typeconverter.converter;

import hello.typeconverter.type.IpPort;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.core.convert.support.DefaultConversionService;

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

public class ConversionServiceTest {

    @Test
    void conversionService(){
        //등록
        DefaultConversionService conversionService = new DefaultConversionService();
        conversionService.addConverter(new StringToIntegerConverter());
        conversionService.addConverter(new IntegerToStringConverter());
        conversionService.addConverter(new StringToPortConverter());
        conversionService.addConverter(new IpPortToStringConverter());


        //사용
        assertThat(conversionService.convert("10", Integer.class)).isEqualTo(10);
        assertThat(conversionService.convert(10, String.class)).isEqualTo("10");
        IpPort ipPort = conversionService.convert("127.0.0.1:8080", IpPort.class);
        assertThat(ipPort).isEqualTo(new IpPort("127.0.0.1", 8080));

        String isPortString = conversionService.convert(new IpPort("127.0.0.1", 8080), String.class);
        assertThat(isPortString).isEqualTo("127.0.0.1:8080");
    }
}

• DefaultConversionService : ConversionService 인터페이스를 구현했는데, 추가로 컨버터를 등록하는 기능도 제공함

 

✔ 등록과 사용 분리

• 컨버터를 등록할 때는 StringToIntegerConverter 같은 타입 컨버터를 명확하게 알아야 함
• 컨버터를 사용하는 입장에서는 타입 컨버터를 전혀 몰라도 됨
• 타입 컨버터들은 모두 컨버전 서비스 내부에 숨어서 제공됨
  ➡ 타입을 변환을 원하는 사용자는 컨버전 서비스 인터페이스에만 의존하면 됨
  ➡ 물론 컨버전 서비스를 등록하는 부분과 사용하는 부분을 분리하고 의존관계 주입을 사용해야 함

 

✔ 컨버전 서비스 사용

Integer value = conversionService.convert("10", Integer.class)

 

✔ 인터페이스 분리 원칙 - ISP(Interface Segregation Principle)

인터페이스 분리 원칙 : 클라이언트가 자신이 이용하지 않는 메서드에 의존하지 않아야 함

ISP : 인터페이스를 분리하는 것

 

DefaultConversionService 는 두 인터페이스 구현

• ConversionService : 컨버터 사용에 초점
• ConverterRegistry : 컨버터 등록에 초점

➡ 인터페이스를 분리하면 컨버터를 사용하는 클라이언트와 컨버터를 등록하고 관리하는 클라이언트의 관심사를 명확하게 분리할 수 있음
➡  컨버터를 사용하는 클라이언트는 ConversionService 만 의존하면 되므로, 컨버터 를 어떻게 등록하고 관리하는지는 전혀 몰라도 됨
➡ 결과적으로 컨버터를 사용하는 클라이언트는 꼭 필요한 메서드만 알게됨

 

 

📌 스프링에 Converter 적용하기

⚡ WebConfig - 컨버터 등록

package hello.typeconverter;

import hello.typeconverter.converter.IntegerToStringConverter;
import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIntegerConverter;
import hello.typeconverter.converter.StringToPortConverter;
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 StringToIntegerConverter());
        registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToPortConverter());
        registry.addConverter(new IpPortToStringConverter());

    }
}

• 스프링은 내부에서 ConversionService 를 제공
• WebMvcConfigurer 가 제공하는 addFormatters() 를 사용해서 추가하고 싶은 컨버터를 등록
• 스프링은 내부에서 사용하는ConversionService 에 컨버터를 추가해줌

 

HelloController - 기존 코드

    @GetMapping("/hello-v2")
    public String helloV2(@RequestParam Integer data){
        System.out.println("data = "+ data);
        return "ok";
    }

 

✔ 실행 로그

StringToIntegerConverter   : convert source=10
data = 10

• ?data=10 의 쿼리 파라미터는 문자이고 이것을 Integer data 로 변환하는 과정이 필요
• 실행해보면 직접 등록한 StringToIntegerConverter 가 작동하는 로그를 확인할 수 있음
• StringToIntegerConverter 를 등록하기 전에도 이 코드는 잘 수행되었음
• 스프링이 내부에서 수 많은 기본 컨버터들을 제공하기 때문
• 컨버터를 추가하면 추가한 컨버터가 기본 컨버터 보다 높은 우선 순위를 가짐

 

HelloController - 추가

    @GetMapping("/ip-port")
    public String ipPort(@RequestParam IpPort ipPort){
        System.out.println("ipPort IP = " + ipPort.getIp());
        System.out.println("ipPort PORT = " + ipPort.getPort());
        return "ok";
    }

실행 http://localhost:8080/ip-port?ipPort=127.0.0.1:8080

 

✔ 실행 로그

 StringToIpPortConverter : convert source=127.0.0.1:8080
 ipPort IP = 127.0.0.1
 ipPort PORT = 8080

• ?ipPort=127.0.0.1:8080 쿼리 스트링이 @RequestParam IpPort ipPort 에서 객체 타입으로 잘 변환 된 것을 확인할 수 있음

 

✔ 처리 과정

• @RequestParam : @RequestParam 을 처리하는 ArgumentResolver 인 RequestParamMethodArgumentResolver 에서 ConversionService 를 사용해서 타입을 변환
• 부모 클래스와 다양한 외부 클래스를 호출하는 등 복잡한 내부 과정을 거치기 때문에 대략 이렇게 처리되는 것으로 이해해도 충분
• 더 깊이있게 확인하고 싶으면 IpPortConverter 에 디버그 브레이크 포인트를 걸어서 확인

 

 

📌 뷰 템플릿에 컨버터 적용하기

• 타임리프는 렌더링 시에 컨버터를 적용해서 렌더링 하는 방법을 편리하게 지원
• 이전까지는 문자를 객체로 변환했다면, 이번에는 그 반대로 객체를 문자로 변환하는 작업 가능

⚡ ConverterController

package hello.typeconverter.controller;

import hello.typeconverter.type.IpPort;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class ConverterController {

    @GetMapping("/converter-view")
    public String converterView(Model model){
        model.addAttribute("number", 10000);
        model.addAttribute("ipPort", new IpPort("127.0.0.1", 8080));

        return "converter-view";
    }
}

➡ Model 에 숫자 10000 와 ipPort 객체를 담아서 뷰 템플릿에 전달

 

 

🔶 resources/templates/converter-view.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body> <ul>
    <li>${number}: <span th:text="${number}" ></span></li>
    <li>${{number}}: <span th:text="${{number}}" ></span></li>
    <li>${ipPort}: <span th:text="${ipPort}" ></span></li>
    <li>${{ipPort}}: <span th:text="${{ipPort}}" ></span></li>
</ul>
</body>
</html>

• 타임리프는 ${{...}} 를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해줌
• 스프링과 통합 되어서 스프링이 제공하는 컨버전 서비스를 사용하므로, 우리가 등록한 컨버터들을 사용할 수 있음
• 변수 표현식 : ${...}
• 컨버전 서비스 적용 : ${{...}}

 

✔ 실행 결과

• ${number}: 10000
• ${{number}}: 10000
• ${ipPort}: hello.typeconverter.type.IpPort@59cb0946
• ${{ipPort}}: 127.0.0.1:8080

 

✔ 실행 결과 로그

IntegerToStringConverter   : convert source=10000
IpPortToStringConverter    : convert
source=hello.typeconverter.type.IpPort@59cb0946

• ${{number}} : 뷰 템플릿은 데이터를 문자로 출력
  ➡ 컨버터를 적용하게 되면 Integer 타입인 10000 을 String 타입으로 변환하는 컨버터인 IntegerToStringConverter 를 실행하게 됨
  ➡ 이 부분 은 컨버터를 실행하지 않아도 타임리프가 숫자를 문자로 자동으로 변환히기 때문에 컨버터를 적용할 때와 하지 않을 때가 같음
• ${{ipPort}} : 뷰 템플릿은 데이터를 문자로 출력
  ➡ 컨버터를 적용하게 되면 IpPort 타입을 String 타입으로 변환해야 하므로 IpPortToStringConverter 가 적용됨
  ➡ 127.0.0.1:8080 가 출력됨

 

 

⚡ 폼에 적용하기

ConverterController - 코드 추가

package hello.typeconverter.controller;

import hello.typeconverter.type.IpPort;
import lombok.Data;
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;

@Controller
public class ConverterController {

    @GetMapping("/converter-view")
    public String converterView(Model model){
        model.addAttribute("number", 10000);
        model.addAttribute("ipPort", new IpPort("127.0.0.1", 8080));

        return "converter-view";
    }

    @GetMapping("/converter/edit")
    public String converterForm (Model model){
        IpPort ipPort = new IpPort("127.0.0.1", 8080);
        Form form = new Form(ipPort);

        model.addAttribute("form", form);
        return "converter-form";
    }

    @PostMapping("/converter/edit")
    public String converterEdit(@ModelAttribute Form form, Model model){
        IpPort ipPort = form.getIpPort();
        model.addAttribute("ipPort", ipPort);
        return "converter-view";
    }


    @Data
    static class Form{
        private IpPort ipPort;

        public Form(IpPort ipPort){
            this.ipPort = ipPort;
        }
    }
}

➡ Form 객체를 데이터를 전달하는 폼 객체로 사용

• GET /converter/edit : IpPort 를 뷰 템플릿 폼에 출력
• POST /converter/edit : 뷰 템플릿 폼의 IpPort 정보를 받아서 출력

 

 

🔶 resources/templates/converter-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">
    th:field <input type="text" th:field="*{ipPort}"><br/>
    th:value <input type="text" th:value="*{ipPort}">(보여주기 용도)<br/> <input type="submit"/>
</form>
</body>
</html>

• 타임리프의 th:field 는 id , name 를 출력하는 등 다양한 기능이 있는데, 여기에 컨버전 서비스도 함께 적용됨

• GET /converter/edit
  • th:field 가 자동으로 컨버전 서비스를 적용해주어서 ${{ipPort}} 처럼 적용이 됨
  • IpPort String 으로 변환

•  
• POST /converter/edit
  • @ModelAttribute 를 사용해서 String IpPort 로 변환됨

 

 

📌 포맷터 - 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" 으로
• 1000 단위로 쉼표가 들어가는 포맷을 적용
• 그 반대도 처리해주는 포맷터도 만들 수 있음

 

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;

@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(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.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;

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

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.*;

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 을 넣어주어야 함

 

✔ 실행 결과 로그

MyNumberFormatter - text=1,000, locale=ko_KR
MyNumberFormatter - object=1000, locale=ko_KR

• Formatter 포맷터
• AnnotationFormatterFactory 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터
• 공식 문서 참고

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

 

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

• 컨버전 서비스 : 컨버터만 등록할 수 있고, 포맷터는 등록 불가
  • 포맷터는 객체 ➡ 문자, 문자 ➡ 객체로 변환하는 특별한 컨버터
• FormattingConversionService : 포맷터를 지원하는 컨버전 서비스
  • 포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가 가능 !!
  • 내부에서 어댑터 패턴을 사용 해서 Formatter 가 Converter 처럼 동작하도록 지원

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

package hello.typeconverter.formatter;

import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToPortConverter;
import hello.typeconverter.type.IpPort;
import org.junit.jupiter.api.Test;
import org.springframework.core.convert.support.DefaultConversionService;

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

public class FormattingConversionServiceTest {

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

        //컨버터 등록
        conversionService.addConverter(new StringToPortConverter());
        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 를 내부에서 사용

 

⚡ 포맷터 적용하기

✔ WebConfig - 수정

package hello.typeconverter;

import hello.typeconverter.converter.IntegerToStringConverter;
import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIntegerConverter;
import hello.typeconverter.converter.StringToPortConverter;
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 StringToIntegerConverter());
//        registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToPortConverter());
        registry.addConverter(new IpPortToStringConverter());

        // 추가
        registry.addFormatter(new MyNumberFormatter());
    }
}

 

❗ 주의

• StringToIntegerConverter , IntegerToStringConverter 를 꼭 주석처리
  • MyNumberFormatter 도 숫자 문자, 문자 숫자로 변경하기 때문에 둘의 기능이 겹침
  • 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용됨

 

✔ 실행 - 객체 ➡ 문자

http://localhost:8080/converter-view

• ${number}: 10000
• ${{number}}: 10,000

➡ 컨버전 서비스를 적용한 결과 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 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";
    }

    @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>
</html>

 

결과

• ${form.number}: 10000
• ${{form.number}}: 10,000
• ${form.localDateTime}: 2021-01-01T00:00:00
• ${{form.localDateTime}}: 2021-01-01 00:00:00

cf)

• @NumberFormat , @DateTimeFormat
• 사용법 검색

주의❗

• 메시지 컨버터( HttpMessageConverter )에는 컨버전 서비스가 적용되지 않음
  • 객체를 JSON으로 변환할 때 메시지 컨버터를 사용하면서 이 부분을 많이 오해하는데, HttpMessageConverter 의 역할은 HTTP 메시지 바디의 내용을 객체로 변환하거나 객체를 HTTP 메시지 바디에 입력하는 것
• ex) JSON을 객체로 변환하는 메시지 컨버터는 내부에서 Jackson 같은 라이브러리를 사용
  • 객체를 JSON으로 변환한다면 그 결과는 이 라이브러리에 달린 것
  • JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정해야 함
  • 결과적으로 이것은 컨버전 서비스와 전혀 관계가 없음
  • 컨버전 서비스는 @RequestParam , @ModelAttribute , @PathVariable , 뷰 템플릿 등에서 사용할 수 있음

 

 

 

김영한님의 <스프링 MVC 2편 - 백엔드 웹 개발 활용 기술>을 수강하고 작성한 글입니다

 

 

 

---

PREV

[스프링 MVC 2편] 9. API 예외 처리

 

NEXT

[스프링 MVC 2편] 11. 파일 업로드