본문 바로가기
Backend, Server/Spring MVC

[Spring MVC] 스프링 타입 컨버터

by ggyongi 2022. 5. 23.
반응형

1. 타입 컨버터의 사용

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

package org.springframework.core.convert.converter;

public interface Converter<S, T> {
    T convert(S source);
}

 

예시) Integer타입을 String타입으로 변환해주는 컨버터

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

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

제네릭 문자 S, T에는 내가 직접 만든 타입도 당연히 사용 가능하다. 아래가 그 예시이다.

예시) IpPort객체를 String으로 변환하는 컨버터

@Getter
@AllArgsConstructor
@EqualsAndHashCode
public class IpPort {

    private String ip;
    private int port;
}

 

@Slf4j
public class IpPortToStringConverter implements Converter<IpPort, String> {
    @Override
    public String convert(IpPort source) {
        log.info("convert source={}", source);
        return source.getIp() + ":" + source.getPort();
    }
}

 

아래와 같이 테스트 가능하다.

public class ConverterTest {

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

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

 

그런데 이렇게 컨버터를 직접 생성하고 사용하는 것은 변환을 직접 하는 것에 비해 전혀 이점이 없다.

오히려 더 귀찮을 수 있음. 그래서 컨버터를 쉽게 등록하고 사용하게 해주는 컨버전 서비스가 있다.

 

 

 

2. 컨버전 서비스 사용

컨버전 서비스 인터페이스는

1. 컨버팅이 가능한지 확인하는 기능

2. 컨버팅 기능

을 제공한다.

 

사용예시)

.convert()로 등록한 컨버터를 사용 가능!

public class ConversionServiceTest {

    @Test
    void conversionService() {
        //등록
        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");
    }
}

 

 

 

3. 스프링에 Converter 적용

스프링엔 아래와 같이 적용할 수 있다.

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
    
        registry.addConverter(new StringToIntegerConverter());
        registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());

    }

}

 

- 뷰템플릿에 컨버터 적용

타임리프에선 아래와 같이 이중괄호{{...}} 를 써주면, 컨버전 서비스를 이용해 자동으로 변환을 해준다.

아래에선 

<!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

 

 

- 폼에 적용

th:field를 사용하면 자동으로 컨버전 서비스를 통해 컨버터 적용!

<!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>

 

 

4. 포매터 Formatter

Formatter는 문자에 특화된 컨버터 버전이라 할 수 있다.

(객체 -> 문자 또는  문자 -> 객체) + 현지화(Locale)

 

만들땐 포매터 인터페이스를 구현하면 된다. 아래는 예시이다.

Formatter는 String과 자유자재로 바꿀 타입을 <>안에 적어주면 된다.

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

 

포매터 테스트

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

 

포매터도 FormattingConversionService라는 곳에 등록하여 사용 가능하다.

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);
    }
}

 

 

 

5. 포매터 적용

포매터는 아래와 같이 스프링에서 적용하고 사용할 수 있다.

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        //주석처리 우선순위
        //registry.addConverter(new StringToIntegerConverter());
        //registry.addConverter(new IntegerToStringConverter());
        registry.addConverter(new StringToIpPortConverter());
        registry.addConverter(new IpPortToStringConverter());

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

}

 

 

6. 스프링이 기본으로 제공하는 포매터

어노테이션으로 매우 쉽게 포매터 사용이 가능하다.

 

@NumberFormat : 숫자 관련 형식 지정 포매터 사용

@DateTimeFormat : 날짜 관련 형식 지정 포매터 사용

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

 

 

----------------------------------------------
참고 : 인프런 김영한님 강의(스프링 MVC 2편 - 백엔드 웹 개발 활용 기술)

저작자표시 비영리 변경금지
 

비전공자 네카라 신입 취업 노하우

시행착오 끝에 얻어낸 취업 노하우가 모두 담긴 전자책!

kmong.com

관련글

댓글

티스토리툴바