[스프링 MVC 1편] - 스프링 MVC - 기본 기능(2)

Chooooo·2023년 1월 5일
MVCspring mvc기본 기능
1

스프링 MVC 1편

목록 보기
7/11
post-thumbnail

이 글은 강의 : 김영한님의 - "[스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술]"을 듣고 정리한 내용입니다. 😁😁

이번에는 이어서 HTTP 요청 메세지에 데이터를 직접 담아서 요청하는 부분부터 다시 공부하자

HTTP 요청 메세지 - 단순 텍스트

지금까지는 쿼리 스트링을 이용해서 요청 파라미터를 전송하는 학습을 했는데, 그 외에도 HTTP 메세지 바디에 데이터를 직접 담아서 요청하는 방법도 있따.

HTTP API에서 주로 사용하며 JSON, XML, TEXT... 거의 모든 데이터를 전송할 수 있다. 주로 JSON 형식의 데이터를 주고 받을 때 많이 사용한다.

주의할 점은 요청 파라미터와는 다르게 HTTP 메세지 바디를 통해 데이터가 직접 넘어오는 경우는 HTML Form 방식을 제외하고는 @RequestParam, @ModelAttribute를 사용할 수 없다. (중요!!!)

먼저, 요청 메세지로 단순 텍스트를 담아서 전송하고 읽어보며 학습해보자.
HTTP 메세지 바디의 데이터를 InputStream을 사용해서 직접 읽는게 가능하다.

RequestBodyStringController

컨트롤러 내부에서 하나씩 뜯어보자

requestBodyString

HttpServletRequest에서 getInputStream()으로 읽어와서 문자열로 변환해서 읽을 수 있다.

@PostMapping("/request-body-string-v1")
public void requestBodyString(HttpServletRequest request, HttpServletResponse response) throws IOException {
    ServletInputStream inputStream = request.getInputStream();
    String string = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    log.info("messageBody={}", string);

    response.getWriter().write("ok");
}

requestBodyStringV2

매개변수에서 바로 inputStream과 writer를 받을 수도 있다.

@PostMapping("/request-body-string-v2")
public void requestBodyStringV2(InputStream inputStream, Writer writer) throws IOException {
    String string = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    log.info("messageBody={}", string);

    writer.write("ok");
}

🎃 InputStream(Reader) : HTTP 요청 메세지 바디의 내용을 직접 조회
🎃 OutputStream(Writer) : HTTP 응답 메세지의 바디에 직접 결과 출력

requestBodyStringV3

HttpEntity를 사용해서 더 편리하게 조회가 가능하다.

(아직까지도 요청 메세지로 HTTP 메세지 바디에 단순 스트링이 들어오는거야)

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

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

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

🎃 HttpEntity : HTTP header, body정보를 편리하게 조회할 수 있게 해준다.
⇒ 메세지 바디 정보를 직접 조회 가능(getBody())
⇒ 요청 파라미터를 조회하는 기능과 관계 없다.(@RequestParam, @ModelAttribute)
⇒ 응답에서도 사용할 수 있다.
→ 헤더 정보포함도 가능하지만, View 조회는 안된다.

참고

스프링MVC 내부에서 HTTP 메세지 바디를 읽어 문자나 객체로 변환해서 전달해주는데, 이때 HTTP 메세지 컨버터(HttpMessageConverter)라는 기능을 사용한다. (뒤에서 공부할 것)

requestBodyStringV4

@RequestBody 애노테이션을 이용해 더 간편하게 요청 메세지 바디를 받을 수 있다.

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String body){

    log.info("messageBody={}", body);

    return "ok";
}

🎃 @RequestBody

  • HTTP 메세지 바디 정보를 편리하게 조회하게 해주는 애노테이션으로 만약 바디가 아니라 헤더 정보가 필요하면 HttpEntity나 @RequestHeader애노테이션을 사용하면 된다.
    (현재 단순 문자열이 들어오는데 그걸 편리하게 조회할 수 있도록 도와줌)

  • 즉 간편하게 HTTP 요청 메세지 바디 정보를 바로 파라미터로 가져올 수 있도록 해줌 !! (결국 실무에서도 이 @RequestBody를 진짜 많이 쓴대 !)

  • 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute와는 관계가 없다.

