스프링 MVC - 기본 기능 (HTTP 응답, HTTP 메시지 컨버터)

본 게시글은 인프런 김영한 선생님 강의 스프링 MVC 1편을 완강하고 배운 것을 남기고자 적은 포스팅입니다.
(2022.08.07 수정) - 복습을 하면서, 기억할 부분 설명 추가.

 

강의 링크는 아래와 같습니다.

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

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

HTTP 응답 데이터는 서블릿에도 다뤘지만, 이번에는 스프링 mvc 응답에 대해 알아보겠다.
스프링에서 응답 데이터를 만드는 방법은 크게 3가지다.

 

• 정적 리소스 - 정적인 HTML, CSS, JS 제공
• 뷰 템플릿 사용 - 템플릿 엔진 사용. 동적인 HTML 제공
• HTTP 메시지 사용 - HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다. 

정적 리소스

스프링 부트는 클래스 패스의 다음 디렉터리에 있는 정적 리소스를 제공한다.

/static, /public, /resources, /META-INF/resources

 

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

따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.

 

• 정적 리소스 경로 - src/main/resources/static
• 다음 경로에 파일이 들어있으면 - src/main/resources/static/basic/hello-form.html
• 웹 브라우저에서 다음과 같이 실행하면 된다.
• http://localhost:8080/basic/hello-form.html

정적 리소스는 해당 파일을 변경 없이 그대로 서비스하는 것이다

뷰 템플릿

뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.

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

뷰 템플릿이 만들 수 있는 것이라면 뭐든지 가능하다.

스프링 부트는 기본 뷰 템플릿 경로를 제공한다.

 

뷰 템플릿 경로 src/main/resources/templates. 뷰 템플릿을 호출하는 컨트롤러를 살펴보자.

@Controller
public class ResponseViewController {
    @RequestMapping("/response-view-v1")
    public ModelAndView responseViewV1(){ 
        ModelAndView mav=new ModelAndView("response/hello").addObject("data","hello");
        // response/hello 템플릿의 위치
        return mav;
    }

    @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!!");
    }

}

String을 반환하는 경우 - View or HTTP 메시지

@ResponseBody 가 없으면 response/hello로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.
@ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello라는 문자가 입력된다.
여기서는 뷰의 논리 이름인 response/hello를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.

Void를 반환하는 경우

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

요청 URL: /response/hello 실행: templates/response/hello.html

참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다고 한다.

HTTP API, 메시지 바디에 직접 데이터를 입력

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로,
HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
HTTP 요청에서 응답까지 대부분 다루었으므로 이번 시간에는 정리를 해보자.

참고

HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다.
여기서 설명하는 내용은 정적 리소스나 뷰 템플릿을 거치지 않고, 직접 HTTP 응답 메시지를 전달하는 경우를 말한다.

@Slf4j
@Controller
//@RestController Controller 과 ResponseBody의 기능을 더했다고 생각
public class ResponseBodyController {
    /**
     * HttpEntity, ResponseEntity(Http Status 추가)
     * @return
     */
    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() throws IOException
    {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() throws IOException
    {
        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;
    }
}

각 버전에 대한 설명을 하겠다.

 

• responseBodyV2
  • ResponseEntity 엔티티는 HttpEntity를 상속받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다. HttpStatus.CREATED로 변경하면 201 응답이 나가는 것을 확인할 수 있다.
• responseBodyV3
  • @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다. ResponseEntity 도 동일한 방식으로 동작한다.
• responseBodyJsonV1
  • ResponseEntity를 반환한다. HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.
• responseBodyJsonV2
  • ResponseEntity는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody를 사용하면 이런 것을 설정하기 까다롭다.
  • @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다. 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다. 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity를 사용하면 된다.

HTTP 메시지 컨버터

뷰 템플릿으로 HTML을 생성해서 응답하는 것이 아니라,

HTTP API처럼 JSON 데이터를 HTTP 메시지 바디에서 직접 읽거나 쓰는 경우 HTTP 메시지 컨버터를 사용하면 편리하다.

 

@ResponseBody의 사용 원리를 알아보겠다. 먼저 아래 이미지를 보자.

 

@ResponseBody를 사용

• HTTP의 BODY에 문자 내용을 직접 반환
• viewResolver 대신에 HttpMessageConverter가 동작
• 기본 문자처리: StringHttpMessageConverter
• 기본 객체처리: MappingJackson2 HttpMessageConverter
• byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

참고 

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

 

스프링 MVC는 다음의 경우 HTTP 메시지 컨버터를 적용한다.

 

• HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
• HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)

HTTP 메시지 컨버터 인터페이스를 살펴보자.

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

 

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

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

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

0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

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

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

 

몇 가지 주요한 메시지 컨버터를 알아보자.

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

HTTP 요청 데이터 읽기

• HTTP 요청이 오고, 컨트롤러에서 @RequestBody, HttpEntity를 파라미터를 사용한다.
• 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead()를 호출한다.
  
  • 대상 클래스 타입을 지원하는가
    • 예) @RequestBody의 대상 클래스 (byte[], String, HelloData)
  • HTTP 요청의 Content-Type 미디어 타입을 지원하는가
    • 예) text/plain, application/json, */*
• canRead() 조건을 만족하면 read()를 호출해서 객체 생성하고, 반환한다. 

HTTP 응답 데이터 생성

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

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

그렇다면 HTTP 메시지 컨버터는 스프링 MVC 어디쯤에서 사용되는 것일까?

다음 그림에서는 보이지 않는다.

 

모든 비밀은 애노테이션의 기반의 컨트롤러,

그러니까 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다.

RequestMappingHandlerAdapter 동작 방식

ArgumentResolver

생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.

HttpServletRequest , Model 은 물론이고, @RequestParam , @ModelAttribute 같은 애노테이션

그리고 @RequestBody , HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.

 

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

 

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor 는

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

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

 

스프링은 30개가 넘는 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 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.

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

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

HTTP 메시지 컨버터

 

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

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

요청의 경우

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

응답의 경우

@ResponseBody 와 HttpEntity를 처리하는 ReturnValueHandler 가 있다.

그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.

 

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

 

 

이상으로 포스팅을 마치겠습니다.