HTTP Message Converter 이야기(1)

 

 

 

뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라,

HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

 

 

스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.

HTTP 요청 : @RequestBody , HttpEntity(RequestEntity)
HTTP 응답 : @ResponseBody , HttpEntity(ResponseEntity) 

 

 

HTTP 메시지 컨버터 인터페이스

---

org.springframework.http.converter.HttpMessageConverter

package org.springframework.http.converter;

  public interface HttpMessageConverter<T> {
  
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
    
    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
    
    List<MediaType> getSupportedMediaTypes();
    
    T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;
            
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage
  outputMessage)throws IOException, HttpMessageNotWritableException;
  
}

 

HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.

 

canRead() , canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크
read(), write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

 

 

 

스프링 부트 기본 메시지 컨버터

---

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.

(일부 생략)

  0 = ByteArrayHttpMessageConverter
  1 = StringHttpMessageConverter
  2 = MappingJackson2HttpMessageConverter

 

 

위의 몇가지 주요한 메시지 컨버터들에 대해 알아보자.

ByteArrayHttpMessageConverter 
byte[] 데이터를 처리한다.
클래스 타입: byte[] , 미디어타입: */* 요청
예) @RequestBody byte[] data 응답
예) @ResponseBody return byte[] 쓰기 미디어타입 application/octet-stream

StringHttpMessageConverter
String 문자로 데이터를 처리한다.
클래스 타입: String , 미디어타입: */* 요청
예) @RequestBody String data 응답
예) @ResponseBody return "ok" 쓰기 미디어타입 text/plain

MappingJackson2HttpMessageConverter
application/json
클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련요청
예) @RequestBody HelloData data 응답
예) @ResponseBody return helloData 쓰기 미디어타입 application/json 관련

 

위의 정의를 바탕으로 간단하게 코드를 보며 이해 해보자.

 

 

StringHttpMessageConverter

// content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}

먼저 클래스 타입은 String이다. 그럼 0순위를 지나 1순위로 되어있는 StringHttpMessageConverter로 갈 것이다. 그러고나서 해당 컨버터의 미디어 타입을 확인해보니 */* (모든 타입을 허용) 으로 되어 있다. 즉, content-type 이 application/json으로 되어 있는 해당 요청은 허용이 된다. 따라서 StringHttpMessageConverter가 사용 됨을 알 수 있다.

 

 

MappingJackson2HttpMessageConverter

//content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}

이번에는 클래스 타입이 객체이다. 그럼 0순위를 지나고, 다시 2순위도 지나, 마지막 3순위 MappingJackson2HttpMessageConverter로 가게 될 것이다. 해당 컨버터의 미디어 타입은 application/json 관련요청이라고 적혀 있다. 위의 코드에서 설정한 content-type과 일치한다. 따라서 MappingJackson2HttpMessageConverter 가 사용 될 것이다.

 

 

???

//content-type: text/html
@RequestMapping
void hello(@RequetsBody HelloData data) {}

이번에도 역시 객체 타입이다. MappingJackson2HttpMessageConverter 로 갈 것이다. 그런데 미디어 타입이 application/json 관련요청이어야 하는데, 위의 코드에서는 text/html 타입이다. 따라서 이 상황은 탈락이라고 볼 수 있겠다.

 

 

HTTP 요청 데이터 읽기

---

1. HTTP 요청이 오고, 컨트롤러에서 @RequestBody , HttpEntity 파라미터를 사용한다.

 

2. 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출한다.

     : (1) 대상 클래스 타입을 지원하는가.
            예) @RequestBody 의 대상 클래스 ( byte[] , String , HelloData )

       (2) HTTP 요청의 Content-Type 미디어 타입을 지원하는가.

            예) text/plain , application/json , */*

 

3. canRead() 조건을 만족하면 read() 를 호출해서 객체 생성하고, 반환한다.

 

 

 

HTTP 응답 데이터 생성

---

1. 컨트롤러에서 @ResponseBody , HttpEntity 로 값이 반환된다.

2. 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.

    : (1) 대상 클래스 타입을 지원하는가.
           예) return의 대상 클래스 ( byte[] , String , HelloData )

      (2) HTTP 요청의 Accept 미디어 타입을 지원하는가.

          (더 정확히는 @RequestMapping 의 produces )

           예) text/plain , application/json , */*

 

3. canWrite() 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.