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

HTTP 메시지 컨버터

• 뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.
• 스프링 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[], 미디어 타입 : */*
  • 요청 예) @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 관련

HTTP 요청 데이터 읽기

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

HTTP 응답 데이터 생성

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

StringHttpMessageConverter

content-type : application/json

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

• String이고, 미디어 타입이 application/json이므로 StringHttpMessageConverter가 동작한다.

MappingJackson2HttpMessageConverter

content-type: application/json

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

• 객체 타입이고 미디어 타입이 application/json 이므로 MappingJackson2HttpMessageConverter가 동작

X

content-type: text/html

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

• 객체 타입이지만 미디어 타입이 text/html이므로 동작가능한 메시지 컨버터가 없다.

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

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

• 스프링 MVC의 구조에서는 보이지 않는다.
• 모든 비밀은 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter에 있다.

RequestMappingHandlerAdapter 동작 방식

• ArgumentResolver
  • 생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
  • HttpServletRequest, Model은 물론이고, @RequestParam, @ModelAttribute 같은 애노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
  • 이렇게 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.
  • 애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter는 바로 이 ArgumentResolver를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.

ArgumentResolver(정확히는 HandlerMethodArgumentResolver)

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를 줄여서 ReturnValueHandler라 부른다.
• ArgumentResolver와 비슷한데, 이것은 응답 값을 변환하고 처리한다.
• 컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.

HTTP 메시지 컨버터 위치

• HTTP 메시지 컨버터를 사용하는 @RequestBody도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다.
• @ResponseBody의 경우도 컨트롤러의 반환 값을 이용한다.
• 요청의 경우
  • @RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있다.
  • 이 ArgumentResolver들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.
• 응답의 경우
  • @ResponseBody와 HttpEntity를 처리한느 ReturnValueHandler가 있다.
  • 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
• 스프링 MVC는 @RequestBody, @ResponseBody가 있으면 RequestResponseBodyMethodProcessor를
• HttpEntity가 있으면 HttpEntityMethodProcessor를 사용한다.

 

 

 

---

 

출처

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1

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