[Spring] 스프링 타입 컨버터

JJoSuk·2023년 6월 12일

IntelliJ Java Spring

본 프로젝트 자료는 김영한님의 스프링 MVC 2편 - 백엔드 웹 개발 활용 기술을 참고 제작됐음을 알립니다.

스프링 타입 컨버터 소개

문자를 숫자로, 숫자를 문자로 타입 변환해야 하는 경우가 생긴다. 이때 스프링 타입 컨버터를 사용해 간편하게 변경할 수 있다.

스프링을 사용하고 안하고 변경했을 때,

HelloController - 신규 클래스 생성

HTTP 요청 파라미터는 모두 문자로 처리된다. 따라서 문자를 숫자로 변경하고 싶으면, 숫자 타입으로 변환하는 과정을 거쳐야 한다.

하지만 스프링 MVC 에서 제공하는 @RequestParam 을 사용해보자.

@RequestParam 을 사용하면 사용자가 따로 변환할 필요없이 숫자 타입이 들어와도 자동 인식해 문자를 숫자로 변경해준다.

이러한 예는 @ModelAttribute , @PathVariable 에서도 확인할 수 있다.

@ModelAttribute 타입 변환 예시

@RequestParam 와 비슷한 개념이다.

@PathVariable 타입 변환 예시

여기도 data를 Integer 타입으로 받을 수 있는 것도 스프링이 타입 변환을 해주기 때문이다.

이렇게 간단하게 변경 가능할 수 있는거는 스프링 MVC 에서 컨버터 인터페이스를 제공하기에 편하게 사용할 수 있는거다.

참고

과거에는 PropertyEditor 라는 것으로 타입을 변환했다. PropertyEditor 는 동시성 문제가 있어서
타입을 변환할 때 마다 객체를 계속 생성해야 하는 단점이 있다. 지금은 Converter 의 등장으로 해당 문제들이 해결되었고, 기능 확장이 필요하면 Converter 를 사용하면 된다.

타입 컨버터 - Converter

타입 컨버터를 사용하려면 org.springframework.core.convert.converter.Converter 인터페이스를 구현하면 된다.

Converter 라는 이름의 인터페이스가 많으니 조심해야 한다.

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

String Integer 로 변환하기 때문에 소스가 String 이 된다.

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

이번에는 숫자가 입력되기 때문에 소스가 Integer 가 된다.

이제 테스트 코드를 통해서 타입 컨버터가 어떻게 동작하는지 확인해보자.

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

사용자 정의 타입 컨버터

IpPort - 신규 클래스 생성

롬복의 @EqualsAndHashCode 를 넣으면 모든 필드를 사용해서 equals() , hashcode() 를 생성한다.

따라서 모든 필드의 값이 같다면 a.equals(b) 의 결과가 참이 된다.

StringToIpPortConverter - 컨버터

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

IpPortToStringConverter

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

이제 테스트 해보자.

ConverterTest - IpPort 컨버터 테스트 추가

하지만 이렇게 하나하나 개발자가 직접 컨버팅하는 것과 차이가 없다.
타임 컨버터 등록하고 관리하면서 편리하게 변환 기능을 제공하는 역할이 있을 것이다.

참고

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

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

컨버전 서비스 - ConversionService

스프링은 개별 컨버터를 모아두고 그것들을 묶어서 편리하게 사용할 수 있는 기능을 제공하는데, 이것이 바로 컨버전 서비스( ConversionService )라고 부른다.

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

등록과 사용 분리

타입 컨버터들은 모두 컨버전 서비스 내부에 숨어서 제공된다. 따라서 타입을 변환을 원하는 사용자는 컨버전 서비스 인터페이스에만 의존하면 된다. 물론 컨버전 서비스를 등록하는 부분과 사용하는 부분을 분리하고 의존관계 주입을 사용해야 한다.

DefaultConversionService 는 다음 두 인터페이스를 구현했다.

등록

컨버터를 등록할 때는 타입 컨버터를 명확하게 알아야 한다.
ConverterRegistry : 컨버터 등록에 초점

사용

컨버터를 사용하는 입장에서는 타입 컨버터를 전혀 몰라도 된다.
ConversionService : 컨버터 사용에 초점

이렇게 인터페이스를 분리하면 컨버터를 사용하는 클라이언트와 컨버터를 등록하고 관리하는 클라이언트의 관심사를 명확하게 분리할 수 있다.

특히 컨버터를 사용하는 클라이언트는 ConversionService 만 의존하면 되므로, 컨버터를 어떻게 등록하고 관리하는지는 전혀 몰라도 된다.

결과적으로 컨버터를 사용하는 클라이언트는 꼭 필요한 메서드만 알게된다. 이렇게 인터페이스를 분리하는 것을 ISP 라 한다.

스프링에 Converter 적용하기

WebConfig - 신규 클래스 생성

컨버터 등록