@RequestBody는 HTTP 요청 메세지 바디를 직접 조회하는거야!
 (중간에 HttpMessageConverter가 바꿔주는거야)

✨ 참고 : 요청 파라미터 vs HTTP 메세지 바디
요청 파라미터를 조회하는 기능은 @RequestParam, @ModelAttribute를 사용하고 HTTP 메세지 바디를 직접 조회하는 기능 애노테이션은 @RequestBody를 사용한다. (😅 중요!!!)

HTTP 요청 메세지 - JSON

위에서도 말했지만, HTTP 요청 메세지 바디에는 주로 (거의 대부분) JSON이 사용된다.
JSON은 다음과 같은 구조인데, 이를 객체로 변환하는 과정에 대해서 학습하자.

{
    "username":"abc",
    "age":13
}
@Data
public class HelloData {
    private String username;
    private int age;
}

🎈 JSON → 객체 (JSON을 객체로 변환 알아보자)

RequestBodyJsonController

컨트롤러 내부에서 하나씩 살펴보자

requestBodyJsonV1

예전 방식의 HttpServletRequest, HttpServletResponse 객체에서 메세지 바디를 읽어와 ObjectMapper로 객체 바인딩을 하는 코드

@PostMapping("/request-body-json-v1")
public void requestBodyJsonV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
    ServletInputStream inputStream = request.getInputStream();
    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    log.info("messageBody={}", messageBody);
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
    log.info("helloDate = {}", helloData.toString());

    response.getWriter().write("ok");
}

🎃 HttpServletRequest를 직접 HTTP 메세지 바디에서 데이터를 읽어와, 문자로 변환한다.

🎃 문자로 된 JSON 데이터를 Jackson 라이브러리인 ObjectMapper를 사용해 객체 변환을 한다.

예전 방식으로 JSON을 받아서 처리하려니 처리해야할 기본 로직이 상당히 많다. StreamUtil부터 ObjectMapper까지 꺼내서 사용을해야하는데 JSON을 받아서 사용해야 할 컨트롤러가 많을수록 코드 중복이 많아질수밖에 없다.

requestBodyJsonV2

위에서 배운 @RequestBody 애노테이션을 이용해 메세지 바디(요청 데이터)를 바로 받아서 사용하면 InputStream을 꺼내서 StreamUtil로 변환해줄 필요 없이 바로 ObjectMapper로 객체 변환을 해줄 수 있다.

@PostMapping("/request-body-json-v2")
@ResponseBody
public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    log.info("messageBody={}", messageBody);
    HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
    log.info("helloDate = {}", helloData.toString());

    return "ok";
}
  • ObjectMapper를 통해 객체 변환하는 과정도 번거롭긴 마찬가지. @ModelAttribute처럼 애노테이션으로 한번에 객체 변환은 불가능 한 것인가?

requestBodyJsonV3

@RequestBody를 사용하면 객체를 직접 지정해서 매핑해 줄 수도 있다.

요청 HTTP 메세지 바디 내용을 @RequestBody애노테이션을 이용해서 객체로 만들어서 파라미터로 바로 넣어줌!!

@PostMapping("/request-body-json-v3")
@ResponseBody
public String requestBodyJsonV3(@RequestBody HelloData helloData){
    log.info("helloDate = {}", helloData.toString());

    return "ok";
}

🎃 HttpEntity, @RequestBody를 사용하면 HTTP 메세지 컨버터가 HTTP 메세지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
(위의 예시로 적용해보면 컨버터는 content-type이 applicaion/json인 것을 확인한 후에, JSON인 것을 확인했으니 객체에 맞게 반환해준다.)
(V2에서 했던 작업을 대신 처리해준다.)

🎃 HTTP 메세지 컨버터는 문자 뿐 아니라 JSON도 변환해주며 우리가 위에서 수동으로 진행했던 과정을 대신 처리해준다.

