'스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술' 수업을 듣고 정리한 내용입니다.

 

📚 1. HTTP 요청 - 기본, 헤더 조회

애노테이션 기반의 스링 컨트롤러는 다양한 파라미터를 지원한다.
HTTP 헤더 정보를 조회하는 방법을 알아보자

 

RequestHeaderController

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpMethod;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Locale;

@Slf4j
@RestController
public class RequestHeaderController {

    @RequestMapping("/headers")
    public String headers(HttpServletRequest request,
                          HttpServletResponse response,
                          HttpMethod httpMethod,
                          Locale locale,
                          @RequestHeader MultiValueMap<String, String> headerMap,
                          @RequestHeader("host") String host,
                          @CookieValue(value = "myCookie", required = false) String cookie){

        log.info("request={}", request);
        log.info("response={}", response);
        log.info("httpMethod={}", httpMethod);
        log.info("locale={}", locale);
        log.info("headerMap={}", headerMap);
        log.info("header host={}", host);
        log.info("myCookie={}", cookie);
        return "ok";
    }
}

• HttpMethod : HTTP 메서드를 조회한다. org.springframework.http.HttpMethod
• Locale : Locale 정보를 조회한다. (예시: ko-kr, euc-kr 등)
• @RequestHeader MultiValueMap<String, String> headerMap
  ➡️ 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
• @RequestHeader("host") String host
  ➡️ 특정 HTTP 헤더를 조회한다.
  ➡️ 속성
  • 필수 값 여부: required
  • 기본 값 속성: defaultValue
• @CookieValue(value = "myCookie", required = false) String cookie
  ➡️ 특정 쿠키를 조회한다.
  ➡️ 속성
  • 필수 값 여부: required
  • 기본 값 속성: defaultValue

 

출력