스프링은 내부에서 ConversionService 를 제공한다.
WebMvcConfigurer 가 제공하는 addFormatters() 를 사용해서 추가하고 싶은 컨버터를 등록하면 된다.
이렇게 하면 스프링은 내부에서 사용하는 ConversionService 에 컨버터를 추가해준다.

등록한 컨버터가 잘 동작하는걸 확인 할 수 있다.

이번에는 직접 정의한 타입인 IpPort 이 잘 작동하는지 확인해볼려고 한다.

HelloController - 추가

이것도 잘 동작하는걸 확인 할 수 있다.

처리 과정

@RequestParam 은 @RequestParam 을 처리하는 ArgumentResolver 인 RequestParamMethodArgumentResolver 에서 ConversionService 를 사용해서 타입을 변환한다.

부모 클래스와 다양한 외부 클래스를 호출하는 등 복잡한 내부 과정을 거치기 때문에 대략 이렇게 처리되는 것으로 이해해도 충분하다.

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

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

ConverterController - 추가

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

HTML - 등록

타임리프는 ${{...}} 를 사용하면 자동으로 컨버전 서비스를 사용해서 변환된 결과를 출력해준다.

출력 결과

${{number}} : 뷰 템플릿은 데이터를 문자로 출력한다. Integer 타입인 10000 을 String 타입으로 변환하는 컨버터인 IntegerToStringConverter 를 실행하게 된다.
${{ipPort}} : 뷰 템플릿은 데이터를 문자로 출력한다. IpPort 타입을 String 타입으로 변환해야 하므로 IpPortToStringConverter 가 적용된다.

폼에 적용하기

이번에는 컨버터를 폼에 적용해보자.

ConverterController - 코드 추가

Form 객체를 데이터를 전달하는 폼 객체로 사용한다.
GET /converter/edit : IpPort 를 뷰 템플릿 폼에 출력한다.
POST /converter/edit : 뷰 템플릿 폼의 IpPort 정보를 받아서 출력한다.

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) : 문자를 객체로 변경한다.

이제 숫자 1000 을 문자 "1,000" 으로 그러니까, 1000 단위로 쉼표가 들어가는 포맷을 적용해보자. 그리고 그 반대도 처리해주는 포맷터를 만들어보자.

MyNumberFormatter

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

parse() 를 사용해서 문자를 숫자로 변환한다. 참고로 Number 타입은 Integer , Long 과 같은 숫자 타입의 부모 클래스이다.
print() 를 사용해서 객체를 문자로 변환한다.

잘 동작하는지 테스트 코드를 만들어보자.

MyNumberFormatterTest

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

실행 결과

정상적으로 출력이 됐다.

참고

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

Formatter 포맷터
AnnotationFormatterFactory 필드의 타입이나 애노테이션 정보를 활용할 수 있는 포맷터

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

컨버전 서비스에는 컨버터만 등록할 수 있고, 포맷터를 등록할 수 는 없다. 그런데 생각해보면 포맷터는 객체 -> 문자, 문자 -> 객체로 변환하는 특별한 컨버터일 뿐이다.

포맷터를 지원하는 컨버전 서비스를 사용하면 컨버전 서비스에 포맷터를 추가할 수 있다. 내부에서 어댑터 패턴을 사용해서 Formatter 가 Converter 처럼 동작하도록 지원한다.

FormattingConversionService 는 포맷터를 지원하는 컨버전 서비스이다.
DefaultFormattingConversionService 는 FormattingConversionService 에 기본적인 통화, 숫자 관련 몇가지 기본 포맷터를 추가해서 제공한다.

FormattingConversionServiceTest - 테스트 생성

DefaultFormattingConversionService 상속 관계

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

추가로 스프링 부트는 DefaultFormattingConversionService 를 상속 받은 WebConversionService 를 내부에서 사용한다.

포맷터 적용하기

포맷터를 웹애플리케이션에 적용해보자.

WebConfig - 수정

StringToIntegerConverter , IntegerToStringConverter 우선순위 주석처리

MyNumberFormatter 도 숫자 문자, 문자 숫자로 변경하기 때문에 둘의 기능이 겹친다. 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용된다.

이제 실행해서 적용됐는지 확인해보자.

실행 결과

1,000 으로 제대로 적용이 된거를 확인 할 수 있다.

나머지도 확인해본다.

스프링이 제공하는 기본 포맷터

스프링 자바는 포맷터를 기본으로 제공한다. IDE에서 Formatter 인터페이스의 구현 클래스를 찾아보면 수 많은 날짜나 시간 관련 포맷터가 제공되는 것을 확인할 수 있다.
그런데 포맷터는 기본 형식이 지정되어 있기 때문에, 객체의 각 필드마다 다른 형식으로 포맷을 지정하기는 어렵다.

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

@NumberFormat : 숫자 관련 형식 지정 포맷터 사용, NumberFormatAnnotationFormatterFactory
@DateTimeFormat : 날짜 관련 형식 지정 포맷터 사용, Jsr310DateTimeFormatAnnotationFormatterFactory

이제 어떻게 적용되는지 알아보자.