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

HTTP 메시지 컨버터

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


@ResponseBody 사용 원리
1) HTTP의 BODY에 문자 내용을 직접 반환
2)`viewResolver` 대신에 `HttpMessageConverter` 가 동작
3) 기본 문자처리: `StringHttpMessageConverter`
4) 기본 객체처리: `MappingJackson2HttpMessageConverter`
5) byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

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


Spring MVC에서 HTTP 메시지 컨버터는 다음과 같은 경우에 적용된다

1)HTTP 요청

@RequestBody : 클라이언트가 보낸 JSON, XML 등의 데이터를 Java 객체로 변환한다.

@PostMapping("/create")
public ResponseEntity<User> createUser(@RequestBody User user) {
    return new ResponseEntity<>(user, HttpStatus.CREATED);
}​

HttpEntity<RequestEntity> : 요청 본문과 헤더 정보를 Java 객체로 받는다.

@PostMapping("/create")
public ResponseEntity<User> createUser(RequestEntity<User> requestEntity) {
    User user = requestEntity.getBody();
    return new ResponseEntity<>(user, HttpStatus.CREATED);
}​

2)HTTP 응답

@ResponseBody : Java 객체를 JSON, XML 등으로 변환하여 응답 본문으로 보낸다.

@GetMapping("/user")
public @ResponseBody User getUser() {
    return new User("John", 30);
}​

HttpEntity<ResponseEntity> : 응답 본문과 헤더 정보를 설정하여 보낸다.

@GetMapping("/user")
public ResponseEntity<User> getUser() {
    User user = new User("John", 30);
    return new ResponseEntity<>(user, HttpStatus.OK);
}​

 이렇게 HTTP 메시지 컨버터는 Spring MVC에서 요청과 응답 데이터를 적절한 형식으로 변환하여 처리한다.

 

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()` : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크
-`read()` , `write()` : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

 

스프링 부트 기본 메시지 컨버터

 0 = ByteArrayHttpMessageConverter
 1 = StringHttpMessageConverter
 2 = MappingJackson2HttpMessageConverter

 

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

주요 메시지 컨버터
1) ByteArrayHttpMessageConverter` : `byte[]` 데이터를 처리한다.

- 클래스 타입: `byte[]` , 미디어타입: `*/*` 

    요청 예) `@RequestBody byte[] data`
    응답 예) `@ResponseBody return byte[]` 쓰기 미디어타입 `application/octet-stream`

2) StringHttpMessageConverter` : `String` 문자로 데이터를 처리한다.
- 클래스 타입: `String` , 미디어타입: `*/*`

   요청 예) `@RequestBody String data`

   응답 예) `@ResponseBody return "ok"` 쓰기 미디어타입 `text/plain`

3) 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) {}

 

content-type이 text/html로 설정되어 있을 때, @RequestBody를 사용해 JSON이나 XML 데이터를 Java 객체로 변환하려고 하면 HTTP 메시지 컨버터가 이를 처리할 수 없다. HTTP 메시지 컨버터는 요청 본문의 Content-Type 헤더를 확인하고, 그에 맞는 컨버터를 사용하기 때문이다.



HTTP 요청 데이터 읽기

HTTP 요청이 오고, 컨트롤러에서 `@RequestBody`나 `HttpEntity` 파라미터를 사용하면 메시지 컨버터가 메시지를 읽을 수 있는지 확인한다. 이를 위해 `canRead()`를 호출한다.

1. 대상 클래스 타입을 지원하는가
   - 예) `@RequestBody`의 대상 클래스 (`byte[]`, `String`, `HelloData`)

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

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

@RequestMapping(value = "/hello", method = RequestMethod.POST, consumes = "application/json")
public void hello(@RequestBody HelloData data) {
    // data 객체는 JSON 요청 본문으로부터 변환됨
}

HTTP 응답 데이터 생성

컨트롤러에서 `@ResponseBody` 또는 `HttpEntity`로 값을 반환할 때 메시지 컨버터가 메시지를 쓸 수 있는지 확인한다. 이를 위해 `canWrite()`를 호출한다.

1. 대상 클래스 타입을 지원하는가
 - 예) 반환 대상 클래스 (`byte[]`, `String`, `HelloData`)

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

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

@GetMapping(value = "/user", produces = "application/json")
public @ResponseBody User getUser() {
    return new User("John", 30);
}