김영한 개발자님의 스프링 MVC 2 강의를 수강하고 정리한 내용이다.
10. 스프링 타입 컨버터
HTTP 요청 파라미터는 모두 문자로 처리된다. 따라서 요청 파라미터를 자바에서 다른 타입으로 변환해서 사용하고 싶으면 숫자 타입으로 변환해야 한다.
스프링에서는 다음과 같이 @RequestParam을 통해서 중간에서 형변환을 해준다.
@GetMapping("/hello-v2")
public String helloV2(@RequestParam Integer data){
System.out.println("data = " + data);
return "OK";
}이러한 예는 @ModelAttribute, @PathVariable에서도 볼 수 있다.
10.1. 타입 컨버터
package org.springframework.core.convert.converter;
public interface Converter<S, T> {
T convert(S source);
}스프링은 확장 가능한 컨버터 인터페이스를 제공한다.
개발자는 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현해서 등록하면 된다.
문자를 숫자로 변환하는 컨버터
@Slf4j
public class StringToIntegerConverter implements Converter<String, Integer> {
@Override
public Integer convert(String source) {
log.info("convert source={}", source);
return Integer.valueOf(source);
}
}127.0.0.1:8080 같은 문자를 입력하면 IpPort 객체를 만들어 반환하는 컨버터
public class IpPort {
private String ip;
private int port;
public IpPort(String ip, int port) {
this.ip = ip;
this.port = port;
}
}
@Slf4j
public class StringToIpPortConverter 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);
}
}10.1.1. 컨버전 서비스
개별 컨버터를 모아두고 묶어서 편리하게 사용할 수 있는 기능을 제공한다.
컨버팅 할수 있는가와 컨버팅을 해주는 두 가지 기능을 제공한다.
//등록
DefaultConversionService conversionService = new DefaultConversionService();
conversionService.addConverter(new StringToIntegerConverter());
conversionService.addConverter(new IntegerToStringConverter());
conversionService.addConverter(new StringToIpPortConverter());
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 ipPortString = conversionService.convert(new IpPort("127.0.0.1", 8080), String.class);
assertThat(ipPortString).isEqualTo("127.0.0.1:8080");이렇게 등록과 사용이 잘 분리된 것을 인터페이스 분리 원칙(ISP)를 잘 지켰다고 한다.
10.1.2. 스프링에 컨버터를 적용하기
스프링은 내부에서 ConversionService를 제공한다.
WebMvcConfigurer 가 제공하는 addFormatters() 를 사용해서 추가하고 싶은 컨버터를 등록하면 된다.
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(new StringToIntegerConverter());
registry.addConverter(new StringToIpPortConverter());
}
}10.1.3. 뷰 템플릿에 컨버터 적용하기
: 타임리프에서는 {}가 두 개 있면 자동으로 적용한다.
<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>-
GET /converter/edit
th:field가 자동으로 컨버전 서비스를 적용해주어서${{ipPort}}처럼 적용이 되었다. 따라서IpPort String으로 변환된다. -
POST /converter/edit
@ModelAttribute를 사용해서String IpPort로 변환된다.
10.2. 포맷터
객체를 특정한 포멧에 맞추어 문자로 출력하거나 또는 그 반대의 역할을 하는 것에 특화된 기능이 포맷터(Formatter)이며 컨버터의 특화된 기능이다.
객체를 문자로 변경하고 문자를 객체로 변경하는 두 가지 기능을 모두 수행한다
Formatter 인터페이스
public interface Printer<T> {
String print(T object, Locale locale);
}
public interface Parser<T> {
T parse(String text, Locale locale) throws ParseException;
}
// 위 2개를 상속
public interface Formatter<T> extends Printer<T>, Parser<T> {
}숫자 1000 을 문자 "1,000" 으로 (1000 단위로 쉼표가 들어가는 )포맷하는 포맷터
@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정보를 활용해서 나라별로 다른 숫자 포맷을 만들어준다.
FormattingConversionService
포맷터를 지원하는 컨버전 서비스이다.
@Test
void formattingConversionService() {
DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();
//컨버터 등록
conversionService.addConverter(new StringToIpPortConverter());
//포맷터 등록
conversionService.addFormatter(new MyNumberFormatter());
//포맷터 사용
assertThat(conversionService.convert(1000, String.class)).isEqualTo("1,000");
assertThat(conversionService.convert("1,000", Long.class)).isEqualTo(1000L);
}FormattingConversionService 는 ConversionService 관련 기능을 상속받기 때문에 컨버터도 포맷터도 모두 등록할 수 있다.
스프링이 지원하는 기본 포맷터
객체의 각 필드마다 다른 형식으로 포맷을 지정하기는 어렵다 이래서 아래의 두 가지를 제공한다.
@NumberFormat: 숫자 관련 형식 지정 포맷터 사용,NumberFormatAnnotationFormatterFactory@DateTimeFormat: 날짜 관련 형식 지정 포맷터 사용,Jsr310DateTimeFormatAnnotationFormatterFactory
@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;
}
}위와 같이 컨트롤러를 만들고 폼을 만들어 호출하면, 변환이 잘 되는 것을 확인할수 있다.
다만, HttpMessageConverter에는 컨버젼 서비스가 적용되지 않는다.
특히 객체를 JSON으로 변환할 때 메시지 컨버터를 사용하면서 이 부분을 많이 오해하는데, HttpMessageConverter 의 역할은 HTTP 메시지 바디의 내용을 객체로 변환하거나 객체를 HTTP 메시지 바디에 입력하는 것이다. 결과적으로 이것은 컨버전 서비스와 전혀 관계가 없다.
컨버전 서비스는 @RequestParam , @ModelAttribute , @PathVariable , 뷰 템플릿 등에서 사용할 수 있다.
