Spring MVC 기본 기능 - 응답 매핑 @ResponseBody, MessageConverter, 요청 매핑 핸들러 어댑터 구조

HTTP Response - 정적 리소스, 뷰 템플릿

스프링에서 응답 데이터를 만드는 방법은 3가지입니다.

1. 정적 리소스

웹 브라우저에 정적인 HTML, css, js를 제공할 때는 정적 리소스를 사용합니다.

스프링 부트는 classpath의 /static, /public, /resources, /META-INF/resources 에 있는 정적 리소스를 제공합니다.

정적 리소스 경로 : src/main/resources/static

src/main/resources는 리소스를 보관하는 곳이고, 또 classpath의 시작 경로입니다.

따라서 src/main/resources/static에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공합니다.

정적 리소스 ▶︎ 해당 파일의 변경 없이 그대로 서비스

2. 뷰 템플릿 사용

웹 브라우저에 동적인 HTML을 제공할 때는 뷰 템플릿을 사용합니다.

일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능합니다.

뷰 템플릿 경로 : src/main/resources/templates

뷰 템플릿 예시

src/main/resources/templates/response/hello.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<p th:text="${data}">empty</p>
</body>
</html>

이제 뷰 템플릿을 호출하는 컨트롤러를 만들어보겠습니다.

package hello.springmvc.basic.response;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

@Controller
public class ResponseViewController {

    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1()
    {
        ModelAndView mav = new ModelAndView("response/hello")
                .addObject("data","hello!");
        return mav;
    }

    // 뷰 리졸버 사용 - @ResponseBody X
    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model)
    {
        model.addAttribute("data","hello!!");
        return "response/hello";
    }

    // 컨트롤러의 이름과 뷰 경로가 같으면
    // 권장하지 않음 - 명시성이 너무 떨어짐.
    @RequestMapping("/response/hello")
    public void responseViewV3(Model model)
    {
        model.addAttribute("data","hello!!");
    }

}

1. ModelAndView를 리턴하는 경우 - responseViewV1

@RequestMapping("/response-view-v1")
public ModelAndView responseViewV1()
{
    ModelAndView mav = new ModelAndView("response/hello")
            .addObject("data","hello!");
    return mav;
}

ModelAndView의 Model에 {data}에 "hello"를 넣고 ModelAndView 리턴

2. String을 리턴하는 경우 - responseViewV2

// 뷰 리졸버 사용 - @ResponseBody X
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model)
{
    model.addAttribute("data","hello!!");
    return "response/hello";
}

@ResponseBody가 없으면 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고 렌더링 합니다.

@ResponseBody가 있으면 뷰 리졸버를 실행하지 않고 HTTP 메시지 바디에 직접 response/hello가 입력됩니다.

여기에서는 Model의 {data}에 "hello"를 넣고 뷰의 논리 이름인 response/hello를 리턴

3. void를 리턴하는 경우 - 컨트롤러의 이름과 뷰 경로가 같은 경우

// 컨트롤러의 이름과 뷰 경로가 같으면
// 권장하지 않음 - 명시성이 너무 떨어짐.
@RequestMapping("/response/hello")
public void responseViewV3(Model model)
{
    model.addAttribute("data","hello!!");
}

@Controller를 사용하고, HttpServletResponse, OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용합니다.

참고로 이 방법은 명시성이 너무 떨어지기 때문에 권장하지 않는 방법입니다.

3. HTTP 메시지 사용

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보냅니다.

@RepsonseBody, HttpEntity를 사용하면 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 응답 데이터를 출력할 수 있습니다.

@Slf4j
@Controller
public class ResponseBodyController {

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

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

    @GetMapping("/response-body-string-v3")
    @ResponseBody
    public String responseBodyV3() throws IOException
    {
        return "ok!";
    }

