[MVC] HttpMessageConverter (+ HandlerMethodArgumentResolver, HandlerMethodReturnValueHandler)

 

 

 

 

🧐 HttpMessageConverter

@RequestBody나 @ResponseBody는 메시지 바디에 들어있거나 메세지 바디에 작성되는 문자 혹은 JSON 등의 데이터를 String 또는 객체로 바로 변환하여 사용할 수 있게 해줍니다.

 

이와 같이 HTTP 메시지 바디의 내용을 개발자가 사용하게 편리하도록 변환하여 주는 역할을 HttpMessageConverter가 담당합니다.

 

HttpMessageConverter는 @RequestBody, HttpEntity가 파라미터에 붙어있는 경우, 그리고 반환 시 @ResponseBody 혹은 HttpEntity를 사용하는 경우 작동합니다.

 

 

 

 

 

 

 

 

 

🧐 HttpMessageConverter 구조

HTTP 메시지 컨버터는 인터페이스로 이루어져 있습니다.

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;

}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 스프링 부트에서 등록하는 기본 메시지 컨버터

이것들보다 더 많은 메시지 컨버터를 등록하지만, 대표적인 컨버터만 살펴보겠습니다.

 

 

 

📕 ByteArrayHttpMessageConverter

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

 

 

 

 

 

📙 StringHttpMessageConverter

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

 

 

 

 

 

📗 MappingJackson2HttpMessageConverter

• application/json을 처리합니다.
• 클래스 타입 :  객체 또는 HashMap, 미디어 타입 : application/json
• 요청 예) @RequestBody HelloData data
• 응답 예) @ResponseBody return helloData, 쓰기 미디어타입 : application/json

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 동작 원리 살펴보기

 

📕 HTTP 요청 데이터 읽기

컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한 상태에서 HTTP 요청이 온 경우, 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출합니다.

 

다음 두 조건을 만족하는지 확인합니다.

• 대상 클래스 타입을 지원하는가.
  • 예) @RequestBody의 대상 클래스 : byte[], String, HelloData
• HTTP 요청의 Content-Type 미디어 타입을 지원하는가
  • 예) test/plain, application/json, */*

 

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

1. •  

 

 

 

 

 

📙 HTTP 응답 데이터 생성

@ResponseBody, HttpEntity로 컨트롤러에서 값을 반환하는 경우, 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출합니다.

 

다음 두 조건을 만족하는지 확인합니다.

• 대상 클래스 타입을 지원하는가
  • 예) return의 대상 클래스 (byte[], String, HelloData)
• HTTP 요청의 Accept 미디어 타입을 지원하는가 (더 정확히는 @RequestMapping의 produce)
  • 예) test/plain, application/json, */*

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

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 HttpMessageConverter 사용위치

이전 글들에서 살펴본 스프링 MVC의 구조를 다시 한번 확인해 보도록 하겠습니다.

(사진은 김영한 선생님의 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술의 자료에서 발췌하였습니다.)

 

HttpMessageConverter는 애노테이션 기반의 컨트롤러,

즉 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter에서 사용합니다.

 

 

그 전에 잠시 HandlerMethodArgumentResolver와 HandlerMethodReturnValueHandler에 대해 알아보도록 하겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 HandlerMethodArgumentResolver

애노테이션 기반의 컨트롤러는 매우 다양한 파라미터(HttpServletRequest, @RequestParam, @ModelAttribute, @RequestBody, HttpEntity 등등)를 사용할 수 있습니다.

 

(더 궁금하다면 다음 사이트를 참고해주세요)

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-annarguments

Web on Servlet Stack

 

이러한 것이 가능한 이유가 바로 HandlerMethodArgumentResolver덕분입니다.

 

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter는 컨트롤러를 호출하기 전에 ArgumentResolver를 사용해서 들어온 요청 정보를 컨트롤러가 필요로 하는 데이터 형식으로 변환해줍니다.

 

 

 

그림으로 살펴보겠습니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 HandlerMethodReturnValueHandler

응답 데이터를 전송할 때는 HandlerMethodReturnValueHandler를 사용해서 컨트롤러가 반환한 데이터를 변환시켜서 반환해줍니다.

 

(가능한 응답 값은 다음 공식 메뉴얼에서 확인할 수 있습니다.)

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

Web on Servlet Stack

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 HttpMessageConverter 사용위치

다시 HttpMessageConverter로 돌아와서,

결국 HttpMessageConverter는 HandlerMethodArgumentResolver와 HandlerMethodReturnValueHandler에서 사용됩니다.

 

HttpMessageConverter를 사용하는 @RequestBody 역시도 컨트롤러가 필요로 하는 파라미터에 사용됩니다.

@ResponseBody는 컨트롤러의 반환 값에서 사용됩니다.

 

 

즉 요청의 경우 @RequestBody를 처리하는 HandlerMethodArgumentResolver가 있으며, HttpEntity를 처리하는 HandlerMethodArgumentResolver가 있습니다.

해당 HandlerMethodArgumentResolver들에서 HttpMessageConverter를 사용해서 필요한 객체를 사용합니다.

 

 

하나의 예시는 다음과 같습니다.

AbstractMessageConverterMethodArgumentResolver.readWithMessageConverters()

 

ArgumentResolver, ReturnValueHandler들은 대부분의 경우 자신들이 직접 데이터를 변환하는 작업을 처리하지만, @RequestBody, @ResponseBody, HttpEntity를 사용하면 내부에서 HttpMessageConverter를 사용하여 변환합니다. 

스프링 MVC는 @RequestBody, @ResponseBody가 있으면 RequestResponseBodyMethodProcessor(HandlerMethodArgumentResolver),
HttpEntity가 있으면 HttpEntityMethodProcessor(HandlerMethodReturnValueHandler)를 사용합니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 기능 확장

스프링은 HandlerMethodArgumentResolver와 HandlerMethodReturnValueHandler, HttpMessageConverter를 모두 인터페이스로 제공하므로, 필요에 따라서 언제든지 기능을 확장할 수 있습니다.

 

 

 

기능을 확장하기 위해서는 WebConfigurer를 상속 받아서 스프링 빈으로 등록하면 됩니다.

(addArgumentResolvers, extendMessageConverters 등 가능)

public interface WebMvcConfigurer {


   default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
   }


   default void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> handlers) {
   }


   default void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
   }

}

 

 

 

 

 

 

 

 

 

 

 

 

📕 Reference

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의