HTTP 메시지 컨버터

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


1. @ResponseBody 사용 원리

@ResponseBody 사용 원리

· HTTP 메시지 바디에 문자 내용 직접 반환
· ViewResolver 대신 HttpMessageConverter 동작
기본 문자 처리 : StringHttpMessageConverter
기본 객체 처리 : MappingJackson2HttpMessageConverter
byte 처리 등, 기타 여러가지 HttpMessageConverter 가 기본으로 등록되어 있음

* 참고
응답의 경우 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보를 조합해서 HttpMessageConverter 가 선택된다.


2. 스프링 MVC의 HTTP 메시지 컨버터 적용
· HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)
· HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)


3. HTTP 메시지 컨버터 인터페이스
- org.springframework.http.converter.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, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

}

HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용됨
· canRead(), canWrite() : HTTP 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크
· read(), write() : HTTP 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능


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

1) 0순위. ByteArrayHttpMessageConverter : byte[] 데이터를 처리
클래스 타입 : byte[]
미디어 타입(Content-Type) : */*
요청 예시 : @RequestBody byte[] data
응답 예시 : @ResponseBody return byte[]
쓰기 미디어 타입(Accept 또는 응답시 Content-Type) : application/octet-stream

2) 1순위. StringHttpMessageConverter : String 문자로 데이터를 처리
클래스 타입 : String
미디어 타입(Content-Type) : */*
요청 예시 : @RequestBody String data
응답 예시 : @ResponseBody return "ok"
쓰기 미디어 타입(Accept 또는 응답시 Content-Type) : text/plain

ex) StringHttpMessageConverter 동작 예시
content-type: application/json

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

3) 2순위. MappingJackson2HttpMessageConverter : JSON 문자열로 데이터를 처리
클래스 타입 : 객체 또는 HashMap
미디어 타입(Content-Type) : application/json 관련
요청 예시 : @RequestBody 객체 data
응답 예시 : @ResponseBody return 객체
쓰기 미디어 타입(Accept 또는 응답시 Content-Type) : application/json 관련

ex) MappingJackson2HttpMessageConverter 동작 예시
content-type: application/json

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

ex) 안되는 케이스
content-type: text/html

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


5. HTTP 요청 데이터 읽기
1) @RequestBody, HttpEntity 파라미터 사용하는 컨트롤러에 HTTP 요청이 옴
2) HTTP 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 호출
-> 대상 클래스 타입을 지원하는가?
ex) @RequestBody 대상 클래스 : byte[], String, 객체
-> HTTP 요청의 Content-Type의 미디어 타입을 지원하는가?
ex) text/plain, application/json, */*
3) canRead() 조건 만족시, read() 호출하여 객체를 생성하고 반환함(컨트롤러에 파라미터로 넘겨줌)


6. HTTP 응답 데이터 생성
1) 컨트롤러에서 @ResponseBody, HttpEntity 로 값이 반환됨
2) HTTP 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 호출
-> 대상 클래스 타입을 지원하는가?
ex) return 대상 클래스 : byte[], String, 객체
-> HTTP 요청의 Accept의 미디어 타입을 지원하는가? (더 정확히는 @RequestMapping 의 produces)
ex) text/plain, application/json, */*
3) canWrite() 조건 만족시, write() 호출하여 HTTP 응답 메시지 바디에 데이터 생성함


참고링크 : https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1?cid=326674

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