[Spring MVC] 16. HTTP 메시지 컨버터

해당 글은 김영한님의 스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의를 수강하고 정리한 게시글입니다.

스프링 MVC - HTTP 메시지 컨버터

뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

 

HTTP 메시지 컨버터를 설명하기 전에 스프링 입문편 내용을 살펴보자.

 

[@ResponseBody 사용 원리]

@ResponseBody를 사용하면

• HTTP의 Body에 문자 내용을 직접 반환
• viewResolver 대신에 HttpMessageConverter가 동작
• 기본 문자처리 : StringHttpMessageConverter
• 기본 객체처리 : MappingJackson2HttpMessageConverter
• byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

 

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

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

 

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

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[]로 바꿔주는 거)

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

StringHttpMessageConverter: String 문자로 데이터를 처리한다.(String으로 바꿔주는거)

• 클래스 타입 : String, 미디어 타입 : /
• 요청 예) @RequestBody String data
• 응답 예) @ResponseBody return “ok” , 쓰기 미디어 타입 : text/plain

MappingJackson2HttpMessageConverter: application/json(객체를 json으로 바꿔주거나 json으로 온걸 객체로 바꿔주는거)

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

 

[HTTP 요청 데이터 읽기 순서]

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

 

[HTTP 응답 데이터 쓰기 순서]

• 컨트롤러에서 @ResponseBody, HttpEntity로 값이 반환된다.
• 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.
  • 대상 클래스 타입을 지원하는가 확인
  • HTTP 요청의 Accept 미디어 타입을 지원하는가 확인
• canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.

요청 매핑 핸들러 어댑터 구조

HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 걸까?

 

[SpringMVC 구조]

위의 그림에서는 보이지 않는다.
모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping 을 처리하는 핸들러 어댑터인RequestMappingHandlerAdapter (요청 매핑 핸들러 어댑터)에 있다.

 

[RequestMappingHandlerAdapter 동작 방식]

생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
HttpServletRequest, Model은 물론이고, @RequestParam, @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.

 

이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver덕분이다.

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor는 바로 이 ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

 

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

참고: 가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
Web on Servlet Stack

 

정확히는 HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver 라고 부른다.

public interface HandlerMethodArgumentResolver { 
      boolean supportsParameter(MethodParameter parameter);
@Nullable 
      Object resolveArgument(MethodParameter parameter, @Nullable
    ModelAndViewContainer mavContainer,
              NativeWebRequest webRequest, @Nullable WebDataBinderFactory
    binderFactory) throws Exception;
}

 

[동작 방식]
ArgumentResolver의supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument()를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

 

ReturnValueHandler
HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다. ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.

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

 

[HTTP 메시지 컨버터 위치]

HTTP 메시지 컨버터의 위치는 위와 같다. (HTTP 메시지 컨버터를 사용하는 컨트롤러에 쓰이기 때문에)

• @RequestBody도 컨트롤러가 필요로하는 파라미터의 값에 사용된다.
• @ResponseBody의 경우도 컨트롤러의 반환 값을 이용한다.

 

요청의 경우 @RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity 를 처리하는 ArgumentResolver가 있다.
이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

 

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

 

스프링 MVC는 @RequestBody @ResponseBody가 있으면RequestResponseBodyMethodProcessor(ArgumentResolver)
HttpEntity가 있으면 HttpEntityMethodProcessor(ArgumentResolver)를 사용한다.