4 분 소요

 인프런 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술편을 학습하고 정리한 내용 입니다.

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

타임리프는 렌더링 시에 컨버터를 적용해서 렌더링 하는 방법을 편리하게 지원한다.

이전까지는 문자를 객체로 변환했다면, 이번에는 그 반대로 객체를 문자로 변환하는 작업을 확인할 수 있다.

코드 구현

ConverterController

1
2
3
4
5
6
7
8
9
10

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

간단하게 숫자랑 직접 만든 커스텀 객체 IpPort를 넘겼다.

resources/templates/converter-view.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<!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>$: <span th:text="$" ></span></li>  
    <li>${ipPort}: <span th:text="${ipPort}" ></span></li>  
    <li>$: <span th:text="$" ></span></li>  
</ul>  
  
</body>  
</html>

자 여기서 보면 ${}, $이렇게 두 개가 있는데,

$를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해준다.

  • $ : 뷰 템플릿은 데이터를 문자로 출력한다. 따라서 컨버터를 적용하게 되면 Integer타입인 10000을 String타입으로 변환하는 컨버터를 실행하게 된다. 이 부분은 컨버터를 실행하지 않아도 타임리프가 숫자를 문자로 자동으로 변환하기 때문에 컨버터를 적용할 때와 하지 않을 때가 같다.

  • $ : 뷰 템플릿은 데이터를 문자로 출력한다. 따라서 컨버터를 적용하게 되면 IpPortToStringConverter가 동작한다. 그 결과 127.0.0.1:8080이 출력된다.

폼에 적용하기

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

@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  
@NoArgsConstructor  
static class Form {  
    private IpPort ipPort;  
  
    public Form(IpPort ipPort) {  
        this.ipPort = ipPort;  
    }  
}

다음과 같이 폼 클래스를 하나 만들고 기본으로 IpPort 객체가 들어가도록 해놨다.

그 다음에 폼 템플릿과 등록하는 로직도 만들었다.

resources/templates/converter-form.html

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<!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:object로 폼 객체를 잡았고, 그 안에서 th:field="*{ipPort}"로 IpPort 객체를 잡았다.

th:field는 id, name를 출력하는 등 다양한 기능이 있는데, 여기에 컨버전 서비스도 함께 적용된다.

따라서 화면을 보면

th:field는 컨버팅이 되서 문자열로 잘 나온 걸 볼 수 있다.

포맷터 - Formatter

Converter는 입력과 출력 타입에 제한이 없는, 범용 타입 변환 기능을 제공한다.

이번에는 일반적인 웹 애플리케이션 환경을 생각해 보자. 불린 타입을 숫자로 바꾸는 것 같은 범용 기능 보다는 개발자 입장에서는 문자를 다른 타입으로 변환하거나, 다른 타입을 문자로 변환하는 상황이 대부분이다.

앞서 살펴본 예제들을 떠올려 보면 문자를 다른 객체로 변환하거나 객체를 문자로 변환하는 일이 대부분이다.

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

  • 화면에 숫자를 출력해야 하는데, Integer → String 출력 시점에 숫자 1000을 문자 "1,000" 이렇게 1000 단위에 쉼표를 넣어서 출력하거나, 또는 1,000을 숫자 1000으로 변경하고 싶을 때
  • 날짜 객체를 문자인 2021-01-01 10:10:11와 같이 출력하거나 또는 그 반대의 상황

Locale

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

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

Converter vs Formatter

  • Converter는 범용 (객체 → 객체)
  • Formatter는 문자에 특화 (객체 ↔ 문자) + 현지화 (Locale)
    • Converter의 특별한 버전

포맷터 만들기

포맷터(Formatter)는 객체를 문자로 변경하고, 문자를 객체로 변경하는 두 가지 기능을 모두 수행한다.

  • String print(T object, Locale locale) : 객체를 문자로 변경한다.
  • T parse(String text, Locale locale) : 문자를 객체로 변경한다.
1
2
3
4
5
6
7
8
9
10

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> { 
}

이제 Formatter를 구현해 보자.

MyNumberFormatter

hello.typeconverter.formatter.MyNumberFormatter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

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

1,000처럼 숫자 중간의 쉼표를 적용하려면 자바가 기본으로 제공하는 NumberFormat객체를 사용하면 된다. 이 객체는 Locale정보를 활용해서 나라 별로 다른 숫자 포맷을 만들어 준다.

parse()를 사용해서 문자를 숫자로 변환한다. 참고로 Number는 Integer, Long의 부모 타입이다.

print()를 사용해서 객체를 문자로 변환한다.

잘 동작하는지 테스트 코드를 작성해 보자.

MyNumberFormatterTest

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

class MyNumberFormatterTest {  
  
    MyNumberFormatter formatter = new MyNumberFormatter();  
  
    @Test  
    void parse() throws Exception {  
        Number result = formatter.parse("1,000", Locale.KOREA);  
        assertThat(result).isEqualTo(1000L);  
    }  
  
    @Test  
    void print() {  
        String result = formatter.print(1000L, Locale.KOREA);  
        assertThat(result).isEqualTo("1,000");  
    }  
  
}

parse()의 결과가 Long이기 때문에 isEqualTo(1000L)을 통해 비교할 때 마지막에 L을 넣어준다.

변환이 잘 됐다.

참고
스프링은 용도에 따라 다양한 방식의 포맷터를 제공한다.
Formatter 포맷터
AnnotationFormatterFactory 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터

자세한 내용은 공식 문서를 참고하자.

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

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

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

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

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

테스트 코드를 통해 등록하는 방법을 알아보자.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

댓글남기기

참고