스프링 MVC 학습목록 (2)

📝 학습목록 & GPT에게 물어본 질문 목록

---

📙 1. 스프링 타입 컨버터

1) Converter

컨버터는 org.springframework.convert.converter.Converter

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

인터페이스를 구현하여 만든다.

---

2) ConversionService

스프링은 개발 컨버터를 모아두고 그것을 묶어서 편리하게 사용할 수 있는 기능을 준다

그것이 ConversionService 인터페이스

package org.springframework.core.convert;
import java.util.List;

public interface ConversionService {

    boolean canConvert(Class<?> sourceType, Class<?> targetType);
    boolean canConvert(TypeDescriptor sourceType, TypeDescriptor targetType);

    <T> T convert(Object source, Class<T> targetType);
    Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType);

}

메서드로 canConvert 와 convert를 제공한다.

 

구현체로는 DefaultConversionService가 있다. 

(* ConversionService와 ConversionRegistry를 구현한 ConfigurableConversionService를 구현한 GenericConversionService를 상속받은 구현체다..)

 

// 등록

DefaultConversionService는 addConverter() 이용해 컨버터를 등록할 수 있다.

 

// 사용

DefaultConversionService는 convert() 가능

 

‘등록’과 ‘사용’ 분리

등록하는 입장에서는 등록할 컨버터들을 명확히 알아야 한다.

하지만 사용하는 입장에서는 몰라도되니깐 ConversionService에만 의존한다.

 

📗 인터페이스 분리 원칙 (ISP)

- 클라이언트가 자신이 이용하지 않는 메서드에 의존하지 않아야한다

 

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

즉 컨버터를 사용하는 클라이언트는 ConversionService 인터페이스만 의존하면 되니깐 나머지는 관심없고 알 필요도 없다.

 

어찌됐든 스프링은 내부에서 ConversionService를 이용해서 타입을 변환하고, @RequestParam, @ModelAttribute, @PathVariable 같은 애너테이션도 ConversionService를 이용해서 변환한다.

 

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

---

3) WebMvcConfigurer 의 addFormatters 구현

스프링 웹MVC에 뭔가 등록할때는 WebMvcConfigurer구현한 클래스 @Configuration으로 등록했다

@Configuration

public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new StringToIpPortConverter());
        …
    }
}

 

스프링은 내부에서 ConversionService를 제공하고 우리는 addFormatters를 사용해서 추가하고 싶은 converter를 등록하면된다.

 

그러면 스프링은 내부에서 사용하는 ConversionService에 converter를 등록해준다.

1) 문자열 → 타입 OK

2) View에서 타입 → 문자열은?

 

타임리프에서 ${{...}} 이렇게 하면 ConversionService(타입 → 문자열) 적용가능

* th:field는 ${...}만 해도 ConversionService 적용된다.

* th:value는 ${{...}}해야 함.

---

4) Converter vs Formatter

Converter는 범용 : 객체 -> 객체

Formatter는 문자에 특화 : 문자 -> 객체, 객체 -> 문자 + Locale(현지화) (Converter의 특별 버전)

 

Printer 인터페이스와 Parser인터페이스를 구현한 것이 Formatter 인터페이스

import org.springframework.format.Formatter;
import org.springframework.stereotype.Component;

import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.Locale;

@Component
public class LocalDateFormatter implements Formatter<LocalDate> {

    private static final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd");

    @Override
    public LocalDate parse(String text, Locale locale) {
        try {
            return LocalDate.parse(text, formatter);
        } catch (Exception e) {
            throw new IllegalArgumentException("Invalid date format. Please use yyyy-MM-dd");
        }
    }

    @Override
    public String print(LocalDate object, Locale locale) {
        return object.format(formatter);
    }
}

 

 

1000 <-> 1,000 자바가 기본적으로 제공하는 NumberFormat을 이용해서 만들자 locale정보에따라 다르게 만들어줌.

package hello.typeconverter.formatter;

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("object={}, locale={}", object, locale);
        return NumberFormat.getInstance(locale).format(object);
    }
}

---

5) Formatter를 지원하는 ConversionService

ConversionService는 Converter만 등록할 수 있다. 

그러나 잘 생각해보면 Formatter는 문자 ↔ 객체 를 해주는 특수한 Converter일 뿐이다.

 