2022-01-13 17:39:19.887  INFO 3816 --- [           main] hello.springmvc.SpringmvcApplication     : Started SpringmvcApplication in 4.118 seconds (JVM running for 4.766)
2022-01-13 17:39:32.888  INFO 3816 --- [nio-8080-exec-2] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2022-01-13 17:39:32.889  INFO 3816 --- [nio-8080-exec-2] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2022-01-13 17:39:32.894  INFO 3816 --- [nio-8080-exec-2] o.s.web.servlet.DispatcherServlet        : Completed initialization in 5 ms
2022-01-13 17:39:32.963  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : request=org.apache.catalina.connector.RequestFacade@c63f133
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : response=org.apache.catalina.connector.ResponseFacade@784f4db
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : httpMethod=PATCH
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : locale=ko_KR
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : headerMap={user-agent=[PostmanRuntime/7.28.4], accept=[*/*], postman-token=[535fdef6-68a1-46d5-ae87-ac4e9567229f], host=[localhost:8080], accept-encoding=[gzip, deflate, br], connection=[keep-alive], content-length=[0]}
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : header host=localhost:8080
2022-01-13 17:39:32.967  INFO 3816 --- [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : myCookie=null

 

MultiValueMap

• MAP과 유사한데, 하나의 키에 여러 값을 받을 수 있다.
• HTTP header, HTTP 쿼리 파라미터와 같이 하나의 키에 여러 값을 받을 때 사용한다.
  ➡️ keyA=value1&keyA=value2

MultiValueMap<String, String> map = new LinkedMultiValueMap();
map.add("keyA", "value1");
map.add("keyA", "value2");

//[value1,value2]
List<String> values = map.get("keyA");

 

@Slf4j
다음 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log 라고 사용하면 된다.

private static final org.slf4j.Logger log =
 org.slf4j.LoggerFactory.getLogger(RequestHeaderController.class);

 

💡 참고
@Controller

• 사용 가능한 파라미터 목록 공식 메뉴얼 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- arguments
• 사용 가능한 응답 값 목록 공식 메뉴얼 : https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann- return-types

 

📚 2. HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form

📖 A. HTTP 요청 데이터 조회 - 개요

• HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법을 알아보자
• 클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지를 사용한다.

  (1) GET - 쿼리 파라미터

  • /url?uesrname=hello&age=20
  • 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
  • ex) 검색, 필터, 페이징등에서 많이 사용하는 방식

  (2) POST - HTML Form

  • content-type: application/x-www-form-urlencoded
  • 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
  • ex) 회원 가입, 상품 주문, HTML Form 사용

  (3) HTTP message body에 데이터를 직접 담아서 요청

  • HTTP API에서 주로 사용한다. (JSON, HTML, TEXT)
  • 데이터 형식은 주로 JSON을 사용한다.
  • POST, PUT, PATCH

 

📖 B. 요청 파라미터 - 쿼리 파라미터, HTML Form

• HTTP 요청 메세지를 개발자가 사용하기 편하게 변환해 제공하는 것이 HttpServletRequest 객체이다.
• 이 객체내의 getParameter()를 이용하면 요청 파라미터를 조회할 수 있는데, queryString으로 요청 메세지를 전달하는 것은 GET, 쿼리파라미터 전송과 POST HTML Form 전송 방식이다.

 

(1) GET, 쿼리 파라미터 전송

ex)
http://localhost:8080/request-param?username=hello&age=20

(2) POST, HTML Form 전송

ex)

POST /request-param ...
content-type: application/x-www-form-urlencoded

username=hello&age=20

• GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘다 형식이 같으므로 getParameter() 메서드를 통해 구분없이 조회할 수 있다.
• 이는 요청 파라미터(request parameter)조회 라고 한다.

 

📖 C. 스프링으로 요청 파라미터를 조회하는 방법

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

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


@Slf4j
@Controller
public class RequestParamController {

    @RequestMapping("/request-param-v1")
    public void requestParamV1(HttpServletRequest request, HttpServletResponse response) throws IOException {
        String username = request.getParameter("username");
        int age = Integer.parseInt(request.getParameter("age"));
        log.info("username={}, age={}", username, age);

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

    }
}

• request.getParameter() : HttpServletRequest가 제공하는 방식으로 요청 파라미터를 조회한다.
• 반환 타입이 없으면서 응답에 값을 직접 입력("ok")하면 view 조회를 할 수 없다.

 

GET 실행
http://localhost:8080/request-param-v1?username=hello&age=20

 

POST Form 페이지 생성

테스트용 HTML Form
리소스는 resources/static 아래에 두면 스프링 부트가 자동으로 인식한다.

 

main/resources/static/basic/hello-form.html

<!DOCTYPE html>
<html>
<head>

    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form action="/request-param-v1" method="post">
    username: <input type="text" name="username" /> age: <input type="text" name="age" /> <button type="submit">전송</button>
</form>
</body>
</html>

 

Post Form 실행
http://localhost:8080/basic/hello-form.html

 

💡 참고
Jar를 사용하면 webapp 경로를 사용할 수 없다. 이제부터 정적 리소스도 클래스 경로에 함께 포함해야 한다.

 

📚 3. HTTP 요청 파라미터 - @RequestParam

스프링이 제공하는 @RequestParam을 사용하면 요청 파라미터를 매개변수 레벨에서 더 빠르게 바로 꺼내서 사용할 수 있다.

 

RequestParamController.requestParamV2

    /**
     * @RequestParam 사용
     * - 파라미터 이름으로 바인딩
     * @ResponseBody 추가
     * - View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력
     * */
    @ResponseBody
    @RequestMapping("/request-param-v2")
    public String requestParamV2(
            @RequestParam("username") String memberName,
            @RequestParam("age") int memberAge
    ){
        log.info("username={}, age={}", memberName, memberAge);
        return "ok";
    }

• @RequestParam("username") : 파라미터 이름으로 바인딩
• @ResponseBody
  ➡️ View 조희를 무시하고, HTTP message body에 직접 해당 내용 입력
  ➡️ 클래스 레벨에서 @Controller를 사용하는 경우 메서드레벨에서 해당 애노테이션을 사용해서 메세지 바디에 직접 내용 입력하는 것이 가능하다.

 

@RequestParam의 name(value) 속성이 파라미터 이름으로 사용

• @RequestParam("username")String memberName
  → request.getParameter("username")

 

RequestParamController.requestParamV3

    /**
     * @RequestParam 사용
     * HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam(name="xx") 생략 가능
     * */

    @ResponseBody
    @RequestMapping("/request-param-v3")
    public String requestParamV3(
            @RequestParam String username,
            @RequestParam int age
    ){
        log.info("username={}, age={}", username, age);
        return "ok";
    }

• HTTP 파라미터 이름이 변수 이름과 같을 경우 파라미터 속성 생략이 가능하다.
  ➡️ @RequestParam("username) String username" → @RequestParam String username

 

RequestParamController.requestParamV4

    /**
     * @RequestParam 사용
     * String, int 등의 단순 타입이면 @RequestParam 도 생략 가능 
     * */
    @ResponseBody
    @RequestMapping("/request-param-v4")
    public String requestParamV4(String username, int age){
        log.info("username={}, age={}", username, age);
        return "ok";
    }

• String, int, Integer등의 단순 타입이면 @RequestParam도 생략 가능하다.

 

⚠️ 주의
@RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false를 적용한다.

💡 참고
이렇게 애노테이션을 완전히 생략해도 되는데, 너무 없는 것도 약간 과하다는 주관적 생각이 있다.
@RequestParam이 있으면 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있다.

 

(1) 파라미터 필수 여부 - requestParamRequired

/**
     * @RequestParam.required
     * /request-param -> username이 없으므로 예외 *
     * 주의!
     * /request-param?username= -> 빈문자로 통과 *
     * 주의!
     * /request-param
     * int age -> null을 int에 입력하는 것은 불가능, 따라서 Integer 변경해야 함(또는 다음에 나오는
    defaultValue 사용) */
    @ResponseBody
    @RequestMapping("/request-param-required")
    public String requestParamRequired(
            @RequestParam(required = true) String username,
            @RequestParam(required = false) Integer age){
        // int a = null; // 오류
        // Integer b = null; // null이 들어갈 수 있다.
        log.info("username={}, age={}", username, age);
        return "ok";
    }

• @RequestParam.required
  ➡️ 파라미터 필수 여부
  ➡️ 기본 값이 파라미터 필수(true)이다.
• /request-param 요청
  ➡️ username이 없으므로 400 예외가 발생한다.
• /request-param?username=
  ➡️ 파라미터 이름만 있고 값이 없는 경우
  ➡️ 빈문자로 통과
• /request-param 요청
  ➡️ @RequestParam(required = false) int age
  ➡️ 기본형(primitive)에 null 입력
  ➡️ null을 int에 입력하는 것은 불가능(500 예외 발생)
  ➡️ 따라서 null을 받을 수 있는 Integer로 변경하거나, 또는 다음에 나오는 defaultValue 사용

 

(2) 기본 값 적용 - requestParamDefault

    /**
     * @RequestParam
     * - defaultValue 사용 *
     * 참고: defaultValue는 빈 문자의 경우에도 적용 * /request-param?username=
     */
    @ResponseBody
    @RequestMapping("/request-param-default")
    public String requestParamDefault(
            @RequestParam(required = true, defaultValue = "guest") String username,
            @RequestParam(required = false, defaultValue = "-1") Integer age){
        // int a = null; // 오류
        // Integer b = null; // null이 들어갈 수 있다.
        log.info("username={}, age={}", username, age);
        return "ok";
    }

• 파라미터가 없는 경우 기본 값으로 설정한 값이 적용된다.
• 이미 기본 값이 있기 때문에 required는 의미가 없다. (빼도 된다.)
• 빈 문자("")의 경우에도 설정한 기본 값이 적용된다.
  ➡️ 요청(?age=)을 공백으로 하면 int 기본형이라 null을 받아들일 수 없어 에러가 나타나야 하지만, defaultValue로 설정한 값이 적용되어 age에 -1이 주입된다.

 

(3) 파라미터를 Map으로 조회하기 - requestParamMap

/**
     * @RequestParam Map, MultiValueMap
     * Map(key=value)
     * MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])
     */
    @ResponseBody
    @RequestMapping("/request-param-map")
    public String requestParamMap(@RequestParam Map<String, Object> paramMap){
        log.info("username={}, age={}", paramMap.get("username"), paramMap.get("age"));
        return "ok";
    }

파라미터를 Map, MultiValueMap으로 조회할 수 있다.

• @RequestParam Map
  ➡️ Map(key=value)
• @RequestParam MultiValueMap
  ➡️ MultiValueMap(key=[value1, value2, ...] ex) (key=userIds, value=[id1, id2])

 

파라미터의 값이 1개가 확실하다면 Map을 사용해도 되지만, 그렇지 않다면 MultiValueMap을 사용하자!

 

📚 4. HTTP 요청 파라미터 - @ModelAttribute

• 이전까지 @RequestParam을 사용하여 요청 파라미터를 하나씩 받아주었다.
• 애노테이션을 이용해 최대한 편하게 받아주었지만, 요청 파라미터가 하나의 객체가 되어야 하는 경우 각각 파라미터 요청을 조회해서 객체에 값을 넣어서 생성해주는 작업을 해야하기 때문에 번거롭다.

• @RequestParam을 이용한 객체 HelloData객체 생성

    @ResponseBody
    @RequestMapping("/model-attribute-v1")
    public String modelAttributeV1(@RequestParam String username, @RequestParam int age){
        HelloData helloData = new HelloData();
        helloData.setUsername(username);
        helloData.setAge(age);

        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        log.info("helloData={}", helloData);
        return "ok";

    }

➡️ 요청 파라미터가 많아질수록 코드는 길어지고 오류의 확률이 높다.

 

이러한 번거로운 부분을 자동화해주는 애노테이션을 스프링에서 제공한다 : @ModelAttribute

 

HelloData 요청 파라미터를 바인딩 받을 객체

package hello.springmvc.basic;
  import lombok.Data;
  @Data
  public class HelloData {
      private String username;
      private int age;
}

• 롬복 @Data
  ➡️ @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor, 생성자를 자동으로 적용해준다.

 

📖 A. @ModelAttribute 적용 - modelAttributeV1

    /*
     * @ModelAttribute 사용
     * 참고: model.addAttribute(helloData) 코드도 함께 자동 적용됨, 뒤에 model을 설명할 때 자세히 설명
     */
    @ResponseBody
    @RequestMapping("/model-attribute-v1")
    public String modelAttributeV1(@ModelAttribute HelloData helloData) {


        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        log.info("helloData={}", helloData);
        return "ok";

    }

• HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어가 있다.
• ?username=lee&age=20 이라는 쿼리스트링을 담아서 요청을 하면 바로 HelloData 객체에 담겨서 사용할 수 있는 것을 확인할 수 있다.
• 만약 나이(age) 필드에 숫자가 아닌 문자(age=hello)를 넣으려하면 BindException이 발생하는데 이런 바인딩 오류를 처리하는 부분은 검증 부분에서 다룬다.

스프링 MVC는 @ModelAttribute가 있으면 다음을 실행한다.
(1) HelloData 객체를 생성한다.
(2) 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩)한다.
ex) 파라미터 이름이 username이면 setUsername() 메서드를 찾아 호출하면서 값을 입력한다.

 

📖 B. 프로퍼티

객체에 getUsername(), setUsername() 메서드가 있으면, 이 객체는 username이라는 프로퍼티를 가지고 있다.
username 프로퍼티의 값을 변경하면 setUsername()이 호출되고, 조회하면 getUsername()이 호출된다.

class HelloData {
      getUsername();
      setUsername();
}

 

📖 C. 생략 가능한 @ModelAttribute 애노테이션

    /**
     * @ModelAttribute 생략 가능
     * String, int 같은 단순 타입 = @RequestParam
     * argument resolver 로 지정해둔 타입 외 = @ModelAttribute
     * */
    @ResponseBody
    @RequestMapping("/model-attribute-v2")
    public String modelAttributeV2(HelloData helloData) {
        
        log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
        log.info("helloData={}", helloData);
        return "ok";

    }

• @ModelAttribute는 생략할 수 있는데 @RequestParam도 생략할 수 있다.
• 현재 HelloData에서 어떤 애노테이션이 생략된 건지 판단하려면?
• 스프링은 해당 생략시 다음과 같은 규칙을 적용한다.
  ➡️ String, int, Integer 같은 단순 타입 = @RequestParam
  ➡️ 나머지 = @ModelAttribute(argument resolver로 지정해둔 타입은 제외)

 

💡 참고
argument resolver는 뒤에서 학습한다.

 

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

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

 

HTTP message body에 데이터를 직접 담아서 요청

• HTTP API에서 주로 사용, JSON, XML, TEXT
• 데이터 형식은 주로 JSON 사용
• POST, PUT, PATCH

 

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

 

📖 A. 단순 텍스트 전송

• 먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자!
• HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다.

 

RequestBodyStringController

@Slf4j
@Controller
public class RequestBodyStringController {

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

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

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

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

 

Postman을 사용해서 테스트

• POST http://localhost:8080/request-body-string-v1
• Body → row, Text 선택

 

Input, Output 스트림, Reader - RequestBodyStringController.requestBodyStringV2

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

    /**
     * InputStream(Reader): HTTP 요청 메시지 바디의 내용을 직접 조회
     * OutputStream(Writer): HTTP 응답 메시지의 바디에 직접 결과 출력
     * */
    @PostMapping("/request-body-string-v2")
    public void requestBodyStringV2(InputStream inputStream, Writer responseWriter) throws IOException{
        String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

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

        responseWriter.write("ok");
    }

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

 

RequestBodyStringController.requestBodyStringV3 - HttpEntity

/**
     * HttpEntity: HTTP header, body 정보를 편라하게 조회
     * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
     * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
     * 
     * 응답에서도 HttpEntity 사용 가능
     * - 메시지 바디 정보 직접 반환(view 조회X)
     * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
     */
    @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<>("ok");
    }

• HttpEntity: HTTP header, body 정보를 편리하게 조회할 수 있다.
  ➡️ 메시지 바디 정보를 직접 조회
  ➡️ 요청 파라미터를 조회하는 기능과 관계가 없다. (@RequestParam X, @ModelAttribute X)

• HttpEntity는 응답에서도 사용 가능
  ➡️ 메시지 바디 정보 직접 반환
  ➡️ 헤더 정보 포함 가능
  ➡️ View 조회 불가능

 

HttpEntity를 상속받은 다음 객체들도 같은 기능을 제공한다.
(1) RequestEntity

• HttpMethod, url 정보가 추가, 요청에 사용
  (2) ResponseEntity
• HTTP 상태 코드 설정 가능, 응답에서 사용
• return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED)

 

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

 

