49. HTTP 메시지 컨버터

뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라, HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서

직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

 

@ResponseBody를 사용

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

 - viewResolver 대신에 HttpMessageConverter가 동작

 - 기본 문자처리 : StringHttpMessageConverter

 - 기본 객체처리 : MappingJackson2HttpMessageConverter

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

 

응답의 경우 클라이언트의 HTTP Accept헤더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서

HttpMessageConverter가 선택된다. 

 

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

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

HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)

/*
 * Copyright 2002-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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;

/**
 * Strategy interface for converting from and to HTTP requests and responses.
 *
 * @author Arjen Poutsma
 * @author Juergen Hoeller
 * @author Rossen Stoyanchev
 * @since 3.0
 * @param <T> the converted object type
 */
public interface HttpMessageConverter<T> {

	/**
	 * Indicates whether the given class can be read by this converter.
	 * @param clazz the class to test for readability
	 * @param mediaType the media type to read (can be {@code null} if not specified);
	 * typically the value of a {@code Content-Type} header.
	 * @return {@code true} if readable; {@code false} otherwise
	 */
	boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

	/**
	 * Indicates whether the given class can be written by this converter.
	 * @param clazz the class to test for writability
	 * @param mediaType the media type to write (can be {@code null} if not specified);
	 * typically the value of an {@code Accept} header.
	 * @return {@code true} if writable; {@code false} otherwise
	 */
	boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

	/**
	 * Return the list of media types supported by this converter. The list may
	 * not apply to every possible target element type and calls to this method
	 * should typically be guarded via {@link #canWrite(Class, MediaType)
	 * canWrite(clazz, null}. The list may also exclude MIME types supported
	 * only for a specific class. Alternatively, use
	 * {@link #getSupportedMediaTypes(Class)} for a more precise list.
	 * @return the list of supported media types
	 */
	List<MediaType> getSupportedMediaTypes();

	/**
	 * Return the list of media types supported by this converter for the given
	 * class. The list may differ from {@link #getSupportedMediaTypes()} if the
	 * converter does not support the given Class or if it supports it only for
	 * a subset of media types.
	 * @param clazz the type of class to check
	 * @return the list of media types supported for the given class
	 * @since 5.3.4
	 */
	default List<MediaType> getSupportedMediaTypes(Class<?> clazz) {
		return (canRead(clazz, null) || canWrite(clazz, null) ?
				getSupportedMediaTypes() : Collections.emptyList());
	}

	/**
	 * Read an object of the given type from the given input message, and returns it.
	 * @param clazz the type of object to return. This type must have previously been passed to the
	 * {@link #canRead canRead} method of this interface, which must have returned {@code true}.
	 * @param inputMessage the HTTP input message to read from
	 * @return the converted object
	 * @throws IOException in case of I/O errors
	 * @throws HttpMessageNotReadableException in case of conversion errors
	 */
	T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
			throws IOException, HttpMessageNotReadableException;

	/**
	 * Write an given object to the given output message.
	 * @param t the object to write to the output message. The type of this object must have previously been
	 * passed to the {@link #canWrite canWrite} method of this interface, which must have returned {@code true}.
	 * @param contentType the content type to use when writing. May be {@code null} to indicate that the
	 * default content type of the converter must be used. If not {@code null}, this media type must have
	 * previously been passed to the {@link #canWrite canWrite} method of this interface, which must have
	 * returned {@code true}.
	 * @param outputMessage the message to write to
	 * @throws IOException in case of I/O errors
	 * @throws HttpMessageNotWritableException in case of conversion errors
	 */
	void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
			throws IOException, HttpMessageNotWritableException;

}

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

HTTP 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.

canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크

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

 

HTTP 요청 데이터 읽기

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

메시지 컨버터가 메시지를 읽을 수 있는지 확인하는 canRead() 호출

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

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

조건을 만족하면 read() 호출하여 객체 생성후 반환함

 

HTTP 응답 데이터 생성

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

메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 write() 호출

 - 대상 클래스 타입을 지원하는가? (return의 대상 클래스)

 - HTTP요청의 Accept 미디어 타입을 지원하는가?(text/palin, application/json, */*)

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