🎃 @RequestBody는 생략이 불가능하다.

  • 기본 타입과 나머지는 모두 @RequestParam, @ModelAttribute가 매핑하기 때문
  • 그래서 위 코드에서 해당 애노테이션을 제거하면 @ModelAttribute가 적용되어 버린다.
    (따라서 생략하면 HTTP 메세지 바디가 아니라 요청 파라미터를 처리하게 된다)

😐 주의 : Content-Type은 applicaion/json이어야 한다.

HTTP 요청 시에 content-type이 applicaion/json인지 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메세지 컨버터가 실행된다. (😊 중요!!!)

requestBodyJsonV4,V5

requestBodyJsonV4 - HttpEntity

@PostMapping("/request-body-json-v4")
@ResponseBody
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity){
    HelloData helloData = httpEntity.getBody();
    log.info("helloDate = {}", helloData.toString());

    return "ok";
}
@PostMapping("/request-body-json-v5")
@ResponseBody
public HelloData requestBodyJsonV5(@RequestBody HelloData helloData){
    log.info("helloDate = {}", helloData.toString());

    return helloData;
}

🎃 HttpEntity를 이용해서 제네릭스 타입으로 객체 매핑도 가능하다.
🎃 V5를 보면 애노테이션을 최대한 활용해서 V1보다 훨씬 간결해진 코드가 완성된다.

🎃 @RequestBody 요청

  • JSON 요청 → HTTP 메세지 컨버터 → 객체

🎃 @ResponseBody 응답

  • 객체 → HTTP 메세지 컨버터 → JSON 응답

결국! V5를 보면 해당 객체로 반환을 해도 돼! 이유는 @ResponseBody애노테이션 때문인데, 해당 객체를 반환하면서 JSON으로 바꿔서 반환된다!

😀 @ResponseBody

  • 응답의 경우에도 해당 애노테이션을 사용하면 해당 객체를(HelloData) HTTP 메세지 바디에 직접 넣어줄 수 있다. (이 경우에도 HttpEntity 사용해도 되긴 함)

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

응답 부분에 초점을 맞춰서 정리해보자
HTTP 요청에 대해서 서버에서 비즈니스 로직이 다 수행된 다음 이제 응답을 해야하는데 스프링(서버)에서 응답 데이터를 만드는 방식은 크게 세 가지가 있다.

  • 정적 리소스
    🎃 웹 브라우저에서 정적인 HTML, css, JS를 제공할 때 정적 리소스를 사용한다.

  • 뷰 템플릿 사용
    🎃 웹 브라우저에서 동적인 HTML을 제공할 때 뷰 템플릿을 사용한다.

  • HTTP 메세지 사용
    🎃 HTTP API를 제공하는 경우 HTML이 아니라 데이터를 전달해야 하기 때문에 HTTP 메세지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.

정적 리소스

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

  • /static
  • /public (public 디렉토리를 따로 만들어도 돼)
  • /resources
  • /META-INF/resources

src/main/resources는 리소스를 보관하는 곳이고, 또 클래스 패스의 시작 경로이다.
따라서 다음 디렉토리에 리소스를 넣어두면 스프링 부트가 정적 리소스로 서비스를 제공한다.

(이전에도 말했지만, resources/static에 넣어둔 자원은 전부 정적으로 스프링 부트가 내장 톰캣을 통해서 자동으로 서빙을 해준다!!)