    @ResponseBody
    @GetMapping("response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1()
    {
        HelloData data = new HelloData();
        data.setUsername("Kdo6301");
        data.setAge(25);
        return new ResponseEntity<>(data,HttpStatus.OK);
    }

    @ResponseStatus(HttpStatus.OK)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2()
    {
        HelloData data = new HelloData();
        data.setUsername("Park");
        data.setAge(34);
        return data;
    }
}

1. responseBodyV1

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

서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok 응답메시지를 전달.

2. responseBodyV2

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

ResponseEntity : HttpEntity를 상속받은 객체로, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있습니다.

ResponseEntity는 여기서 추가로 HTTP 응답 코드를 설정할 수 있습니다.

3. responseBodyV3

@GetMapping("/response-body-string-v3")
@ResponseBody
public String responseBodyV3() throws IOException
{
    return "ok!";
}

@ResponseBody를 사용하여 view를 사용하지 않고, HTTP 메시지 컨버터를 통해 HTTP 메시지를 직접 입력할 수 있습니다. ResponseEntity도 동일하게 동작

4. responseBodyJsonV1 - return ResponseEntity

@ResponseBody
@GetMapping("response-body-json-v1")
public ResponseEntity<HelloData> responseBodyJsonV1()
{
    HelloData data = new HelloData();
    data.setUsername("Kdo6301");
    data.setAge(25);
    return new ResponseEntity<>(data,HttpStatus.OK);
}

ResponseEntity에 HTTP 메시지 컨버터를 통해서 JSON형식으로 변환되어 반환합니다.

5. responseBodyJsonV2 - return 객체

@ResponseStatus(HttpStatus.OK)
@ResponseBody
@GetMapping("/response-body-json-v2")
public HelloData responseBodyJsonV2()
{
    HelloData data = new HelloData();
    data.setUsername("Park");
    data.setAge(34);
    return data;
}

ResponseEntity는 응답코드를 설정할 수 있는데, @ResponseBody를 사용하면 이런 것을 설정하기 까다롭습니다.

@ResponseStatus(HttpStatus.OK) 와 같이 @ResponseStatus 어노테이션을 사용해 응답코드도 설정할 수 있습니다.

+ @RestController

: @Controller대신에 사용하면 해당 컨트롤러 모두 @ResponseBody가 적용되는 효과가 있습니다. 따라서 뷰 템플릿을 사용하는 것이 아니라 , HTTP 메시지 바디에 직접 데이터를 입력합니다. 이름 그대로 REST API를 만들 때 사용하는 컨트롤러입니다.

+ 참고로 @ResponseBody는 클래스 레벨에 두면 전체 메소드에 적용되는데,

@ResponseController 어노테이션 안에 @ResponseBody가 적용되어 있습니다.

HTTP Message Converter

스프링 MVC는 다음의 경우에 HttpMessageConverter가 동작합니다.

HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)

HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)

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

T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
      throws IOException, HttpMessageNotReadableException;

/**
 * Write a 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;

canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어 타입을 지원하는 지 체크하고 해당 클래스, 미디어타입을 지원하는 경우에는 read(), write()를 통해 메시지 컨버터를 통해 메시지를 읽고 씁니다.

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

0 = ByteArrayHttpMessageConverter

1 = StringHttpMessageConverter

2 = MappingJackson2HttpMessageConverter

가 있습니다.

대상 클래스 타입과 미디어 타입 두 개를 체크해서 사용여부를 결정합니다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위 넘김.

0 = ByteArrayHttpMessageConverter

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

1 = StringHttpMessageConverter

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

2 = MappingJackson2HttpMessageConverter

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

동작 원리

HTTP 요청이 들어옵니다. (컨트롤러에서 @RequestBody, HttpEntity 파라미터를 사용)

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

▶︎▶︎ 0번 메시지 컨버터부터 요청 메시지 클래스 타입, 요청의 미디어 타입을 지원하는지 확인하고 canRead()조건 만족 시 read() 호출

(만약 읽지 못하면 다음 메시지 컨버터로 우선순위 pass)

▶︎▶︎▶︎ 객체 생성 및 반환

컨트롤러에서 @ResponseBody, HttpEntity로 값이 반환 되면,

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

▶︎▶︎ 0번 메시지 컨버터부터 요청 메시지 클래스 타입, 요청의 미디어 타입을 지원하는지 확인하고 canWrite()조건 만족 시 write() 호출

(만약 읽지 못하면 다음 메시지 컨버터로 우선순위 pass)

▶︎▶︎▶︎ HTTP 응답 메시지 바디에 데이터 생성

요청 매핑 핸들러 어댑터 구조

HTTP 메시지 컨버터는 MVC 어디쯤에서 사용되는 걸까요?

바로 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter(요청 매핑 핸들러 어댑터)에서 HTTP 메시지 컨버터가 동작합니다.

RequestMappingHandlerAdapter 동작 방식

Request의 경우

@RequestBody를 처리하는 ArgumentResolver가 있고, HttpEntity를 처리하는 ArgumentResolver가 있습니다.

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

@ResponseBody 예시

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody)
{
    log.info("message body = {}",messageBody);
    return "OK";
}

HttpEntity 예시

    @PostMapping("/request-body-string-v3")
    public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {

        String messagebody = httpEntity.getBody();
        log.info("messageBody = {}", messagebody);

        return new HttpEntity<String>("ok");

//        return new ResponseEntity<>("ok", HttpStatus.CREATED);
    }

1. RequestMapping 핸들러 어댑터가 ArgumentResolver를 호출해 컨트롤러의 파라미터, 어노테이션 정보를 기반으로 전달 데이터를 생성합니다.

- ArgumentResolver

ArgumentResolver로 들어온 데이터(파라미터)를 가공하여 필요한 데이터를 뽑아 서버에 전달해주는 역할을 합니다.

(단, 암호화 된 데이터는 불가)

ArgumentResolver는 HandlerMethodArgumentResolver의 구현체로 두 개의 메소드를 가지고 있습니다.

boolean supportsParameter(MethodParameter parameter);

/**
 * Resolves a method parameter into an argument value from a given request.
 * A {@link ModelAndViewContainer} provides access to the model for the
 * request. A {@link WebDataBinderFactory} provides a way to create
 * a {@link WebDataBinder} instance when needed for data binding and
 * type conversion purposes.
 * @param parameter the method parameter to resolve. This parameter must
 * have previously been passed to {@link #supportsParameter} which must
 * have returned {@code true}.
 * @param mavContainer the ModelAndViewContainer for the current request
 * @param webRequest the current request
 * @param binderFactory a factory for creating {@link WebDataBinder} instances
 * @return the resolved argument value, or {@code null} if not resolvable
 * @throws Exception in case of errors with the preparation of argument values
 */