RequestBodyStringController.requestBodyStringV4 - @RequestBody

/**
     * @RequestBody
     * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
     * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
     *
     * @ResponseBody
     * - 메시지 바디 정보 직접 반환(view 조회X)
     * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
     * */

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


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

        return "ok";
    }

@RequestBody
➡️ @RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.
➡️ 참고로 헤더 정보가 필요하다면 HttpEntity를 사용하거나 @RequestHeader 를 사용하면 된다.
➡️ 이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttibute와는 전혀 관계가 없다.

 

요청 파라미터 vs HTTP 메시지 바디

• 요청 파라미터를 조회하는 기능: @RequestParam , @ModelAttribute
• HTTP 메세지 바디를 직접 조회하는 기능: @RequestBody

 

@ResponseBody

• @ResponseBody 를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다.
• 물론 이 경우에도 view를 사용하지 않는다.

 

📚 6. HTTP 요청 메시지 - JSON

• HTTP 요청 메시지 바디에는 JSON이 주로 사용된다.
• JSON 데이터 형식을 조회해보자.

JSON

{
	"username":"chang",
	"age":20
}

Object

@Data
public class HelloData{
	private String username;
	private int age;
}

 

📖 A. 소스

RequestBodyJsonController.requestBodyJsonV1

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

package hello.springmvc.basic.request;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpEntity;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

