Java Category/Spring

[Spring MVC] HTTP MessageConverter, RequestMapping HandlerAdapter

ReBugs 2024. 3. 19.

이 글은 인프런 김영한님의 Spring 강의를 바탕으로 개인적인 정리를 위해 작성한 글입니다.

HTTP MessageConverter

HTTP MessageConverter는 스프링 프레임워크에서 HTTP 요청 및 응답 본문을 객체로 변환하거나 객체를 HTTP 응답 본문으로 변환하는 역할을 하는 구성 요소이다. 클라이언트와 서버 간의 데이터 교환은 주로 JSON, XML 등의 형식으로 이루어지는데, MessageConverter는 이러한 데이터 형식을 애플리케이션 내부에서 사용하는 객체로 쉽게 변환해주거나, 반대로 객체를 이러한 데이터 형식으로 변환해주는 작업을 담당한다.

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

예를 들어, @ResponseBody 어노테이션을 사용할 때 메시지 컨버터가 어떻게 작동하는지 살펴보면,

@ResponseBody는 HTTP의 BODY에 내용을 직접 반환한다.

따라서 viewResolver 대신에 HttpMessageConverter 가 동작한다.

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

기본 문자처리: StringHttpMessageConverter
기본 객체처리: MappingJackson2HttpMessageConverter
byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

스프링 MVC는 다음의 경우에 HTTP 메시지 컨버터를 적용한다.
HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)

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;
}

canRead(Class<?> clazz, @Nullable MediaType mediaType): 주어진 클래스 타입과 미디어 타입에 대해 이 컨버터가 읽기를 지원하는지 여부를 반환한다. 즉, HTTP 요청 본문을 해당 타입의 객체로 변환할 수 있는지를 나타낸다.
canWrite(Class<?> clazz, @Nullable MediaType mediaType): 주어진 클래스 타입과 미디어 타입에 대해 이 컨버터가 쓰기를 지원하는지 여부를 반환한다. 즉, 해당 타입의 객체를 HTTP 응답 본문으로 변환할 수 있는지를 나타낸다.
getSupportedMediaTypes(): 이 컨버터가 지원하는 미디어 타입의 리스트를 반환한다. 예를 들어, JSON을 처리하는 컨버터는 application/json 미디어 타입을 지원한다.
read(Class<? extends T> clazz, HttpInputMessage inputMessage): HTTP 요청 본문을 읽어서 주어진 클래스 타입의 객체로 변환한다. 이 과정에서 변환에 실패하면 HttpMessageNotReadableException이 발생할 수 있다.
write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage): 주어진 객체를 HTTP 응답 본문으로 변환한다. 이 메서드는 객체를 지정된 미디어 타입의 데이터로 변환하여 HttpOutputMessage에 쓴다. 변환에 실패하면 HttpMessageNotWritableException이 발생할 수 있다.

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

canRead() , canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크
read() , write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

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

(일부 생략)

ByteArrayHttpMessageConverter
StringHttpMessageConverter
MappingJackson2HttpMessageConverter
...

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다.

만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.

ByteArrayHttpMessageConverter: byte[] 데이터를 처리

클래스 타입: byte[], 미디어타입: */*,
요청 예) @RequestBody byte[] data
응답 예) @ResponseBody return byte[]
쓰기 미디어타입: application/octet-stream

ByteArrayHttpMessageConverter는 byte[] 데이터를 처리하는 컨버터이다. 이 컨버터는 클래스 타입으로 byte[]를 사용하며, 모든 미디어 타입(*/*)에 대해 읽기와 쓰기를 지원한다. 요청 본문에서 바이트 배열을 받거나 바이트 배열을 응답 본문으로 반환할 때 사용할 수 있다. 쓰기 작업에 대해서는 주로 application/octet-stream 미디어 타입을 사용한다.

StringHttpMessageConverter: String 문자로 데이터를 처리

클래스 타입: String, 미디어타입: */*
요청 예) @RequestBody String data
응답 예) @ResponseBody return "ok"
쓰기 미디어입: text/plain

StringHttpMessageConverter는 문자열 데이터를 처리하는 컨버터이다. 클래스 타입은 String이며, 이 역시 모든 미디어 타입(*/*)에 대해 읽기와 쓰기를 지원한다. 문자열 데이터를 요청 본문에서 받거나 응답 본문으로 반환할 때 사용되며, 쓰기 작업에는 text/plain 미디어 타입이 주로 사용된다.

