[스프링 MVC] HTTP 메세지 컨버터

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

 

HTTP 메세지 컨버터에 대해 알아보기 전에 잠깐 과거로 돌아가서 스프링 입문 강의에서 배웠던 내용을 살펴보자.

 

@ResponseBody 사용

- HTTP의 BODY에 문자 내용을 직접 반환

- viewResolver 대신에 HttpMessageConverter가 동작

- 기본 문자처리 : StringHttpMessageConverter

- 기본 객체처리 : MappingJackson2HttpMessageConverter

- byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

 

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

 

이제 다시 돌아와서,

 

스프링 MVC는 다음의 경우에 HTTP 메세지 컨버터를 적용한다.

- HTTP 요청 : @RequestBody, HttpEntity (RequestEntity)

- HTTP 응답 : @ResponseBody, HttpEntity (ResponseEntity)

 

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

org.springframework.http.converter.HttpMessageConverter

package org.springframework.http.converter;

import java.io.IOException;
import java.util.Collections;
import java.util.List;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.lang.Nullable;

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 !this.canRead(clazz, (MediaType)null) && !this.canWrite(clazz, (MediaType)null) ? Collections.emptyList() : this.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(), canWriter() : 메세지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크

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 관련

 

StringHttpMessageConverter

content-type: application/json

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

 

MappingJackson2HttpMessageConverter

content-type: application/json

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

 

?

content-type: text/html

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

 

HTTP 요청 데이터 읽기

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

- 메세지 컨버터가 메세지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.

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

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

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

 

HTTP 응답 데이터 생성

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

- 메세지 컨버터가 메세지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다.

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

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

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