/**
 * {"username":"hello", "age":20}
 * content-type: application/json
 */
@Slf4j
@Controller
public class RequestBodyJsonController {

    private ObjectMapper objectMapper = new 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("username={}, age={}", helloData.getUsername(), helloData.getAge());

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

• HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
• 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper를 사용해서 자바 객체로 변환한다.

 

Postman으로 테스트

• POST http://localhost:8080/request-body-json-v1
• raw, JSON, content-type: application/json
• {"username":"hello", "age":20}

 

처리해야할 기본 로직이 상당히 많으며 JSON을 받아서 사용해야할 컨트롤러가 많을수록 코드 중복이 많아질 수 밖에 없는 상황이다.

 

RequestBodyJsonController.requestBodyJsonV2 - @RequestBody 문자 변환

@RequestBody 애노테이션을 이용해 메시지 바디를 바로 받아서 사용하면 InputStream을 꺼내서 StreamUtils로 변환해줄 필요 없이 바로 ObjectMapper로 객체 변환할 수 있다.

/**
     * @RequestBody
     * HttpMessageConverter 사용 -> StringHttpMessageConverter 적용 *
     * @ResponseBody
     * - 모든 메서드에 @ResponseBody 적용
     * - 메시지 바디 정보 직접 반환(view 조회X)
     * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
     * */
    @ResponseBody
    @PostMapping("/request-body-json-v2")
    public String requestBodyJsonV2(@RequestBody String messageBody) throws IOException {

        log.info("messageBody={}", messageBody);
        HelloData helloData = objectMapper.readValue(messageBody, HelloData.class);
        log.info("username=P{}, age={}", helloData.getUsername(), helloData.getAge());

        return "ok";
    }

• 이전에 학습했던 @RequestBody를 사용해서 HTTP 메시지에 데이터를 꺼내고 messageBody에 저장한다.
• 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해서 자바 객체로 변환한다.

 

문자로 변환하고 다시 json으로 변환하는 과정이 불편하다. @ModelAttribute처럼 한번에 객체로 변환할 수는 없을까?

 

RequestBodyJsonController.requestBodyJsonV3 - @RequestBody 객체 변환

/**
     * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
     * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-
    type: application/json)
     *
     */
    @ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData helloData){

        log.info("username=P{}, age={}", helloData.getUsername(), helloData.getAge());

        return "ok";
    }