예를 들어, 정적 리소스 경로 src/main/resources/static/basic/hello-form.html에 해당 파일이 있다면 웹 브라우저에서는 컨트롤러를 통하지 않고 정적 리소스 경로 뒤의 경로를 입력해 바로 가져올 수 있다.
(웹 브라우저에서는 http://localhost:8080/basic/hello-form.html을 실행한다)

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

뷰 템플릿

뷰 템플릿을 거쳐 HTML이 생성되고 뷰가 응답을 만들어 전달하는데, 일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만 다른 것들도 가능하다. 뷰 템플릿이 만들 수 있다면 뭐든지 가능하다.

실제로 타임리프 뷰 템플릿을 이용해 간단한 페이지를 만들어보자.

뷰 템플릿 생성

경로 : src/main/resources/templates/response/hello.html
스프링에서는 뷰 템플릿은 기본으로 src/main/resources/templates 경로를 제공한다.

<!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>

해당 HTML을 쓰는 컨트롤러를 만들어보자.

ResponseViewController

위에 작성한 hello라는 뷰를 호출하는 컨트롤러

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.servlet.ModelAndView;

@Controller
public class ResponseViewController {

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

        return mv;
    }

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

보면 모두 반환 타입이 다르다(ModelAndView, String, void) 각각의 반환 타입별 로직은 달라진다.

🎃 ModelAndView 를 반환하는 경우(responseViewV1)
⇒ 객체에서 View를 꺼내어 물리적인 뷰 이름으로 완성한 뒤 뷰를 찾아 렌더링을 한다.

🎃 String을 반환하는 경우(responseViewV2)
⇒ @ResponseBody(혹은 클래스레벨에서 @RestController)가 없으면 response/hello라는 문자가(뷰 이름으로 인식) 뷰 리졸버로 전달되어 실행되서 뷰를 찾고 렌더링을 한다.
⇒ @ResponseBody(혹은 클래스레벨에서 @RestController)가 있으면 뷰 리졸버를 실행하지 않고 HTTP 메세지 바디에 직접 response/hello 라는 문자가 입력된다.
⇒ 위 코드에서는 /response/hello를 반환하는데 뷰 리졸버는 물리적 이름을 찾아서 렌더링을 실행한다.
→ 실행: templates/response/hello.html

(스프링부트에서 templates에 올려놓은 HTML을 논리이름으로 반환해도 물리 이름을 찾아서 렌더링 실행준다. prefix, suffix 모두 스프링부트가 세팅을 다 해놨어! 그냥 쓰면 돼)

🎃 void를 반환하는 경우(responseViewV3)
⇒ @Controller를 사용하고 HttpServletResponse, OutputStream(Writer)같은 HTTP 메세지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다.
⇒ 위 코드에서 경로는 요청 URL인 (/response/hello)를 사용한다.

⇒ 이 방식은 명시성이 너무 떨어지고 이런 케이스가 나오는 경우도 거의 없어 권장하지 않는다.

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

Thymeleaf 스프링 부트 설정

우리는 이미 프로젝트 생성 시점에서 Thymeleaf 라이브러리를 추가해놨지만, 만약 추가를 하지 않았다면...

build.gradle 소스에 다음 코드를 추가한다.

  • build.gradle
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'

🎃 스프링 부트는 자동으로 ThymeleafViewResolver와 필요한 스프링 빈들을 등록하는데, 스프링 설정을 통해 해당 뷰 리졸버에서 뷰 템플릿의 물리적 경로를 완성할 때 접두사나 접미사를 변경할 수도 있다.

application.properties

#아래 설정은 기본값이기에 변경이 필요할때만 사용한다. 
spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

classpath는 resources를 말함. (Thymeleaf를 쓰면 이 환경이 자동으로 들어간다!)

HTTP 응답 - HTTP API(REST API), 메세지 바디에 직접 입력

HTTP API를 제공하는 경우 응답 메세지로 HTML이 아니라 데이터를 전달해야 한다. 그리고 이때 HTTP 메세지 바디에는 JSON과 같은 형식으로 데이터를 실어서 보낸다.

참고

HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메세지 바디에 데이터를 담아서 전달한다. 하지만 이번 섹션에서 말하는 내용은 정적 리소스나, 뷰 템플릿이 아니라 직접 HTTP 응답 메세지를 전달하는 경우를 말한다.

ResponseBodyController

package hello.springmvc.basic.response;

import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@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() {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

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


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

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

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

        return helloData;
    }


}

🎃 responseBodyV1
⇒ 서블릿을 직접 다룰 때와 같이 코드가 구현되있다.
HttpServletResponse 객체를 통해 HTTP 메세지 바디에 직접 OK 응답 메세지를 전달한다.
→ response.getWriter().write("ok")

