HTTP 메시지 컨버터

HTTP 메시지 컨버터

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

@ResponseBody 사용 원리

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

cf) 참고

• 응답의 경우 클라이언트의 HTTP Accpet 헤더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter가 선택된다.

Spring 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[], 미디어타입 : /
  • 요청 ex) @RequestBody byte[] data
  • 응답 ex) @ResponseBody return byte[], 쓰기 미디어 타입 : application/octet-stream

• StringHttpMessageConverter : String 문자로 데이터를 처리한다.
  • 클래스 타입: String, 미디어타입 : /
  • 요청 ex) @RequestBody String data
  • 응답 ex) @ResponseBody return "OK", 쓰기 미디어 타입 : text/plain

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

HTTP 요청 데이터 읽기

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

HTTP 응답 데이터 생성

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

예제

StringHttpMessageConveter

Content-Type : application/json

@GetMapping
public void hello(@RequestBody String data {} 

1. ByteArrayHttpMessageConverter가 먼저 체크하는데 @RequestBody의 클래스가 byte[]가 아니므로 그 다음으로 넘어가게된다.
2. StringHttpMessageConveter가 체크하는데 @RequestBody의 클래스가 String은 맞고 미디어타입도 /의 조건에 맞족하기 때문에 메시지 컨버팅이 일어난다.

MappingJackson2HttpMessageConverter

Content-Type : application/json

@GetMapping
public void hello(@RequestBody HelloData helloData) {} 

MessageConverting이 안될 때

Content-Type : text/html

@GetMapping
public void hello(@RequestBody HelloData helloData) {}