@RequestBody 객체 파라미터

• @RequestBody HelloData data
• @RequestBody 에 직접 만든 객체를 지정할 수 있다.

 

• HttpEntity, @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.
• HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 우리가 방금 V2에서 했던 작업을 대신 처리해준다.
• 자세한 내용은 뒤에 HTTP 메시지 컨버터에서 다룬다.

 

@RequestBody는 생략 불가능
스프링은 @ModelAttribute, @RequestParam 생략 시, 다음과 같은 규칙을 적용한다.

• String , int , Integer 같은 단순 타입 = @RequestParam
• 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)

 

➡️ 따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.
➡️ HelloData data → @ModelAttribute HelloData data
➡️ 따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

 

⚠️ 주의

• Content-type은 application/json이어야 한다.
• HTTP 요청시에 content-type이 application/json인지 꼭! 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다.

 

RequestBodyJsonController.requestBodyJsonV4 - HttpEntity

앞서 배운 것과 같이 HttpEntity를 사용해도 된다.

    @ResponseBody
    @PostMapping("/request-body-json-v4")
    public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity){

        HelloData data = httpEntity.getBody();
        log.info("username=P{}, age={}", data.getUsername(), data.getAge());

        return "ok";
    }

 

RequestBodyJsonController.requestBodyJsonV5

 /**
     * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
     * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (content-
    type: application/json)
     *
     * @ResponseBody 적용
     * - 메시지 바디 정보 직접 반환(view 조회X)
     * - HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter 적용
    (Accept: application/json)
     */
    @ResponseBody
    @PostMapping("/request-body-json-v5")
    public HelloData requestBodyJsonV5(@RequestBody HelloData data){

        log.info("username=P{}, age={}", data.getUsername(), data.getAge());

        return data;
    }