🎃 responseBodyV2
⇒ ResponseEntity 엔티티는 HttpEntity를 상속받았는데, HttpEntity는 HTTP메세지의 헤더, 바디 정보를 가지고 있다면 ResponseEntity는 HTTP 응답코드가 추가되었다고 생각하면 된다.
→return new ResponseEntity<>(helloData, HttpStatus.OK);

🎃 responseBodyV3
⇒ @ResponseBody 애노테이션을 사용하면 view 를 사용하지 않고 HTTP 메세지 컨버터를 통해 HTTP 메세지를 직접 입력할 수 있다 ResponseEntity도 동일한 방식으로 동작한다.

🎃 responseBodyJsonV1
⇒ ResponseEntity를 반환한다. HTTP 메세지 컨버터를 통해서 객체는 JSON으로 변환되어 반환된다.

🎃 responseBodyJsonV2
⇒ ResponseEntity는 HTTP 응답 코드를 설정할 수 있는데 @ResponseBody를 사용하면 설정하기가 까다롭다. 그래서 이런 경우에는 @ResponseStatus 애노테이션을 이용하여 상태코드를 설정할 수 있다.
⇒ 정적으로 상태코드를 작성한 것이기에 유연하지는 못하다. 그렇기에 동적으로 상태코드가 변경되야하는 상황이라면 ResponseEntity를 사용하면 된다.

어떤 상황에 어떤 것을 쓸 것인지 파악해두기.

😁 API 만들 때는 거의 responseBodyJsonV2와 같은 방식 많이 사용해. 그렇기 때문에 @RestController를 사용하는게 대부분..?

참고 : @RestController

@Controller 대신에 @RestController 애노테이션을 사용하면, 해당 컨트롤러에 모두
@ResponseBody 가 적용되는 효과가 있다. 따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로 Rest API(HTTP API)를 만들 때 사용하는 컨트롤러이다.
참고로 @ResponseBody 는 클래스 레벨에 두면 전체 메서드에 적용되는데, @RestController
에노테이션 안에 @ResponseBody 가 적용되어 있다

HTTP 메세지 컨버터

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

지금까지 여러 애노테이션을 이용해서 JSON, queryString등을 @RequestBody, @ModelAttribute 등으로 편하게 객체로 변환해서 사용했다.그런데 이쯤에서 어떻게 스프링이 객체로 변환을 해주는지에 대해 의문을 가질 필요가 있다.

HTTP 메세지 컨버터를 설명하기 전 @ResponseBody의 사용 원리를 살펴보자.

@ResponseBody를 사용하니 HTTP의 바디에 문자 내용을 직접 반환하는데, 그림을 보면 viewResolver 대신 HttpMessageConverter가 동작한다.

  • 기본 문자 처리 : StringHttpMessageConverter
  • 기본 객체 처리 : MappingJackson2HttpMessageConverter
  • byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있다.

여기서 응답할 때 클라이언트의 HTTP Accept 헤더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해 HttpMessageConverter가 선택된다.
정리하면 스프링 MVC는 다음의 경우에 HTTP 메세지 컨버터를 적용한다.

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

HTTP 메세지 컨버터 인터페이스

org.springframework.http.converter.HttpMessageConverter

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 메세지 컨버터는 요청 및 응답 둘 다 사용된다.

  • 요청시 : JSON → 객체
  • 응답시 : 객체 → JSON

🎃 boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
🎃 boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);

  • 메세지 컨버터가 해당 클래스, 미디어 타입을 지원하는지 체크하는 메서드

🎃 T read()
🎃 void write()

  • 메세지 컨버터를 통해 메세지를 실제로 변환하는 메서드(메세지 컨버터를 통해 메세지를 읽고 쓰는 기능)

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

0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

실제로는 기본 등록되는 컨버터가 더 많지만 생략한다.

대상 클래스 타입과 미디어 타입 둘을 체크한 뒤 사용여부를 결정한다. 등록된 메세지 컨버터들이 순회하며 만족한다면 멈추고 해당 컨버터를 사용하고 조건을 만족하지 않으면 다음 컨버터로 우선순위가 넘어간다.

