BackEnd/Spring MVC

[Spring] 스프링 MVC - 기본 기능 - 3

샤아이인 2022. 2. 28.

내가 공부한것을 올리며, 중요한 단원은 저 자신도 곱씹어 볼겸 상세히 기록하고 얕은부분들은 가겹게 포스팅 하겠습니다.

9. HTTP 응답 - HTTP API, 메시지 바디에 직접 입력

HTTP API를 제공하는 경우에는 HTML이 아닌, 데아터를 메시지 바디에 담아서 JSON 형식으로 보낸다.

<참고>

HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다.

여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

TEXT를 직접 반환하는 방식과 3가지, JSON을 반환하는 방식 2가지 를 살펴보자.

@Slf4j
@Controller
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        response.getWriter().write("OK");
    }

    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() {
        return new ResponseEntity<>("OK", HttpStatus.OK);
    }

    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() {
        return "OK";
    }

    @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1(){
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return new ResponseEntity<>(helloData, HttpStatus.OK);
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2(){
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return helloData;
    }
}

설명을 조금 더해보면

- ResponseEntity는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다

- @ResponseBody를 사용하면 view를 찾는것이 아니라, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.

- ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, json-v2와 같이 @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.

@ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.

다만 이 방식은 애노테이션을 사용하여 정적으로 지정하기 때문에 동적으로 대응하기는 어렵다.

● @RestController

@Controller 대신에 @RestController 애노테이션을 class 래밸에서 사용하면, 해당 컨트롤러에 모두 @ResponseBody 가 적용되는 효과가 있다.

따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다.

이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.

@RestController를 열어보면 @Controller 와 @ResponseBody가 포함되어 있다.

10. HTTP 메시지 컨버터

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

@ResponseBody를 사용한다면, HTTP의 BODY에 문자 내용을 직접 반환할 수 있다.

또한 view이름으로 인식하지 않기 때문에 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();

	default List<MediaType> getSupportedMediaTypes(Class<?> clazz) {
		return (canRead(clazz, null) || canWrite(clazz, null) ? 
            getSupportedMediaTypes() : Collections.emptyList());
	}

	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 요청과 응답 둘다에 사용된다.

우선 canRead(), canWrite() 메서드를 통하여 해당 클래스, 미디어 타입을 지원하는지 확인한 후에

지원한다면 메시지 컨버터의 read(), write() 메서드를 통하여 읽고 쓰는 기능을 한다.

(미디어 타입은 요청일 경우 HTTP message의 content_type, 응답일 경우 accept를 의미한다.)

● 스프링 부트 기본 메시지 컨버터 (일부만 표기, 수가 작을수록 우선순위가 높음)

0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

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

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

- ByteArrayHttpMessageConverter 는 byte[] 데이터를 처리한다.

클래스 타입으로는 byte[] 가 필요하며, 미디어 타입으로는 전부 가능하다.

- StringHttpMessageConverter 는 String 문자로 데이터를 처리한다.

클래스 타입으로는 String이 필요하며, 미디어 타입으로는 전부 가능하다.

- MappingJackson2HttpMessageConverter 는 applicatoin/json과 관련되어 있다.

클래스 타입으로는 객체 또는 HashMap이 필요하며, 미디어 타입으로는 application/json이 필요하다.

한가지 예를 살펴보자.

content-type: application/json

@RequestMapping
void hello(@RequetsBody HelloData data) {}

클라이언트로부터 온 HTTP 메시지의 content-type이 application/json 이다. json 형태로 데이터가 넘어왔다는 의미이다.

해당 데이터를 처리할 알맞은 컨버터를 찾기 위해 다음과 같이 진행된다.

1) 클래스 타입인 byte[] 배열인지 확인한다. 아니다 => ByteArrayHttpMessageConverter (X)

2) String 타입인지 확인한다. 아니다 => StringHttpMessageConverter (X)

3) 객체인지 확인한다. 맞다 => 다음으로는 미디어 타입이 application/json 인지 확인한다. 맞다 =>

MappingJackson2HttpMessageConverter 사용 가능!! (O)

● HTTP 요청 데이터 읽기

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

메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출한다.

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

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

(Content-type 는 client가 보내는 데이터의 타입이다)

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

● HTTP 응답 데이터 생성

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

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

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

2) HTTP 요청의 Accept 미디어 타입을 지원하는가. (요청의 Accept는 client가 받을 수 있는 데이터 타입이다, 즉 클라이언트가 받을수 있는가?)

