[Spring] HTTP 메시지 컨버터 이해쉽게 개념 정리

스프링을 공부하다 보면 @RequestBody 어노테이션을 사용하여 JSON에서 자바객체로 변환하여 반환해 주고, 또 자바객체에서 JSON으로 간편하게 변환하는 것을 알고 있을 겁니다.

 

하지만 이게 어떻게 가능하지? 그냥 알아서 마법처럼 되는건가? 라는 생각만 하고 넘어가셨을 분들도 많습니다.

 

이번 글은 그러한 궁금증들을 풀기 위해 작성된 공부 개념 정리글입니다.

 

혹시 @RequestBody에 대해 아직 잘 모르시는 분들은 아래링크를 참조하시길 바랍니다.

[Spring] 스프링MVC HTTP 응답

 

 

---

 

스프링MVC 동작과정

HTTP 메시지 컨버터를 제대로 공부하기 전에 우선, 스프링 MVC와 @ResponseBody의 사용원리를 이해해야 합니다.

 

스프링 MVC는 다음 아래 사진과 같이 동작하게 됩니다.

1. HTTP 요청이 들어오면 핸들러(컨트롤러) 조회
2. 핸들러를 처리할 수 있는 핸들러 어댑터 조회
3. handle(handler) 실행
4. handler 호출
5. ModelAndView 반환
6. viewResolver 호출
7. View 반환
8. render(model) 호출

 

위 과정에서 우리는 4번 과정에 주목해야 합니다.

어노테이션 기반의 핸들러(컨트롤러)의 여러 파라미터를 생성해서 호출하는 '핸들러 어댑터'

이 어댑터가 우리가 공부할 HTTP 메시지 컨버터와 관련이 있습니다.

 

 

@ResponseBody 사용 원리

 

@ResponseBody 를 사용하면 HTTP의 Body에 문자 내용을 직접 반환합니다

 

그때, 스프링 컨테이너에서 'HttpMessageConver' 라는 것이 동작합니다.

 

HttpMessageConverter 인터페이스는 많은 구현체를 가지고 있는데

기본 문자를 처리해야할 때는 'StringHttpMessageConverter'

기본 객체를 처리해야할 때는 'MappingJackson2HttpMessageConver' 가 동작하게 됩니다.

 

 

---

 

HTTP 메시지 컨버터

다음 코드는 스프링의 HttpMessageConverter 인터페이스 코드입니다.

public interface HttpMessageConverter<T> {

    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

    List<MediaType> getSupportedMediaTypes();
    
