Spring Converter / Formatter를 이용한 데이터 바인딩

Converter와 Formatter

 

PropertyEditor는 스프링 초기(3.0이전)에 사용되었던 데이터 바인딩 인터페이스 였으나, 현재는 Converter와 Formatte라는 데이터 바인딩 인터페이스를 주로 사용하고 있다.

 

Converter는 S타입을 T 타입으로 변환할 수 있는 일반적인 변환기이며 Thread-safe하다. 

Formatter는 Object와 String간의 변환을 담당하며 역시 Thread-safe하다.

또한  문자열을 Locale에 따라 다국화하는 기능을 제공한다. (Optional)

 

 

Converter / Formatter 구현 및 테스트

 

Event VO 생성

 
 
public class Event {
    
    Integer id;
    String title;
 
    public Event() {
        
    }
    
    public Event(Integer id) {
        this.id =id;
    }
 
    public Event(Integer id, String title) {
        
        this.id = id;
        this.title = title;
    }
    
    public Integer getId() {
        return id;
    }
 
    public void setId(Integer id) {
        this.id = id;
    }
 
    public String getTitle() {
        return title;
    }
 
    public void setTitle(String title) {
        this.title = title;
    }
}
 
 
 

EventConverter 생성 

-> 아래와 같이 String to Int 메서드를 오버라이딩하는 StringToEventConverter 클래스

-> 아래와 같이 Event to String 메서드를 오버라이딩하는 EventToStringConverter 클래스 생성

 

package com.example.demo;
 
import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;
 
public class EventConverter {
 
    public static class StringToEventConverter implements Converter<String, Event> {
 
        @Override
        public Event convert(String source) {
            // TODO Auto-generated method stub
            return new Event(Integer.parseInt(source));
        }
        
        
    }
    
    public static class EventToStringConverter implements Converter<Event, String> {
 
        @Override
        public String convert(Event source) {
            // TODO Auto-generated method stub
            return source.getId().toString();
        }
        
    }
    
    
    
}
 
 

 

Configuration 생성

->Converter와 Formatter를 설정파일에 등록해야 사용가능하다.

package com.example.demo;
 
import java.util.Set;
 
import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ConversionServiceFactoryBean;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.converter.Converter;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
@Configuration
public class WebConfig implements WebMvcConfigurer{
 
    @Override
    public void addFormatters(FormatterRegistry formatterRegistry) {
        
        // 1. Converter
        formatterRegistry.addConverter(new EventConverter.StringToEventConverter());
        
        // 2. Formatters
        formatterRegistry.addFormatter(new EventFormatter());
        
    }
 
}
 

Formatter 구현

Formatter는 제네릭으로 한개의 인자만을 받는다. Converter와 달리 Object와 String 간의 변환을 담당하기 때문이다.

 

package com.example.demo;
 
import java.text.ParseException;
import java.util.Locale;
 
import org.springframework.format.Formatter;
 
public class EventFormatter implements Formatter <Event> {
 
    @Override
    public String print(Event object, Locale locale) {
        // TODO Auto-generated method stub
        return object.getId().toString();
    }
 
    @Override
    public Event parse(String text, Locale locale) throws ParseException {
        // TODO Auto-generated method stub
        return new Event(Integer.parseInt(text));
    }
 
    
    
}
 

 

ConversionService

 

- Converter와 Formatter 두 데이터 바인딩 인터페이스는 위에서 WebMvcConfigurer의 메서드를 통해 ConversionService에 등록된다.

 

package com.example.demo;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.convert.ConversionService;
import org.springframework.stereotype.Component;
 
@Component
public class AppRunner implements ApplicationRunner {
 
    @Autowired
    ConversionService conversionService;
 
    @Override
    public void run(ApplicationArguments args) throws Exception {
        // TODO Auto-generated method stub
        System.out.println(conversionService.getClass().toString());
 
 
    }
    
    
 
}
 

그러나 스프링 부트에서는 Formatter와 Converter를 Component로 등록하면 위와 같이 WebMvcConfigurer를 사용하지 않을 수 있다.

 

ex : ) @Component

        public class EventFormatter implements Formatter <Event>

 

 

아래와 같이 Controller를 작성하고 테스트가 가능하다.

package com.example.demo;
 
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class EventController {
 
    @GetMapping("/event/{event}")
    public String getEvent(@PathVariable Event event) {
        System.out.println(event); 
        return event.getId().toString();
    }
    
}
 

 

EventController 테스트