만약 @RequestMapping 의 produces (예) text/plain , application/json , */* ) 가 있다면 이를 활용하고,

produces 가 없다면 Client의 Accept 헤더를 참고한다.

@PostMapping(value = "/mapping-produce", produces = "text/html")
public String mappingProduces() {
    log.info("mappingProduces");
    return "ok";
}

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

11. 요청 매핑 헨들러 어뎁터 구조

메시지 컨버터는 어디서 작동하고 있을까? 비밀은 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다.

● RequestMappingHandlerAdapter 동작 방식

생각해보면 HandlerAdapter에서 handler의 인자를 어떻게 알고 넘겨줄까??

handler의 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용한다!

HttpServletRequest , Model, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여준다.

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

0) HandlerAdapter는 ArgumentResolver를 호출한다.

1) ArgumentResolver는 컨트롤러의 파라미터, 애노테이션 정보를 기반으로 전달 데이터 생성한다.

2) 실제 컨트롤러(헨들러)를 호출할때 ArgumentResolver가 반환해준 인자를 전달하여 호출한다.

3) 컨트롤러에서 반환할 값이 있다면 ReturnValueHandler를 통하여 반환한다.

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

그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨주는 것 이다.

정확히는 HandlerMethodArgumentResolver 인데 줄여서 ArgumentResolver 라고 부른다.

해당 인터페이스의 간략한 모습은 다음과 같다. 이 인터페이스를 상속받은 여러 구현체들이 있다.

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);

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

동작 방식은 ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고,

지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다. 그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

● ReturnValueHandler

HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다.

ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.

예를 들어 컨트롤러의 반환형 으로는 ModelAndView , @ResponseBody , HttpEntity , String 등이 있는데 이것을 보고 알맞은ReturnValueHandle 구현체를 호출하여 변환후 반환하게 된다.

원래 질문으로 돌아가 보자. HTTP 메시지 컨버터는 어디쯤 있을까?

우선 다음 그림을 살펴보자.

요청의 경우에는, 예를들어 @RequestBody 를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver 도 있습니다. @RequestBody나 HttpEntity는 메시지 컨버터를 필요로 합니다.

이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것 입니다.

예를 들어 어떤 컨트롤러에서는 HttpEntity 형을 필요로 하는 파라미터가 있다고 해봅시다.

이 컨트롤러를 처리하기 위해 RequestMappingHandlerAdapter는 ArgumentResolver를 호출하여 알맞은 객체를 생성해야 합니다.

어떤 ArgumentResolver의 구현체가 사용될까요? 다음 사진을 살펴보시죠!

HandlerMethodArgumentResolver를 상속하고 있는 HttpEntityMethodProcessor를 사용하게 됩니다.

이 ArgumentResolver는 다음 supportsParameter 메서드를 사용하여 자신이 처리가능한지 파악합니다.

@Override
public boolean supportsParameter(MethodParameter parameter) {
		return (HttpEntity.class == parameter.getParameterType() ||
			RequestEntity.class == parameter.getParameterType());
}

ArgumentResolver 자신이 처리할수 있다면 다음 메시지 컨버터를 호출하여 객체를 생성하게 됩니다.

@Override
@Nullable
public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
		NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory)
		throws IOException, HttpMediaTypeNotSupportedException {


    // MessageConverter를 통하여 객체를 생성한다.
	Object body = readWithMessageConverters(webRequest, parameter, paramType);
    // 생성한 객체를 반환한다.
    return new HttpEntity<>(body, inputMessage.getHeaders());
}

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

스프링 MVC는 @RequestBody @ResponseBody 가 있으면 RequestResponseBodyMethodProcessor (ArgumentResolver)

HttpEntity 가 있으면 HttpEntityMethodProcessor (ArgumentResolver)를 사용합니다!

확장

스프링은 다음을 모두 인터페이스로 제공한다. 따라서 필요하면 언제든지 기능을 확장할 수 있다.

- HandlerMethodArgumentResolver

- HandlerMethodReturnValueHandler

- HttpMessageConverter

저작자표시

'BackEnd > Spring MVC' 카테고리의 다른 글

[Spring] 검증1 - Validation - 1 (0)	2022.03.05
[Spring] 메시지, 국제화 (0)	2022.03.05
[Spring] 스프링 MVC - 기본 기능 - 2 (0)	2022.02.27
[Spring] 스프링 MVC - 기본 기능 - 1 (0)	2022.02.26
[Spring] 스프링 MVC - 구조 이해 (0)	2022.02.25