주로 쓰이는 컨버터 메세지에 대해서 알아보자.

  1. ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
  • 클래스 타입 : byte[], 미디어 타입 : */* (미디어 타입 아무거나 다 받을 수 있음)
  • 요청 예) @RequestBody byte[] data (바이트 배열로 바꿔서 data에 넣어줌)
  • 응답 예) @ResponseBody return byte[] 쓰기 미디어 타입 application/octet-stream (HTTP 응답 헤더에 이게 자동으로 들어간다는 뜻)
  1. StringHttpMessageConverter : String 문자로 데이터를 처리한다.
  • 클래스 타입 : String, 미디어 타입 : */* (역시 미디어타입 아무거나 받을 수 있음)
  • 요청 예) @RequestBody String data (예를들어 바이트로 온걸 String으로 컨버팅해서 넣어준다.)
  • 응답 예) @ResponseBody return "ok" 쓰기 미디어타입 text/plain (응답 헤더에 자동으로 넣어준다.)

여기서 보면,HTTP 메세지 바디에 데이터가 있다면 항상 Content-Type을 지정해줘야만 해. 요청 메세지든, 응답 메세지든 !!

  1. MappingJackson2HttpMessageConverter : application/json
  • 클래스 타입 : 객체 또는 HashMap, 미디어 타입 : applicaion/json 관련 (거의 applicaion/json으로만 쓴다.)
  • 요청 예) @RequestBody HelloData data (바이트도 아니고 스트링도 아니라면 해당 데이터를 객체로 만들어서 자동으로 넣어준다.)
  • 응답 예) @ResponseBody return helloData 쓰기 미디어타입 application/json 관련 (응답 헤더에 자동으로 넣어준다.)

HTTP 요청을 보낼 때는 Content-Type인데, 응답할 때는 Accept가 미디어 타입에 영향을 준다.

HTTP 요청/응답 데이터 읽기/쓰기

HTTP 요청 데이터 읽기

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