Formatter를 지원히는 ConversionService를 사용하면 ConversionService에 Formatter를 등록할 수 있다.

내부에서 Adapter Pattern을 사용해서 Formatter가 Converter처럼 동작하도록 지원한다.

 

FormattingConversionService 는 Formatter를 지원하는 ConversionService
DefaultFormattingConversionService 는 FormattingConversionService 에 기본적인 통화, 숫자
관련 몇가지 기본 Formatter를 추가해서 제공한다.

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

 

📝 DefaultFormattingConversionService 상속 관계

FormattingConversionService 는 ConversionService 관련 기능을 상속받기 때문에 Converter도 Formatter도 모두 등록할 수 있다. 사용할 때는 ConversionService 가 제공하는 convert를 사용하면 됨.

 

스프링 부트는 DefaultFormattingConversionService 를 상속 받은 WebConversionService를 내부에서 사용함.

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
    
        //주석처리 우선순위
        // * MyNumberFormatter 도 숫자 문자, 문자 숫자로 변경하기 때문에 둘의 기능이 겹침. 
        // * 우선순위는 컨버터가 우선하므로 포맷터가 적용되지 않고, 컨버터가 적용됨.
        //registry.addConverter(new StringToIntegerConverter());
        //registry.addConverter(new IntegerToStringConverter());

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

---

6) 스프링이 제공하는 기본 Formatter

스프링은 자바에서 기본으로 제공하는 타입들에 대해 수 많은 Formatter를 기본으로 제공.

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

이런 문제를 해결하기 위해 애노테이션 기반으로 원하는 형식을 지정해서 사용할 수 있는 매우 유용한 Formatter 2가지를 기본으로 제공.
@NumberFormat : 숫자 관련 형식 지정 Formatter 사용
@DateTimeFormat : 날짜 관련 형식 지정 Formatter 사용

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

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

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

---

7) ConversionService와 HttpMessageConverter

메시지 컨버터(HttpMessageConverter)에는 ConversionService가 적용되지 않는다.

객체 ↔ JSON 으로 변환할 때 HttpMessageConverter를 사용하면서 이 부분을 많이 착각하는 경우가 많다. HttpMessageConverter 의 역할은 HTTP 메시지 body의 내용을 객체로 변환하거나 객체를 HTTP 메시지 바디에 입력하는 것이다. 

(HttpMessage body ↔ 객체)

 

JSON을 객체로 변환하는 메시지 컨버터는 내부에서 Jackson 같은 라이브러리를 사용한다.

객체를 JSON으로 변환한다면 그 결과는 이 라이브러리에 달린 것.

따라서 JSON 결과로 만들어지는 숫자나 날짜 포맷을 변경하고 싶으면 해당 라이브러리가 제공하는 설정을 통해서 포맷을 지정해야 한다. 

 

결과적으로 이것은 컨버전 서비스와 전혀 관계가 없다.
컨버전 서비스는 @RequestParam , @ModelAttribute , @PathVariable , 뷰 템플릿 등에서 사용할 수 있다.

---

📙 2. 파일 업로드

1) HTML Form 전송방식 2가지

1. application/x-www-form-urlencoded → form 태그에 별도 enctype 옵션없이 전송

• 웹 브라우저는 요청 HTTP 메시지의 헤더에 다음내용을 추가한다. Content-Type: application/x-www-form-urlencoded
• 폼에 입력한 전송할 항목을 HTTP Body에 문자로 username=kim&age=20 와 같이 & 로 구분해서 전송

2. multipart/form-data → form 태그에 별도 enctype 옵션추가,  multipart/form-data 라는 전송 방식 사용

• multipart/form-data 방식은 다른 종류의 여러 파일과 폼의 내용 함께 전송 가능.

POST /save HTTP/1.1
Host: localhost:8080
Content-Type: multipart/form-data; boundary=------XXX
Content-Length: 34521

------XXX
Content-Disposition: form-data; name="username"

kim
------XXX
Content-Disposition: form-data; name="age"

20
------XXX
Content-Disposition: form-data; name="file1"; filename="img32.png"
Content-Type: image/png

12dfkli1k1k23kj3kkj4
------XXX--

---

2) 서버에서 multipart/form-data 메세지 사용

 

 

 

---

📚 Reference

위 학습 요약은 김영한님의 '스프링 MVC 강의 2편' 을 기초로 작성되었습니다.