@ResponseBody
➡️ 응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다.
➡️ 물론 이 경우에도 HttpEntity 를 사용해도 된다.
➡️ V5가 애노테이션을 최대한 활용하였고, V1보다 훨씬 간결해진 코드가 완성된다.

 

@RequestBody 요청
➡️ JSON 요청 → HTTP 메시지 컨버터 → 객체
@ResponseBody 응답
➡️ 객체 → HTTP 메시지 컨버터 → JSON 응답

 

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

• 응답 데이터는 이미 앞에서 일부 다룬 내용들이지만, 응답 부분에 초점을 맞추어서 정리해보자.
• 스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.

 

(1) 정적 리소스

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

(2) 뷰 템플릿 사용

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

(3) HTTP 메시지 사용

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

 

📖 A. 정적 리소스

• 스프링 부트는 클래스패스의 다음 디렉토리에 있는 정적 리소스를 제공한다.
• /static , /public , /resources , /META-INF/resources

 

(1) src/main/resources

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

 

(2) 정적 리소스 경로 예시

src/main/resources/static일 때,
➡️ src/main/resources/static/basic/hello-form.html 경로에 파일이 들어 있으면
➡️ http://localhost:8080/basic/hello-form.html 이와 같이 웹 브라우저에서 실행하면 된다.

화면와 같이 하위에 있는 html 파일이 컨트롤러를 통하지 않고 바로 실행할 수 있다.

(웹 브라우저에서 컨트롤러를 통하지 않고 정적리소스 경로 뒤의 경로를 입력해 바로 가져올 수 있다.)

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

 

📖 B. 뷰 템플릿

• 뷰 템플릿을 거쳐서 HTML이 생성되고, 뷰가 응답을 만들어서 전달한다.
• 일반적으로 HTML을 동적으로 생성하는 용도로 사용하지만, 다른 것들도 가능하다.
• 뷰 템플릿이 만들 수 있는 것이라면 뭐든지 가능하다.
• 스프링 부트는 기본 뷰 템플릿 경로를(src/main/resources/templates) 제공한다.

 

(1) 뷰 템플릿 경로 및 생성

뷰 템플릿 경로 : 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>

 

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 mav = new ModelAndView("response/hello").addObject("data", "hello!");

    return mav;
}

// @ResponseBody를 사용후 String 반환시 문자가 그냥 반환된다.
@RequestMapping("/response-view-v2")
public String responseViewV2(Model model){
    model.addAttribute("data", "hello2");

    return "response/hello";
    // ""이면서 string일시 view의 논리적 이름으로 반환된다.
}


