HTTP 메시지 컨버터(HttpMessageConverter)(feat. Argumentresolver, ReturnValueHandler)
HTTP 메시지 컨버터(HttpMessageConverter)
뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.
스프링 MVC는 다음의 경우에 자동으로 HTTP 메시지 컨버터를 적용한다.
HTTP 요청 : @ReqeustBody, HttpEntity(RequestEntity)
HTTP 응답 : @RequestBody, HttpEntity(ResponseEntity)
요청의 경우 @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.
응답의 경우 @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.
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;
}canRead()와 canWrite()는 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크한다.
read()와 write()는 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능이다.
그리고 해당 인터페이스를 구현한 여러 컨버터가 있는데 몇가지 주요한 구현체들만 알아보도록 하자.
스프링 부트 기본 메시지 컨버터
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter낮은순으로 우선순위가 높다.
대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.
ByteArrayHttpMessageConverter
byte[] 타입의 데이터를 처리한다.
클래스 타입 : byte[], 미디어 타입(콘텐츠 타입(content type) : */*
요청 예) @RequestBody byte[] data
응답 예) @ResponseBody return byte[], 쓰기 미디어타입 : application/octet-stream
StringHttpMessageConverter
String 문자로 데이터를 처리한다
클래스 타입 : String, 미디어 타입(콘텐츠 타입(content type) : */*
요청 예) @RequestBody String data
응답 예) @ResponseBody return "ok", 쓰기 미디어타입 : test/plain
MappingJackson2HttpMessageConverter
application/json을 처리한다.
클래스 타입 : 객체 또는 HashMap, 미디어 타입 : application/json
요청 예) @RequestBody HelloData data
응답 예) @ResponseBody return helloData, 쓰기 미디어타입 : application/json
예를들면,
StringHttpMessageConverter
content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}
//String 타입 스트링 값 data 담김
MappingJackson2HttpMessageConverter
content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}
//객체 타입 data에 MappingJackson2HttpMessageConverter 로 인해 json 변환해서 담김
?
content-type: text/html
@RequestMapping
void hello(@RequetsBody HelloData data) {}
//객체타입 확인후 미디어타입 이맞지않아서 오류 발생HTTP 메시지 컨버터(HttpMessageConverter) 동작 방식
HTTP 요청 데이터 읽기
HTTP 요청이 오고, 컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용한다.
메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.
대상 클래스 타입을 지원하는가.
예) @RequestBody의 대상 클래스 : byte[], String, HelloData
HTTP 요청의 Content-Type 미디어 타입을 지원하는가
예) test/plain, application/json, */*
canRead()조건을 만족하면 read()를 호출해서 객체를 생성하고 반환한다.
HTTP 응답 데이터 생성
컨트롤러에서 @ResponseBody, HttpEntity로 값이 반환된다.
메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다
대상 클래스 타입을 지원하는가
예) return의 대상 클래스 (byte[], String, HelloData)
HTTP 요청의 Accept 미디어 타입을 지원하는가 (더 정확히는 @RequestMapping의 produce)
예) test/plain, application/json, */*
canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 바디에 메시지를 생성한다.
HTTP 메시지 컨버터는 어디서 사용되나?
RequestMappingHandlerAdapter(@RequestMapping을 처리)에서 사용된다.
RequestMappingHandlerAdapter는 컨트롤러를 호출하기 전에 ArgumentResolver를 사용해서 들어온 요청 정보를 컨트롤러가 필요로 하는 데이터 형식으로 변환해준다.
그리고 응답 데이터를 전송할 때는 ReturnValueHandler를 사용해서 컨트롤러가 반환한 데이터를 변환시켜서 반환해준다.
이 과정 속에서 ArgumentResolver 와 ReturnValueHandler가 데이터를 변환할 때 사용하는 것이 바로 메세지 컨버터이다
정리하자면,
요청이 들어온다
해당 요청에 해당하는 핸들러를 HandlerMapping을 통해 찾아온다.
해당 핸들러를 실행할 수 있는 HandlerAdapter를 찾아온다.
해당 HandlerAdapter를 실행한다.
이때 실행된 HandlerAdapter가 ReqeustMappingHandlerAdapter라면 컨트롤러를 호출하기 전 ArgumentResolver를 호출하여 요청 데이터를 컨트롤러가 필요로 하는 데이터로 변환한다.
ArgumentResolver는 호출되면 메시지 컨버터를 사용해서 컨트롤러가 필요로 하는 데이터로 변환시킨 후 값을 반환한다.
변환된 데이터를 컨트롤러에 전달한다.
컨트롤러에서 로직을 수행 후 값을 반환한다.
반환된 값은 ReturnValueResolver에서 메시지 컨버터를 사용하여 응답 결과를 만들어 반환한다.
ArgumentResolver
애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다.
HttpServletRequest, Model, @RequestParam, @ModelAttribute, @RequestBody, HttpEntity 등등..
이와 같은 것을 가능하게 해주는 것이 바로 ArgumentResolver이다. (정확히는 HandlerMethodArgumentResolver이나 줄여서 ArgumnetResolver라고 부른다)
애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter는 바로 이 ArgumnetResolver를 호출하여 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 이렇게 파라미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
스프링은 30개가 넘는 ArgumnetResolver를 제공한다.
정확히는 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 동작 방식
ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고,
지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.
그리고 원한다면 여러분이 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver 를 만들 수도 있다.
ReturnValueHandler
HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다.
ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.
컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.
스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
예) @ModelAndView , @ResponseBody , HttpEntity , String