    default List<MediaType> getSupportedMediaTypes(Class<?> clazz) {
       return (canRead(clazz, null) || canWrite(clazz, null) ?
             getSupportedMediaTypes() : Collections.emptyList());
    }

    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(), wirte() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능입니다.

 

스프링 부트 기본 메시지 컨버터 (일부 생략)

아래 사진은 메시지 컨버터(HttpMessageConverter)의 구현체 중 우선순위가 높은 순으로 나타낸 것입니다.

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 두 가지를 체크하여 사용 여부를 결정합니다.

 

만약, 만족하지 않는다면 다음 메시지 컨버터로 우선순위가 넘어가게 됩니다.

 

실제로 HttpMassageConverter의 구현체를 확인해 보면 아래 사진과 같이 많은 구현체들이 존재하는 것들을 확인하실 수 있습니다. (일부 생략)

 

 

우선순위가 높은(주요 컨버터) 3가지 메시지 컨버터를 살펴보자.

 

ByteArrayHttpMessageConverter

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

 

StringHttpMessageConverter

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

 

MappinJackson2HttpMessageConverter

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

 

 

글로만 보면 이해가 안 되니, 다음 예시를 보고 HTTP 메시지 컨버터가 어떻게 사용되는 이해 해보자

content-type: application/json

@RequestMapping
void hello(@RequestBody String data) {...}

//StringHttpMessageConverter 호출

위 코드에서 Byte 타입으로 요청이 들어오지 않았기 때문에, 다음 우선순위 컨버터인 StringHttpMessageConverter에서 확인을 합니다.

 

StringHttpMassageConverter는 미디어타입이 */*이기 때문에 application/json 형식도 받아들이고, 요청 타입 또한 String이기 때문에 StringHttpMessageConverter가 호출됩니다.

 

 

content-type: application/json

@RequestMapping
void hello(@RequestBody HelloData data) {...}

//MappingJackson2HttpMessageConverter 호출

위 코드에서 StringHttpMessageConverter는 미디어타입에서는 통과하지만, 요청 타입이 String 타입이 아닌 객체이기 때문에 다음 우선순위 컨버터인 MappingJackson2HttpMessageConverter를 호출합니다.

 

 

content-type: text/html

@RequestMapping
void hello(@RequestBody HelloData data) {...}

//호출 가능한 http 메시지 컨버터가 없다. ERROR 발생

위 코드에서는 Byte 타입이 아니기 때문에 Byte 메시지 컨버터는 밀려나고 다음 우선순위인 String 메시지 컨버터가 호출됩니다. 하지만 미디어타입은 통과하되 요청 타입이 객체이기 때문에 다음 우선순위 메시지 컨버터인 MappingJackson2HttpMessageConverter를 호출합니다.

 

 

하지만, 요청타입은 객체이지만 미디어타입이 application/json이 아닌 text/html이기 때문에 MappingJackson2HttpMessageConverter 또한 실행되지 않고 결국에는 에러가 발생하게 됩니다.

(호출될 메시지 컨버터가 없기 때문이다.)

 

 

메시지 컨버터의 과정을 정리하면 다음과 같다고 할 수 있습니다.

 

HTTP 요청 데이터 읽기

1. HTTP 요청이 오고, 컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한다.
2. 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 루프를 돌며 다양한 HTTP 메시지 컨버터의 canRead()를 호출한다.
3. 대상 클래스 타입을 지원하는지 체크한다.
   • 예) @RequestBody의 대상 클래스 (byte [], String, HelloData(Object)
4. HTTP 요청의 Content-Type 미디어 타입을 지원하는지 체크한다.
   • 예) text/plain, application/json, */*
5. canRead() 조건을 만족하면 read()를 호출해서 객체를 생성하고 반환한다.

 

HTTP 응답 데이터 생성

1. 컨트롤러에서 @ResponseBody, HttpEntity로 값이 반환된다.
2. 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 루프를 돌며 다양한 HTTP 메시지 컨버터의 canWrite()를 호출한다.
3. 대상 클래스 타입을 지원하는지 체크한다.
   • 예) return의 대상 클래스 (byte [], String, HelloData(Object)
4. HTTP 요청의 Accept 미디어 타입을 지원하는지 체크한다. (정확히는 @RequestMapping의 produces)
   • 예) text/plain, application/json, */*
5. canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

 

---

 

RequestMappingHandlerAdapter

이제 여기까지 공부를 했으면, HTTP 메시지 컨버터가 어떠한 과정을 걸치면서 반환타입을 변환하는지 알게 되었을 것이다. 그렇다면 스프링 MVC 구조에서 HTTP 메시지 컨버터는 언제 동작하는 것인지 궁금증이 들것이다

 

아까 위에서 스프링 MVC 구조에서 4번 과정을 기억하는가?

 

아래 그림은 핸들러 어댑터에서 핸들러(컨트롤러)를 호출하는 과정을 좀 더 세부화한 그림이다.

 

핸들러 어댑터가 컨트롤러를 호출하기 전에 ArgumentResolver 를 호출하고 컨트롤러에서 핸들러 어댑터로 반환하기 전에 ReturnValueHandler 가 호출되는 것을 볼 수 있다.

 

 

ArgumentResolver

스프링을 공부하면서 컨트롤러의 요청 파라미터로 어떤 타입들이 올 수 있는지 다시 생각을 해보면 매우 다양한 파라미터를 사용할 수 있었다. HttpServletRequest, Model, @RequestParam, @ModelAttribute 같은 어노테이션들과 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 가지고 있는 것을 알 수 있습니다.

 

이렇게 유연함을 가질 수 있는 이유가 바로 ArgumentResolver 덕분이다.

 

 

어노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter(핸들러 어댑터)는 바로 이 ArgumentResolver를 호출해서 핸들러(컨트롤러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성합니다.

 

그리고 이렇게 파라미터 값이 모두 준비되면 핸들러(컨트롤러)를 호출하면서 값을 넘겨주게 된다.

 

스프링은 30개가 넘는 ArgumentResolver 를 기본으로 제공합니다.

 

명칭은 HandlerMethodArgumentResolver 이지만 줄여서 ArgumentResolver 로 부릅니다.

 

 

HandlerMethodArgumentResolver 인터페이스

 

ArgumentResolver 동작 순서는 다음과 같습니다.

1. supportParameter() 메서드를 호출하여 해당 파라미터를 지원하는지 체크합니다.
2. 지원한다면 resolverArgument() 메서드를 호출해서 실제 객체를 생성합니다. 그리고 이렇게 생성된 객체가 컨트롤러 호출 시 넘어가는 것입니다.

 

ReturnValueHandler

요청 시에 ArgumentResolver 를 사용한다면, 응답 시에는 ReturnValueHandler 가 사용됩니다.

(HandlerMethodReturnValueHandler를 줄여서 ReturnValueHandler 라고 부릅니다.)

 

동작 순서는 ArgumentResolver 와 동일하기 때문에 생략하도록 하겠습니다.

 

컨트롤러에서 String으로 뷰 이름을 반환해도 동작하는 이유가 바로 ReturnValueHandler 덕분입니다.

 

스프링은 위 사진과 같이 10개가 넘는 ReturnValueHandler를 지원합니다.

• 예) ModelAndView, @ResponseBody, HttpEntity, String

 

HTTP 메시지 컨버터 위치

요청의 경우

• @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity를 처리하는 ArgumentResolver 가 있습니다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용하여 필요한 객체를 생성하는 것입니다.

응답의 경우

• @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있습니다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만듭니다.

 

추가로 스프링은 확장 기능들을 제공하는데, 위에서 배운 HandlerMethodArgumentResolver 인터페이스를 구현하여 기능을 확장할 수는 있지만 스프링이 필요한 대부분의 기능을 제공하기 때문에 실제로 기능을 확장할 일은 많지 않다고 합니다.

 

만약, 기능 확장이 필요하다면 'WebMvcConfigurer' 를 상속받아 스프링 빈으로 등록하면 됩니다.

 

---

 

참고(출처)

https://velog.io/@woo00oo/HTTP-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%BB%A8%EB%B2%84%ED%84%B0#argumentresolver

인프런 김영한님의 스프링 MVC 1편 강좌