@RequestMapping("/response/hello")
public void responseViewV3(Model model){
    model.addAttribute("data", "hello3");

}

}

> **(1) ModelAndView를 반환하는 경우(responseViewV1)**
> ➡️ 객체에서 View를 꺼내어 물리적인 뷰 이름으로 완성한 뒤 뷰를 찾아 렌더링을 한다.
>
> **(2) String을 반환하는 경우 - View or HTTP 메시지(responseViewV2)**
> ➡️ `@ResponseBody`(혹은 클래스 레벨에서 `@RestController`)가 없으면 `response/hello`라는 문자가 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링을 한다.
> ➡️ `@ResponseBody`(혹은 클래스 레벨에서 `@RestController`)가 있으면 뷰 리졸버를 실행하지 않고 HTTP 메시지 바디에 직접 `response/hello`라는 문자가 입력된다.
> ➡️ 여기서는 뷰의 논리 이름인 `response/hello` 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.
> * 실행 : `templates/response/hello.html`
>
> **(3) Void를 반환하는 경우(responseViewV3)**
> ➡️ `@Controller` 를 사용하고, `HttpServletResponse` , `OutputStream(Writer)` 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용한다.
>   * 요청 URL: `/response/hello` 
>   * 실행: `templates/response/hello.html`
> ➡️ **참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다.**

 

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

 

## 📖 C. Thymeleaf 스프링 부트 설정
> 이미 프로젝트 생성시점에서 Thymeleaf 라이브러리를 추가해놓았다.

 

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

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

application.properties

# 이 설정은 기본 값 이기 때문에 변경이 필요할 때만 설정하면 된다.

spring.thymeleaf.prefix=classpath:/templates/
spring.thymeleaf.suffix=.html

 

💡 참고

• 스프링 부트의 타임리프 관련 추가 설정은 다음 공식 사이트를 참고하자. (페이지 안에서 thymeleaf 검색)
• https://docs.spring.io/spring-boot/docs/2.4.3/reference/html/appendix-application- properties.html#common-application-properties-templating

 

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

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

 

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

 

📖 A. 소스

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 org.springframework.web.bind.annotation.RestController;

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

@Slf4j
//@Controller
//@ResponseBody
@RestController
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")
    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;
    }
}

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

(2) responseBodyV2
➡️ ResponseEntity 엔티티는 HttpEntity 를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.
➡️ ResponseEntity 는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다. → return new ResponseEntity<>(helloData, HttpStatus.OK);

(3) responseBodyV3
➡️ @ResponseBody 를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.
➡️ ResponseEntity 도 동일한 방식으로 동작한다.

(4) responseBodyJsonV1
➡️ ResponseEntity 를 반환한다.
➡️ HTTP 메시지 컨버터를 통해서 JSON 형식으로 변환되어서 반환된다.

(5) responseBodyJsonV2
➡️ ResponseEntity 는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody 를 사용하면 이런 것을 설정하기 까다롭다.
➡️ @ResponseStatus(HttpStatus.OK) 애노테이션을 사용하면 응답 코드도 설정할 수 있다.
➡️ 물론 애노테이션이기 때문에 응답 코드를 동적으로 변경할 수는 없다.
➡️ 프로그램 조건에 따라서 동적으로 변경하려면 ResponseEntity 를 사용하면 된다.

 

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

 

📚 9. HTTP 메시지 컨버터

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

 

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

@ResponseBody를 사용

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

 

💡 참고
응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보 둘을 조합해서 HttpMessageConverter 가 선택된다. 더 자세한 내용은 스프링 MVC 강의에서 설명하겠다.

&npbs;

📖 A. 스프링 MVC, HTTP 메시지 컨버터

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

• HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
• HTTP 응답: @ResponseBody , 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 메시지 컨버터는 HTTP 요청, HTTP 응답 둘 다 사용된다.
➡️ 요청 시 : json → 객체
➡️ 응답 시 : 객체 → JSON

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

 

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

0 = ByteArrayHttpMessageConverter
1 = StringHttpMessageConverter
2 = MappingJackson2HttpMessageConverter

스프링 부트는 다양한 메시지 컨버터를 제공하는데, 대상 클래스 타입과 미디어 타입 둘을 체크해서 사용여부를 결정한다. 만약 만족하지 않으면 다음 메시지 컨버터로 우선순위가 넘어간다.

 

