해당 저장소의 README.md
는 인프런 김영한님의 SpringBoot 강의 시리즈를 듣고 Spring 프레임워크의 방대한 기술들을 복기하고자 공부한 내용을 가볍게 정리한 것입니다.
문제가 될 시 삭제하겠습니다.
- 섹션 10 | 스프링 타입 컨버터
애플리케이션을 개발하다 보면 타입을 변환해야 하는 경우가 상당히 많다. 스프링에서 제공하는 타입 컨버터는 기본적으로 수많은 타입 변환을 지원하며, 추가적으로 사용자 정의의 타입을 변경하고 싶을 때 사용된다.
- 해당 어노테이션은 스프링이 중간에서 타입을 변환해 준 것이다.
@ModelAttribute
,@PathVariable
도 마찬가지로 타입 변환을 지원한다.
@GetMapping("/hello-v2")
public String helloV2(@RequestParam Integer data) {
System.out.println("data = " + data);
return "ok";
}
- 스프링 MVC 요청 파라미터(이것 이외에 아래 방식은 어떤 것인지 잘 모르겠다. 나중에 공부하기로..)
@RequestParam
,@ModelAttribute
,@PathVariable
@Value
등으로 YML 정보 읽기- XML에 넣은 스프링 빈 정보를 변환
- 뷰를 렌더링 할 때
스프링은 확장 가능한 컨버터 인터페이스를 제공한다. 개발자는 스프링에 추가적인 타입 변환이 필요하면 이 컨버터 인터페이스를 구현해서 등록하면 된다.
package org.springframework.core.convert.converter;
public interface Converter<S, T> {
T convert(S source);
}
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;
}
}
[컨버터 정의 - StringToIpPortConverter
]
package hello.typeconverter.converter;
import hello.typeconverter.type.IpPort;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.convert.converter.Converter;
@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.valueOf(split[1]);
return new IpPort(ip, port);
}
}
[컨버터 정의 - 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();
}
}
[테스트 코드]
package hello.typeconverter.converter;
import hello.typeconverter.type.IpPort;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
class ConverterTest {
@Test
void stringToIpPort() {
StringToIpPortConverter converter = new StringToIpPortConverter();
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 ipPort = new IpPort("127.0.0.1", 8080);
String result = converter.convert(ipPort);
assertThat(result).isEqualTo("127.0.0.1:8080");
}
}
위와 같이 타입 컨버터를 하나씩 직접 생성해서 타입 변환하는 것은 기존에 사용하던 방식과 유사해서 별로 유용해보이지 않는다. 그래서 스프링은 개별 컨버터를 모아두고, 그것들을 묶어서 편리하게 사용할 수 있는 기능을 제공하는데, 이것이 바로 컨버전 서비스이다.
컨버전 서비스 인터페이스는 단순히 컨버팅이 가능한지, 확인하는 기능과 컨버팅 기능을 제공한다.
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);
}
DefaultConversionService
는 ConversionService 인터페이스를 구현하는데, 추가로 컨버터를 등록하는 기능도 제공한다.
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 IpPortToStringConverter());
conversionService.addConverter(new StringToIpPortConverter());
// 사용
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(Interface Segregation Principle)
인터페이스 분리 원칙은 클라이언트가 자신이 이용하지 않는 메서드에 의존하지 않아야 한다. 위의 예제에서처럼
DefaultConversionService
는 다음 인터페이스를 구현했는데
- ConversionService: 컨버터 사용에 초점
- ConverterRegistry: 컨버터 등록에 초점
이렇게 인터페이스를 분리하면 컨버터를 사용하는 클라이언트와, 컨버터를 등록하고 관리하는 클라이언트의 관심사를 명확하게 분리할 수 있다.
결과적으로 컨버터를 사용하는 클라이언트는 꼭 필요한 메서드만 알게된다.
@RequestParam
같은 곳에서도ConversionService
를 사용해서 타입을 변환한다.
[WebConfig
]
- 스프링은 내부에서
ConversionService
를 제공한다. WebMvcConfigurer.addFormatters()
를 사용해서 추가하고 싶은 컨버터를 등록하면 된다.- 이렇게 하면 스프링은 내부에서 사용하는
ConversionSerivce
에 컨버터를 추가해준다.
package hello.typeconverter;
import hello.typeconverter.converter.IntegerToStringConverter;
import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIntegerConverter;
import hello.typeconverter.converter.StringToIpPortConverter;
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 IpPortToStringConverter());
registry.addConverter(new StringToIpPortConverter());
}
}
[Hellocontroller
]
@GetMapping("/hello-v2")
public String helloV2(@RequestParam Integer data) {
System.out.println("data = " + data);
return "ok";
}
위의 컨트롤러를 실행했을 때 결과는 아래와 같다.
- 스프링은 내부에서 수 많은 기본 컨버터를 제공하게 되는데, 컨버터를 추가하면 기존 컨버터 보다 우선순위를 가지게 된다.
StringToIntegerConverter : convert source=10
data = 10
@GetMapping("ip-port")
public String ipPort(@RequestParam IpPort ipPort) {
System.out.println("ipPort.getIp() = " + ipPort.getIp());
System.out.println("ipPort.getPort() = " + ipPort.getPort());
return "ok";
}
@RequestParam
을 처리하는 ArgumentResolver
인 RequestParamMethodArgurmentResolver
에서 ConversionSerivce
을 사용해서 타입을 변환한다.
결국 내부적으로 ConversionSerivce
를 사용해서 타입 컨버터를 진행하게 된다.
StringToIpPortConverter : convert source=127.0.0.1:8080
ipPort IP = 127.0.0.1
ipPort PORT = 8080
타임리프는 렌더링 시 컨버터를 적용해서 렌더링 하는 방법을 지원한다. 이전까지는 문자를 객체로 변환했다면, 이번에는 그 반대로 객체를 문자로 변환하는 작업을 확인할 수 있다.
- 타임리프는
${{...}}
를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해준다.{{number}}
: 뷰 템플릿은 데이터를 문자로 출력한다.{{ipPort}}
: 뷰 템플릿은 데이터를 문자로 출력한다. IpPort 타입을 String 타입으로 변환해야 하므로IpPortToStringConverter
가 적용된다.
GET /converter/edit
th:field
가 자동으로 컨버전 서비스를 적용해주어서${{ipPort}}
처럼 적용이 된다. 따라서 IpPort -> String으로 변환된다.
POST /converter/edit
@ModelAttribute
를 사용해서String -> IpPort
로 변환된다.
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;
}
}
}
[converter-view
]
<!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>
[converter-form
]
- 타임리프의
th:field
는 id, name, value 뿐만 아니라 컨버전 서비스도 함께 적용한다.
<!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>
객체를 특정한 포맷에 맞추어 문자로 출력하거나, 또는 그 반대의 역할을 하는 것에 특화된 기능이 바로 포맷터(Formatter)이다.
Converter
는 범용(객체 -> 객체)Formatter
는 문자에 특화(객체 -> 문자, 문자 -> 객체) + 현지화(Locale)
포맷터는 객체를 문자로 변경하고, 문자를 객체로 변경하는 두 가지 기능을 모두 수행한다.
String print(T object, Locale locale)
: 객체를 문자로 변경한다.T parse(String text, Locale locale)
: 문자를 객체로 변경한다.
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
] - 포맷터 정의
- 1,000처럼 숫자 중간에 쉼표를 적용하려면 자바가 기본으로 제공하는
NumberFormat
객체를 사용하면 된다.Locale
정보를 활용해서 나려별로 다른 숫자 포맷을 만들어준다.
package hello.typeconverter.fomatter;
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("objcet = {}, locale = {}", object, locale);
return NumberFormat.getInstance(locale).format(object);
}
}
[MyNumberFormatterTest
] - 테스트 코드
package hello.typeconverter.fomatter;
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.*;
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); // parse의 결과가 Long이기 때문에 L을 넣어주어야 함
}
@Test
void print() {
String result = formatter.print(1000, Locale.KOREA);
assertThat(result).isEqualTo("1,000");
}
}
MyNumberFormatter - text=1,000, locale=ko_KR
MyNumberFormatter - object=1000, locale=ko_KR
컨버전 서비스에는 컨버터만 등록할 수 있고, 포맷터를 등록할 수 없다.(DefaultConversionService
)
하지만 포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있다.
- 내부에서 어댑터 패턴을 사용해서
Formatter
가Converter
처럼 동작하도록 지원한다. FormattingConversionService
는 포맷터를 지원하는 컨버전 서비스이다.
[FormattingConversionServiceTest
] - 테스트 코드
- 컨버전, 포맷터 서비스 등록 및 사용 -
DefaultFormattingConversionService
(FormattingConversionService
+ 부가 기능)
package hello.typeconverter.fomatter;
import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIpPortConverter;
import hello.typeconverter.type.IpPort;
import org.junit.jupiter.api.Test;
import org.springframework.format.support.DefaultFormattingConversionService;
import static org.assertj.core.api.Assertions.assertThat;
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(1000);
}
}
- FormattingConversionService는 ConversionService 관련 기능도 상속받기 때문에 결과적으로 컨버터도 포맷터도 모두 등록할 수 있다.
- 사용할 때는 컨버터, 포맷터 구분 없이
ConversionService
가 제공하는convert()
를 사용하면 된다.
- 위에서 만든 숫자 -> 문자, 문자 -> 숫자 포맷터를 적용시키기 위해서는 기존 컨버터를 주석처리를 해야한다.
- 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용된다.
package hello.typeconverter;
import hello.typeconverter.converter.IpPortToStringConverter;
import hello.typeconverter.converter.StringToIpPortConverter;
import hello.typeconverter.fomatter.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 IpPortToStringConverter());
registry.addConverter(new StringToIpPortConverter());
// 추가
registry.addFormatter(new MyNumberFormatter());
}
}
- 객체 -> 문자(http://localhost:8080/converter-view)
MyNumberFormatter
가 적용되어서 10,000 문자가 출력됨
• ${number}: 10000
• ${{number}}: 10,000
- 문자 -> 객체(http://localhost:8080/hello-v2?data=10,000)
- "10,000"이란 포맷팅 된 문자가
Integer
타입의 숫자 10000으로 변경됨
- "10,000"이란 포맷팅 된 문자가
MyNumberFormatter : text=10,000, locale=ko_KR
data = 10000
스프링은 자바에서 기본으로 제공하는 타입들에 대해 수 많은 포맷터를 기본으로 제공하지만, 기본 형식이 지정되어 있기 때문에 각 필드마다 다른 형식으로 포맷을 지정하기 어렵다.
스프링은 이런 문제를 해결하기 위해 어노테이션을 기반으로 원하는 형식을 지정해서 사용할 수 있는 매우 유용한 포맷터 두 가지를 기본으로 제공한다.
@NumberFormat
: 숫자 관련 형식 지정 포맷터 사용, (NumberFormatAnnotationFormatterFactory
)@DateTimeFormat
: 날짜 관련 형식 지정 포맷터 사용
[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 org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;
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";
}
@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;
}
}
[formatter-view
]
<!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>
[formatter-form
]
<!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>
- 지정된 포맷으로 출력된 것을 확인할 수 있다.
${form.number}: 10000
${{form.number}}: 10,000
${form.localDateTime}: 2021-01-01T00:00:00
${{form.localDateTime}}: 2021-01-01 00:00:00
컨버터를 사용하든, 포맷터를 사용하든 등록 방법은 다르지만, 사용할 땐 컨버전 서비스를 통해서 일관성 있게 사용할 수 있다. 컨버전 서비스는 @RequestParam, @ModelAttribute, @PathVariable, 뷰 템플릿 등에서 사용할 수 있다.