빙응의 공부 블로그
[Spring]스프링 MVC 1편 - 메시지 컨버터 본문
📝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)
HTTP 메시지 컨버터 인터페이스
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(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크한다.
- read(), write() : 지원 체크에 따라 메시지를 읽고 쓰는 기능이다.
0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter
스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다.
예제
- 클라이언트에서 서버로 전송 시(요청)
@PostMapping("/api/resource")
public ResponseEntity<String> createResource(@RequestBody ResourceDTO resourceDTO) {
// 처리 로직
return new ResponseEntity<>("Resource created successfully", HttpStatus.CREATED);
}
클라이언트는 JSON으로 전송
스프링은 MappingJackson2HttpMessageConverter와 같은 적절한 메시지 컨버터를 사용하여 JSON 데이터를 객체로 변환한다.
- 서버에서 클라이언트로 전송 시(응답)
@GetMapping("/api/resource/{id}")
public ResponseEntity<ResourceDTO> getResource(@PathVariable Long id) {
// 데이터 조회 로직
ResourceDTO resourceDTO = // 데이터 가져오기
return new ResponseEntity<>(resourceDTO, HttpStatus.OK);
}
서버는 객체를 JSON 방식으로 변환하여 전달한다.
스프링은 MappingJackson2HttpMessageConverter와 같은 메시지 컨버터를 사용하여 객체를 JSON 데이터로 변환한다.
세부적인 흐름
- HTTP 요청 데이터 읽기
- HTTP 요청이 오고, 컨트롤러에서 @RequestBody 나 HttpEntity 파라미터 사용
- 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 호출
- 대상 클래스 타입을 지원하는가?
- byte[], String, Json객체
- HTTP 요청의 Content-Type 미디어 타입을 지원하는가
- 예) text/plain , application/json , */*
- 대상 클래스 타입을 지원하는가?
- canResd() 조건을 만족하면 read()를 호출해 객체를 생성하고 반환한다.
- HTTP 응답 데이터 생성
- 컨트롤러에서 @ResponseBody , HttpEntity 로 값이 반환된다.
- 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite() 를 호출한다.
- 대상 클래스 타입을 지원하는가?
- HTTP 요청의 Accept 미디어 ㅏㅌ입을 지원하는가.
- canWrite() 조건을 만족하면 write() 를 호출해서 HTTP 응답 메시지 바디에 데이터를 생성한다.
📝요청 매핑 핸들러 어뎁터 구조
그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?
- 모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter 에 있다.
컨트롤러는 매우 다양한 파라미터를 사용할 수 있다.
HttpServletRequest, Model, @RequestParam, @ModelAttribute 등등
ArgumentResolver
- ArgumentResolver는 위의 다양한 파라미터를 유연하게 처리할 수 있게 해준다.
- RequestMappingHandlerAdapter는 ArgumentResolver를 호출하여 컨트롤러에 필요한 파라미터 값을 생성한다.
ReturnValueHandler
- HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandler 라 부른다.
- ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.