HTTP 메시지 컨버터

HyeonWoo·2021년 6월 22일
스프링스프링MVC
0

스프링 & JPA

목록 보기
34/34
post-thumbnail

컨트롤러에서 @RequestBody 어노테이션을 사용하면 JSON -> 자바객체로 반환해주고, 다시 @ResponseBody를 사용해서 자바객체 -> JSON으로 간편하게 반환할 수 있다.
이러한 편리한 기능은 어떤 방식의 동작으로 이루어질까?
김영한님의 스프링 MVC를 강의를 들으면서 해당 궁금증을 해결 할 수 있었다.
이번 포스트에서는 강의 자료를 바탕으로 HTTP 메시지 컨버터 그리고 스프링 MVC 패턴의 세부적인 내용을 정리하고자 한다.

스프링 MVC

스프링 MVC는 아래 사진과 같이 동작하게 된다.
컨트롤러에서 비즈니스 로직을 수행한 후, 뷰 템플릿으로 HTML을 생성해서 응답을 하게 되면 viewResolver가 해당 View를 찾아서 반환하게 된다.
하지만 HTTP API(Rest)처럼 JSON 데이터를 HTTP 바디에 직접 읽거나 쓰는 경우에는 어떤 원리로 JSON <-> 자바 객체로 변환 되는 것일까?

@ReseponseBody 사용 원리

HTTP API는 아래 사진처럼 작동한다.

HTTP 메시지 컨버터! 이 인터페이스를 사용해서 JSON, String, Byte 타입으로 편리하게 반환할 수 있는 것이다.

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

다음 코드는 스프링프레임워크의 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, HttpOutputMessag outputMessage) throws IOException, HttpMessageNotWritableException;
              
}

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

  • canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크한다.

  • read(), write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

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

  0 = ByteArrayHttpMessageConverter
  1 = StringHttpMessageConverter
  2 = MappingJackson2HttpMessageConverter

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

위의 3가지 메시지 컨버터를 살펴보면,

ByteArrayHttpMessageConverter

  • byte[] 데이터를 처리.

  • 클래스 타입 : byte[], 미디어타입 : */*

  • 요청 예)@RequestBody byte[] data

  • 응답 예)ReseponseBody return byte[] 쓰기 미디어타입 application/octet-stream

StringHttpMessageConverter

  • String 문자로 데이터를 처리한다.

  • 클래스 타입 : String, 미디어타입 : */*

  • 요청 예)@RequestBody String data

  • 응답 예)ReseponseBody return "ok" 쓰기 미디어타입 text/plain

MappingJackson2HttpMessageConverter

  • application/json

  • 클래스 타입 : 객체 또는 HashMap, 미디어타입 : application/json 관련

  • 요청 예)@RequestBody Object data

  • 응답 예)ReseponseBody return data 쓰기 미디어타입 application/json 관련

이제 다음 예시를 보면 어떤 HTTP 메시지 컨버터 사용되는지 알 수 있을 것이다.

content-type: application/json

 @RequestMapping
 void hello(@RequetsBody String data) {}
 
 //StringHttpMessageConverter 호출


content-type: application/json

@RequestMapping
void hello(@RequetsBody HelloData data) {}

//MappingJackson2HttpMessageConverter 호출

content-type: text/html

@RequestMapping
void hello(@RequetsBody HelloData data) {}

//호출 가능한 http 메시지 컨버터 없음! ERROR

그러면 스프링은 상황에 따라 어떤 HTTP 메시지 컨버터를 사용해야하는지 어떻게 알 수 있을까?

HTTP 요청 데이터 읽기

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

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

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

  4. HTTP 요청의 Content-Type 미디어 타입을 지원하는가. 예) text/plain , application/json , */*

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

HTTP 응답 데이터 생성

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

  2. 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 루프를 돌며 다양한 HTTP 메시지 컨버터의 canWrite() 를 호출한다.

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

  4. HTTP 요청의 Accept 미디어 타입을 지원하는가.(더 정확히는 @RequestMapping 의 produces ) 예) text/plain , application/json , */*

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

이제 HTTP 메시지 컨버터가 어떤 과정을 걸치면서 반환타입이 변환 되는지 알 게 되었다.
그러면! 스프링 MVC 구조에서 언제?!! HTTP 메시지 컨버터가 동작할까?
컨트롤러 파라미터 요청이 들어올때, 즉 핸들러 어댑터가 해당 컨트롤러를 호출할때 작동할 거 같지 않은가??

RequestMappingHandlerAdapter(@RequestMapping)

스프링 MVC 동작과정에서 핸들러 어댑터 <-> 컨트롤러 과정을 조금 더 세부화 하자면 아래 그림처럼 된다.

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

ArgumentResolver

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

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

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

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

정확히는 HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver로 부른다


public interface HandlerMethodArgumentResolver {

      boolean supportsParameter(MethodParameter parameter);
      
      @Nullable
      Object resolveArgument(MethodParameter parameter, @NullableModelAndViewContainer mavContainer,
              NativeWebRequest webRequest, @Nullable WebDataBinderFactorybinderFactory) throws Exception;
              
}

다음 코드를 보면, ArgumentResolver가 어떻게 동작하는지 알 수 있다.

  1. supportsParameter()를 호출해서 해당 파라미터를 지원하는지 체크한다.

  2. 지원하면 resolveArgument()를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출 시 넘어가는 것이다.

그리고 원한다면 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver를 만들 수 있다.

ReturnValueHandler

  • 요청시에 ArgumentResolver를 사용한다면 응답시에는 ReturnValueHandler가 사용된다.

  • HandlerMethodReturnValueHandler를 줄여서 ReturnValueHandler라 부른다.

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

  • 스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
    예) ModelAndView , @ResponseBody , HttpEntity , String

HTTP 메시지 컨버터 위치

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

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

스프링 MVC는

@RequestBody @ResponseBody 가 있으면
RequestResponseBodyMethodProcessor (ArgumentResolver)

HttpEntity 가 있으면 HttpEntityMethodProcessor (ArgumentResolver)를 사용한다.

확장

스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.

  • HandlerMethodArgumentResolver

  • HandlerMethodReturnValueHandler

  • HttpMessageConverter

스프링이 필요한 대부분의 기능을 제공하기 때문에 실제 기능을 확장할 일이 많지는 않다. 기능 확장은 WebMvcConfigurer 를 상속 받아서 스프링 빈으로 등록하면 된다

@Bean
public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
        
         @Override
         public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
			//...
         }
 	 @Override
         public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
			//...
         } 
    };
}

참고자료

김영한님의 스프링 MVC-1

profile
HyeonWoo
학습 정리, 자기 개발을 위한 블로그
이전 포스트

빈 자동, 수동 주입

0개의 댓글