@Nullable
Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
      NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;

supportsParameter() : 주어진 메소드의 파라미터가 이 Argument Resolver에서 지원하는 타입인지 검사 ( true or false )
resolveArgument() : 이 메소드의 반환 값이 대상이 되는 메소드의 파라미터에 바인딩 됩니다.

ArgumentResolver는 WebMvcConfigurer를 상속받아 기능을 확장할 수 있습니다. (확장할 일이 거의 없긴 합니다만.)

public interface WebMvcConfigurer {

default void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
}

2. ArgumentResolver가 HTTP 메시지 컨버터를 사용해서 전달된 데이터를 기반으로 객체를 생성합니다.

Response

컨트롤러가 ReturnValueHandler를 통해 응답 데이터를 HTTP 메시지 컨버터를 호출해서 Response 결과를 만듭니다.

스프링 MVC는

@RequestBody, @ResponseBody가 있으면 RequestResponseBodyMethodProcessor(ArgumentResolver),

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

ArgumentResolver와 ReturnValueHandler가 처리 가능한 값 목록은

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

Web on Servlet Stack

Spring Web MVC is the original web framework built on the Servlet API and has been included in the Spring Framework from the very beginning. The formal name, "Spring Web MVC," comes from the name of its source module (spring-webmvc), but it is more commonl

docs.spring.io

에서 조회할 수 있습니다.

<참고 자료>

https://blog.neonkid.xyz/238

[Spring] Argument Resolver를 이용한 유연성 있는 파라미터 처리

서비스를 운영하다보면 다양한 종류의 데이터를 받게 됩니다. 그럴 때마다 Controller 부분에서 이를 전처리하게 되는데, 이렇게 되면 각 Controller에 전처리 해야 하는 코드를 함수화 하거나 Utils 클

blog.neonkid.xyz

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

Web on Servlet Stack

docs.spring.io

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-mvc-1/dashboard

스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술 - 인프런 | 강의

웹 애플리케이션을 개발할 때 필요한 모든 웹 기술을 기초부터 이해하고, 완성할 수 있습니다. 스프링 MVC의 핵심 원리와 구조를 이해하고, 더 깊이있는 백엔드 개발자로 성장할 수 있습니다., -

www.inflearn.com

https://maenco.tistory.com/entry/Spring-MVC-Argument-Resolver%EC%99%80-ReturnValue-Handler

[Spring MVC] Argument Resolver와 ReturnValue Handler

(참고: Spring Boot를 기준으로 작성된 글입니다) Controller (Controller와 RestController)와 RequestMapping의 글을 정리하면서 클래스와 메서드를 스프링 빈으로 등록하고 매핑이 되는지 살펴보았다 이번에는 R

maenco.tistory.com

저작자표시

'📕 Backend > MVC Pattern' 카테고리의 다른 글

검증(Validation) 처리 방법 (0)	2023.03.20
메시지, 국제화 기능 (0)	2023.03.20
Spring MVC 기본 기능 - 요청 매핑 @RequestMapping, @RequestParam (0)	2023.03.12
Spring MVC 기본 기능 - Logging (0)	2023.03.10
Spring MVC - @RequestMapping, @RequestParam, ModelAndView (0)	2023.03.09

블로그의 정보

Study Repository

rlaehddnd0422

Spring MVC 기본 기능 - 응답 매핑 @ResponseBody, MessageConverter, 요청 매핑 핸들러 어댑터 구조

HTTP Response - 정적 리소스, 뷰 템플릿

1. 정적 리소스

2. 뷰 템플릿 사용

3. HTTP 메시지 사용

HTTP Message Converter

0 = ByteArrayHttpMessageConverter

1 = StringHttpMessageConverter

2 = MappingJackson2HttpMessageConverter

동작 원리

요청 매핑 핸들러 어댑터 구조

Request의 경우

- ArgumentResolver

Response

'📕 Backend > MVC Pattern' 카테고리의 다른 글

블로그의 정보

활동하기

티스토리툴바

HTTP Response - 정적 리소스, 뷰 템플릿

1. 정적 리소스

2. 뷰 템플릿 사용

3. HTTP 메시지 사용

HTTP Message Converter

0 = ByteArrayHttpMessageConverter

1 = StringHttpMessageConverter

2 = MappingJackson2HttpMessageConverter

동작 원리

요청 매핑 핸들러 어댑터 구조

Request의 경우

- ArgumentResolver

Response

'📕 Backend > MVC Pattern' 카테고리의 다른 글

블로그의 정보

활동하기

공유하기

다른 글

티스토리툴바