🎃 메세지 컨버터가 메세지를 읽을 수 있는지 확인하기 위해 canRead()로 지원 여부를 확인한다.
⇒ 대상 클래스 타입을 지원하는가 ( Ex: @RequestBody의 대상 클래스(byte[], String, HelloData)
⇒ HTTP 요청의 Content-Type 미디어 타입을 지원하는가(Ex: 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 메세지 컨버터 작동 예시

🎃 StringHttpMessageConverter

content-type: application/json
@RequestMapping
void hello(@RequetsBody String data) {}

  1. 먼저 canRead를 호출해서 데이터가 바이트인지 확인, String이니 패스

  2. 데이터가 String인지 확인(StringHttpMessageConverter), String은 OK 다음으로 미디어 타입을 확인하는데 applicaion/json. 해당 컨버터는 미디어타입 아무거나 동작 가능. 그래서 여기서 동작해 !!

  • 이 case는 StringHttpMessageConverter가 동작한다.

🎃 MappingJackson2HttpMessageConverter

content-type: application/json
@RequestMapping
void hello(@RequetsBody HelloData data) {}

우선순위 상 String으로 클래스타입을 설정하면 스트링 컨버터가 동작할 수 밖에 없음. 그렇기에 위에서처럼 객체로 클래스 타입을 받으면 돼.

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

그렇다면 HTTP 메세지 컨버터는 스프링 MVC 어디쯤에서 사용되는가?
다음 그림에서는 보이지 않는다.

🎈 springMVC 구조

스프링MVC의 구조를 보면 HTTP 요청부터 응답까지 여러 과정을 거쳐서 결과가 응답하는데, 여기서 HTTP 메세지 컨버터는 어디서 사용되는 것일지 의문을 가질 수 있다.
이 의문의 키워드는 @RequestMapping에 있다.

모든 비밀은 애노테이션 기반의 컨트롤러 그러니까 @RequestMapping을 처리하는 핸들러 어댑터인 RequestMappingHandlerApdater(요청 매핑 핸들러 어댑터)에 있다.

RequestMappingHandelrAdapter 동작 방식

@RequestMapping 애노테이션을 처리해주는 핸들러 어댑터가 RequestMappingHandelrAdapter인데, 이 어댑터의 동작 방식은 ...

스프링 MVC 를 학습하면서 HttpServletRequest나 Model부터 @RequestParam, @ModelAttribute같은 애노테이션이나 @RequestBody, HttpEntity까지 정말 많은 요청 파라미터를 처리하는데 해당 어댑터에서는 ArgumentResolver를 호출해서 컨트롤러가 필요로 하는 다양한 파라미터의 값을 생성한다. 그리고 모든 파라미터의 값이 준비되면 컨트롤러를 호출하면서 값을 넘겨준다. 참고로 스프링은 30개가 넘는 ArgumentResolver를 기본으로 제공한다.

즉, ArgumentResolver에서 파라미터를 다 만들어서 컨트롤러 호출해서 넘겨준다 !!
(@RequestBody 같은 거..)

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() 메서드를 호출해서 실제 객체를 생성한다.(이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.)
  • 지원안할 경우, 다음 ArgumentResolver로 우선순위가 넘어간다.

ReturnValueHandler

HandlerMethodReturnValueHandler를 줄여서 ReturnValueHandler라 부른다.
이 또한 ArgumentResolver와 비슷한데, 이것은 요청이 아닌 응답 값을 변환하고 처리한다.

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

스프링은 10개가 넘는 ReturnValueHandler를 지원한다.

  • 예) ModelAndView, @ResponseBody, HttpEntity, String 등등

HTTP 메세지 컨버터

그래서 HTTP 메세지 컨버터는 도대체 어디에 있는건가? 해당 컨버터가 필요한 상황은 대표적으로 @RequestBody같은 애노테이션일텐데 다음 구조를 확인해보자.

🎃 HTTP 메세지 컨버터를 사용하는 @RequestBody도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다. @ResponseBody의 경우에도 컨트롤러의 반환 값을 이용한다.

⇒ 요청의 경우 @RequestBody를 처리하는 ArgumentResolver가 있고 HttpEntity를 처리하는 ArgumentResolver가 있는데, 이 ArgumentResolver들이 HTTP 메세지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

🎃 응답의 경우에도 @ResponseBody가 사용되며 컨트롤러의 반환값을 이용하기에 그 시점에서 HTTP 메세지 컨버터는 이용된다.
⇒ 응답의 경우 @ResponseBody와 HttpEntity를 처리하는 ReturnValueHandler가 있는데 여기서 HTTP 메세지 컨버터를 호출해서 응답 결과를 얻는다.

🎈 확장
스프링은 이런 ArgumentReolver나 ReturnValueHandler, MessageConverter를 모두 인터페이스로 제공하기에 다음과 같은 인터페이스를 언제든지 확장해서 사용할 수 있다.

  • HandlerMethodArgumentResolver
  • HandlerMethodReturnValueHandler
  • HttpMessageConverter

대부분은 이미 스프링에서 구현되어 제공되기에 실제로 확장할 일이 많지는 않다.
만약 기능 확장을 할 때는 WebMvcConfigurer를 상속받아 스프링 빈으로 등록하면 된다.

  • WebMvcConfigure 확장
@Bean
public WebMvcConfigurer webMvcConfigurer() {
		return new WebMvcConfigurer() {
				@Override
				public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers){
						//...
				}

				@Override
				public void extendMessageConverters(List<HttpMessageConverter<?>>	converters) {
						//...
				}
		};
}

하지만 확장할 일은 많지 않을 것...

스프링은 철저하게 인터페이스(설계)와 구현으로 나뉘어져 있다는 것을 다시 한번 확인할 수 있었다.

여기까지 보면 스프링 MVC의 전체 구조를 전부 다 확인한 것이다 ! 이제부터는 이것들을 활용하고 확장해 나가보자.

profile
Chooooo
back-end, 지속 성장 가능한 개발자를 향하여
이전 포스트

[스프링 MVC 1편] - 스프링 MVC - 기본 기능(1)

다음 포스트

[스프링 MVC 1편] - 웹 페이지 만들기(1)

0개의 댓글