MappingJackson2HttpMessageConverter: application/json

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

MappingJackson2HttpMessageConverter는 application/json 미디어 타입 관련 데이터를 자바 객체나 HashMap으로 변환하거나, 반대로 자바 객체를 JSON 형태로 변환하는 작업을 담당한다. 이 컨버터는 주로 JSON 형식의 데이터를 처리할 때 사용되며, 클래스 타입은 객체 또는 HashMap이다. @RequestBody나 @ResponseBody 어노테이션과 함께 사용하여 JSON 데이터를 요청 본문에서 받거나 응답 본문으로 반환할 때 사용된다. 쓰기 작업에 대해서는 application/json 미디어 타입을 사용한다.

HTTP 요청 데이터 읽기

HTTP 요청 데이터를 읽는 과정은 스프링 프레임워크에서 @RequestBody나 HttpEntity 파라미터를 사용할 때 중요한 역할을 한다. 이 과정에서 메시지 컨버터는 들어오는 HTTP 요청의 본문을 애플리케이션에서 사용할 수 있는 객체로 변환하는 작업을 수행한다.

구체적인 단계는 다음과 같다

HTTP 요청 수신: 클라이언트로부터 HTTP 요청이 서버에 도달한다. 이 요청은 특정 Content-Type 미디어 타입을 포함하며, 데이터 본문(body)은 JSON, XML, 텍스트 등 다양한 형태일 수 있다.

컨트롤러 메서드 호출: 스프링 MVC는 요청 URL과 메서드 타입(GET, POST 등)을 기반으로 적절한 컨트롤러 메서드를 결정한다. 해당 메서드가 @RequestBody나 HttpEntity를 파라미터로 사용하는 경우, 메시지 컨버터를 통한 데이터 변환이 필요하다.

canRead() 메서드 호출: 스프링은 요청 본문을 읽고 변환하기 전에, 등록된 메시지 컨버터 중에서 요청 데이터를 처리할 수 있는 적절한 컨버터를 찾아야 한다. 이를 위해 각 메시지 컨버터의 canRead() 메서드를 호출한다. 이 메서드는 다음 두 가지 조건을 검사한다

대상 클래스 타입 지원 여부: 메서드 파라미터로 지정된 타입(byte[], String, HelloData 등)을 이 컨버터가 처리할 수 있는지 확인한다.
HTTP 요청의 Content-Type 미디어 타입 지원 여부: 요청의 Content-Type(예: text/plain, application/json, */* 등)이 이 컨버터가 지원하는 미디어 타입과 일치하는지 확인한다.

read() 메서드 호출: canRead() 검사를 통과한 컨버터가 발견되면, 스프링은 해당 컨버터의 read() 메서드를 호출하여 HTTP 요청 본문을 애플리케이션에서 사용할 수 있는 객체로 변환한다. 이 과정에서 컨버터는 요청 본문의 데이터를 파싱하고, 지정된 타입의 객체를 생성하여 반환한다.

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

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

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

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

HTTP 응답 데이터 생성

HTTP 응답 데이터 생성 과정은 스프링 MVC에서 컨트롤러가 클라이언트에 데이터를 반환할 때 중심적인 역할을 하는 메시지 컨버터를 통해 이루어진다.

이 과정은 클라이언트에게 보내는 응답의 본문을 생성하는 단계로, 다음과 같은 단계로 진행된다

@ResponseBody 또는 HttpEntity 사용: 컨트롤러에서 메서드의 반환 값 앞에 @ResponseBody를 붙이거나, HttpEntity 타입의 객체를 반환함으로써 응답 본문을 생성할 데이터를 지정한다. 이는 스프링에게 해당 메서드의 반환 값을 HTTP 응답 본문에 직접 쓰도록 지시한다.

메시지 컨버터 선택을 위한 canWrite() 호출: 스프링은 메서드의 반환 타입과 클라이언트가 요청한 Accept 미디어 타입을 기반으로 적절한 메시지 컨버터를 선택해야 한다. 이를 위해 등록된 각 메시지 컨버터의 canWrite() 메서드를 호출하여, 해당 컨버터가 반환 타입을 처리할 수 있고, 요청의 Accept 미디어 타입과 호환되는지 확인한다.

대상 클래스 타입 지원 여부 확인: canWrite() 메서드는 컨버터가 처리할 수 있는 데이터 타입(예: byte[], String, HelloData)이 컨트롤러의 반환 타입과 일치하는지 검사한다.
Accept 미디어 타입 지원 여부 확인: 컨트롤러에서 지정한 @RequestMapping의 produces 속성 또는 클라이언트의 Accept 헤더에 지정된 미디어 타입(예: text/plain, application/json, */*)이 컨버터가 지원하는 미디어 타입과 일치하는지 확인한다.