중요한 메시지 컨버터
(1) ByteArrayHttpMessageConverter : byte[] 데이터를 처리한다.
➡️ 클래스 타입: byte[] , 미디어타입: */*
➡️ 요청 예) @RequestBody byte[] data
➡️ 응답 예) @ResponseBody return byte[] 쓰기 미디어타입 application/octet-stream

(2) StringHttpMessageConverter : String 문자로 데이터를 처리한다.
➡️ 클래스 타입: String , 미디어타입: */*
➡️ 요청 예) @RequestBody String data
➡️ 응답 예) @ResponseBody return "ok" 쓰기 미디어타입 text/plain

(3) MappingJackson2HttpMessageConverter : application/json
➡️ 클래스 타입: 객체 또는 HashMap , 미디어타입 application/json 관련
➡️ 요청 예) @RequestBody HelloData data
➡️ 응답 예) @ResponseBody return helloData 쓰기 미디어타입 application/json 관련

 

📖 C. HTTP 요청 데이터 읽기

StringHttpMessageConverter

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

MappingJackson2HttpMessageConverter

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


 content-type: text/html

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

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 응답 메시지 바디에 데이터를 생성한다.

 

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

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

SpringMVC 구조

• 스프링 MVC의 구조를 보면 HTTP 요청부터 응답까지 여러 과정을 거쳐서 결과가 응답되는데, HTTP 메시지 컨버터는 어디서 사용되는 것일까?
• 모든 비밀은 애노테이션 기반의 컨트롤러, 그러니까 @RequestMapping 을 처리하는 핸들러 어댑터인 RequestMappingHandlerAdapter (요청 매핑 헨들러 어뎁터)에 있다.

 

RequestMappingHandlerAdapter 동작 방식

 

📖 A. ArgumentResolver

• 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다.
• HttpServletRequest, Model와 @RequestParam, @ModelAttribute 같은 애노테이션이나 @RequestBody, HttpEntity같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
• 이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.
• 애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdaptor 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.
• 그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.
• 스프링은 30개가 넘는 ArgumentResolver 를 기본으로 제공한다.

 

어떤 종류들이 있는지 살짝 코드로 확인만 해보자.

 

💡 참고

• 가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
• https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-arguments

 

(1) 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로 우선순위가 넘어간다.

또한, 직접 인터페이스를 확장해서 원하는 ArgumentResolver를 만들 수도 있다.

 

📖 B. ReturnValueHandler

• HandlerMethodReturnValueHandler 를 줄여서 ReturnValueHandle 라 부른다.
• ArgumentResolver 와 비슷한데, 이것은 응답 값을 변환하고 처리한다.
• 컨트롤러에서 String으로 뷰 이름을 반환해도, 동작하는 이유가 바로 ReturnValueHandler 덕분이다.

 

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

• 예) ModelAndView , @ResponseBody , HttpEntity , String

 

💡 참고

• 가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있다.
• https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

 

📖 C. HTTP 메시지 컨버터

HTTP 메시지 컨버터 위치

HTTP 메시지 컨버터는 어디쯤 있을까?

(1) HTTP 메시지 컨버터를 사용하는 @RequestBody 도 컨트롤러가 필요로 하는 파라미터의 값에 사용된다.
➡️ 요청의 경우 : @RequestBody 를 처리하는 ArgumentResolver 가 있고, HttpEntity 를 처리하는 ArgumentResolver 가 있다. 이 ArgumentResolver 들이 HTTP 메시지 컨버터를 사용해서 필요한 객체를 생성하는 것이다.

(2) @ResponseBody 의 경우도 컨트롤러의 반환 값을 이용하므로 그 시점에서 HTTP 메시지 컨버터는 이용된다.
➡️ 응답의 경우 : @ResponseBody 와 HttpEntity 를 처리하는 ReturnValueHandler 가 있다. 그리고 여기에서 HTTP 메시지 컨버터를 호출해서 응답 결과를 만든다.

 

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

 

💡 참고
HttpMessageConverter 를 구현한 클래스를 한번 확인해보자.

 

(1) 확장

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

• HandlerMethodArgumentResolver
• HandlerMethodReturnValueHandler
• HttpMessageConverter

 

• 스프링이 필요한 대부분의 기능을 제공하기 때문에 실제 기능을 확장할 일이 많지는 않다.
• 기능 확장은 WebMvcConfigurer 를 상속 받아서 스프링 빈으로 등록하면 된다.
• 실제 자주 사용하지는 않으니 실제 기능 확장이 필요할 때 WebMvcConfigurer 를 검색해보자.

 

WebMvcConfigurer 확장

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

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

 

---

참고

• https://catsbi.oopy.io/84f908e6-3a2e-42ef-8106-05728ae8447b