[Spring MVC] 04. 컨트롤러가 파라미터를 유연하게 처리할 수 있는 이유

컨트롤러가 파라미터를 유연하게 처리할 수 있는 이유

애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있다. HttpServletRequest , Model은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다. 이렇게 파라미터를 유연하게 처리할 수 있는 이유는 바로 ArgumentResolver 덕분이다.

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor 는 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다. 그리고 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

public interface HandlerMethodArgumentResolver {
	boolean supportsParameter(MethodParameter parameter); // 파라미터를 지원하는지 체크

	// 실제 객체 생성(이후 컨트롤러 호출 시 전달됨)
	@Nullable
	Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception; 
}

HTTP 요청의 경우 @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.
HTTP 응답의 경우 @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다

 

 

HttpMessageConverter

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

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

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

• 0 = ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
  
  • 대상 클래스 타입: byte[]
    
  • 읽기 미디어타입: */*
    • 요청 예) @RequestBody byte[] data
      
  • 쓰기 미디어타입 application/octet-stream
    • 응답 예) @ResponseBody return byte[]
• 1 = StringHttpMessageConverter : String 문자로 데이터를 처리한다.
  • 대상 클래스 타입: String
    
  • 읽기 미디어타입: */*
    • 요청 예) @RequestBody String data
      
  • 쓰기 미디어타입 text/plain
    • 응답 예) @ResponseBody return "ok"
• 2 = MappingJackson2HttpMessageConverter : application/json
  
  • 대상 클래스 타입: 객체 또는 HashMap
    
  • 읽기 미디어타입 application/json 관련
    • 요청 예) @RequestBody HelloData data
      
  • 쓰기 미디어타입 application/json 관련
    • 응답 예) @ResponseBody return helloData

 

 

HTTP 요청 데이터 읽기

• @RequestBody , HttpEntity(RequestEntity) 를 사용하는 경우
  • 메세지 컨버터가 메세지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다
    • 대상 클래스 타입을 지원하는가.
      • 예) @RequestBody 의 대상 클래스 ( byte[] , String , HelloData )
    • HTTP 요청의 Content-Type 미디어 타입을 지원하는가.
      • 예) text/plain , application/json 

HTTP 응답 데이터 생성

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

 

 

When receiving a new request, Spring will use the “Accept” header to determine the media type that it needs to respond with. It will then try to find a registered converter that's capable of handling that specific media type. Finally, it will use this to convert the entity and send back the response. The process is similar for receiving a request which contains JSON information. The framework will use the “Content-Type” header to determine the media type of the request body.

새로운 request를 받으면, 스프링은 "Accept" 헤더를 사용해서 응답할 media type을 결정한다. 그리고 특정 media type을 처리할 수 있는 converter를 찾으려고 시도한다. 마지막으로 이를 사용해서 엔터티를 변환하고 응답을 다시 보낸다. 또한, 스프링은 "Content-Type" 헤더를 사용해서 request body의 media type을 결정한다.

Example

• the Client sends a GET request to /foos with the Accept header set to application/json – to get all Foo resources as JSON
• the Foo Spring Controller is hit and returns the corresponding Foo Java entities
• Spring then uses one of the Jackson message converters to marshall the entities to JSON

 

 

👍 Reference

https://inf.run/uCYa

https://www.baeldung.com/spring-httpmessageconverter-rest