write() 메서드를 통한 데이터 생성: canWrite() 조건을 만족하는 메시지 컨버터가 선택되면, 스프링은 해당 컨버터의 write() 메서드를 호출하여 반환 값 객체를 HTTP 응답 메시지의 본문으로 변환하고 생성한다. 이 과정에서 컨버터는 객체를 적절한 형식(예: JSON, XML, 텍스트)으로 직렬화하고, 응답 스트림에 쓴다.

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

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

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

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

RequestMappingHandlerAdater

RequestMappingHandlerAdapter는 어노테이션 기반의 컨트롤러를 처리하기 위해 사용되는 중심 컴포넌트 중 하나이다.

컨트롤러 내의 @RequestMapping 어노테이션이 붙은 메서드를 HTTP 요청에 매핑하고, 해당 메서드를 호출하는 역할을 한다. 이 과정에서 HTTP 요청 데이터를 메서드의 파라미터로 변환하고, 메서드 실행 결과를 HTTP 응답으로 변환하는 등의 작업을 수행한다.

핵심 기능

메서드 매핑: 클라이언트의 요청 URL, HTTP 메서드, 요청 헤더, 파라미터 등을 기반으로 적절한 컨트롤러 메서드를 찾아낸다.

데이터 바인딩: 요청 본문이나 쿼리 파라미터와 같은 HTTP 요청 데이터를 컨트롤러 메서드의 파라미터 타입으로 변환한다. 이를 위해 HttpMessageConverter를 사용한다.

메서드 호출: 매핑된 컨트롤러 메서드를 실행한다. 이 과정에서 메서드 파라미터로 변환된 요청 데이터가 전달된다.

응답 생성: 컨트롤러 메서드의 반환 값을 클라이언트에 전달할 HTTP 응답으로 변환한다. 반환 값이 void인 경우, 메서드 실행 과정에서 생성된 ModelAndView를 기반으로 뷰를 렌더링한다. 반환 값이 있는 경우, HttpMessageConverter를 사용하여 반환 값을 HTTP 응답 본문으로 변환한다.

HandlerMethodArgumentResolver

어노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다.

이렇게 다양한 파라미터를 유연하게 처리할 수 있는 이유가 ArgumentResolver 덕분이다.

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.

그리고 이렇게 파리미터의 값이 모 두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
스프링은 30개가 넘는 ArgumentResolver 를 기본으로 제공한다.

가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- arguments

HandlerMethodArgumentResolver는 특정한 조건에 따라 메서드 파라미터의 값을 결정하는 데 사용된다. 예를 들어, HTTP 요청의 헤더, 쿠키, 세션 등에서 값을 추출하여 메서드 파라미터로 전달할 수 있다. 또는, 보다 복잡한 객체를 구성하여 컨트롤러 메서드에 전달할 수도 있다.

HandlerMethodArgumentResolver 인터페이스

public interface HandlerMethodArgumentResolver {
    
    boolean supportsParameter(MethodParameter parameter);
    
    @Nullable
    Object resolveArgument(MethodParameter parameter, @Nullable
    ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory
    binderFactory) throws Exception;
}

supportsParameter(MethodParameter parameter)

이 메서드는 현재 리졸버가 주어진 MethodParameter에 대해 파라미터 값을 제공할 수 있는지 여부를 결정한다. 만약 이 메서드가 true를 반환한다면, resolveArgument 메서드가 호출되어 파라미터 값이 해석된다.

매개변수: MethodParameter - 컨트롤러 메서드의 특정 파라미터
반환값: boolean - 이 리졸버가 해당 파라미터를 지원하면 true, 그렇지 않으면 false

resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception

이 메서드는 실제로 파라미터 값을 해석하는 로직을 구현한다. supportsParameter 메서드에 의해 현재 리졸버가 파라미터를 지원한다고 판단되면 호출된다. 이 메서드는 파라미터에 전달할 객체를 반환해야 한다.

매개변수

MethodParameter parameter: 해석할 메서드 파라미터
ModelAndViewContainer mavContainer: 컨트롤러 메서드 실행 결과를 담는 컨테이너, 뷰와 모델 정보를 포함할 수 있음 (@Nullable)
NativeWebRequest webRequest: 현재 요청에 대한 정보를 포함하는 객체
WebDataBinderFactory binderFactory: 데이터 바인딩을 위한 팩토리 객체, 커스텀 바인딩이 필요한 경우 사용될 수 있음 (@Nullable)

반환값

컨트롤러 메서드의 파라미터에 주입될 객체이다. 예를 들어, @RequestBody 어노테이션이 붙은 파라미터를 처리하는 경우, resolveArgument 메서드는 요청 본문의 내용을 파라미터 타입의 객체로 변환하여 반환한다.

반환된 객체는 스프링 MVC에 의해 해당 컨트롤러 메서드의 해당 파라미터에 자동으로 할당된다.

(@Nullable표시는 해당 객체가 null일 수 있음을 의미한다.)

동작 방식

ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고, 지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

원한다면 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver 를 만들 수도 있다.

1. 인터페이스 구현: HandlerMethodArgumentResolver 인터페이스를 구현하는 클래스를 생성한다. 이 클래스에서는 supportsParameter 메서드와 resolveArgument 메서드를 구현해야 한다.

2. supportsParameter: 이 리졸버가 특정 파라미터를 지원하는지 여부를 결정한다. resolveArgument: 실제로 파라미터의 값을 해석하는 로직을 구현한다.

3. 스프링 설정에 리졸버 등록: 생성한 리졸버를 스프링 MVC 설정에 등록해야 한다. WebMvcConfigurer 인터페이스를 구현하는 설정 클래스에서 addArgumentResolvers 메서드를 오버라이드하여 리졸버를 추가한다.

HandlerMethodReturnValueHandler

HandlerMethodReturnValueHandler 인터페이스는 컨트롤러 메서드의 반환값을 처리하는 역할을 담당한다.

컨트롤러 메서드가 실행된 후, 그 결과로 반환된 값이 있을 경우, 이 인터페이스의 구현체를 통해 어떻게 처리할지 결정한다. 이 과정에서 반환값을 HTTP 응답 본문으로 변환하거나, 모델과 뷰를 설정하는 등 다양한 작업을 수행할 수 있다.

핵심 기능

HandlerMethodReturnValueHandler 인터페이스의 주요 기능은 컨트롤러 메서드의 반환값을 적절하게 처리하여 클라이언트에 응답을 제공하는 것이다.

반환값의 타입에 따라, 예를 들어 @ResponseBody가 붙은 메서드의 반환값을 HTTP 응답 본문으로 변환하거나, ModelAndView 객체를 반환하는 경우에는 뷰를 렌더링하는 등의 처리를 담당한다.

컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.

스프링은 10여개가 넘는 ReturnValueHandler 를 지원한다.
예) ModelAndView , @ResponseBody , HttpEntity , String

가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- return-types

HTTP 메시지 컨버터

HTTP MessageConverter 위치

HTTP 메시지 컨버터를 사용하는 @RequestBody 도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다.

@ResponseBody 의 경우도 컨트롤러의 반환 값을 이용한다.

-요청의 경우
@RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있다. 이 ArgumentResolver들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

-응답의 경우

@ResponseBody와 HttpEntity를 처리하는 ReturnValueHandler가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.

스프링 MVC는 @RequestBody @ResponseBody가 있으면 RequestResponseBodyMethodProcessor(), HttpEntity가 있으면 HttpEntityMethodProcessor()를 사용한다.

저작자표시 비영리 변경금지

'Java Category > Spring' 카테고리의 다른 글

[Spring MVC] 예외 처리와 오류페이지 (0)	2024.03.21
[Spring MVC] ArgumentResolver 를 이용한 @Login 어노테이션 구현 (0)	2024.03.20
[Spring MVC] 필터, 인터셉터(로그인 처리 관련) (1)	2024.03.18
[Spring MVC] 세션을 이용한 로그인 (2)	2024.03.17
[Spring MVC] 쿠키를 이용한 로그인 처리 (0)	2024.03.16