쌩로그

스프링 MVC 1편 - Ch06. 스프링 MVC - 기본 기능 본문

Spring/Spring & Spring Boot

스프링 MVC 1편 - Ch06. 스프링 MVC - 기본 기능

.쌩수. 2024. 4. 16. 22:11
반응형

목록

  1. 포스팅 개요
  2. 본론
      2-1. 로깅 간단히 알아보기
      2-2. 요청 매핑
      2-3. 요청 매핑 - API 예시
      2-4. HTTP 요청 - 기본, 헤더 조회
      2-5. HTTP 요청 파라미터 - 쿼리 파라미터, HTML Form
      2-6. HTTP 요청 파라미터 - @RequestParam
      2-7. HTTP 요청 파라미터 - @ModelAttribute
      2-8. HTTP 요청 메시지 - 단순 텍스트
      2-9. HTTP 요청 메시지 - JSON
      2-10. 응답 - 정적 리소스, 뷰 템플릿
      2-11. HTTP 응답 - HTTP API, 메시지 바디에 직접 입력
      2-12. HTTP 메시지 컨버터
      2-13. 요청 매핑 핸들러 어댑터 구조
  3. 요약

1. 포스팅 개요

인프런에서 영한님의 스프링 MVC 1편 Section 06 스프링 MVC - 기본 기능를 학습하며 정리한 포스팅이다.

다만, 프로젝트 생성 부분은 생략했다.

참고로 JSP를 쓰지않고, Thymeleaf를 사용한다.

dependency는 Lombok, Thymeleaf, Spring Web 을 주입한다.

이번 장에서 학습할 내용을 편리하게 참고하기 위해 Welcome 페이지를 만든다.

스프링 부트에 Jar 를 사용하면 /resources/static/ 위치에 index.html 파일을 두면 Welcome 페이지로 처리해준다.
(스프링 부트가 지원하는 정적 컨텐츠 위치에 /index.html 이 있으면 된다.)

<!DOCTYPE html>  
<html>  
<head>  
    <meta charset="UTF-8">  
    <title>Title</title>  
</head>  
<body>  
<ul>  
    <li>로그 출력  
        <ul>  
            <li><a href="/log-test">로그 테스트</a></li>  
        </ul>    </li>    <!-- -->  
    <li>요청 매핑  
        <ul>  
            <li><a href="/hello-basic">hello-basic</a></li>  
            <li><a href="/mapping-get-v1">HTTP 메서드 매핑</a></li>  
            <li><a href="/mapping-get-v2">HTTP 메서드 매핑 축약</a></li>  
            <li><a href="/mapping/userA">경로 변수</a></li>  
            <li><a href="/mapping/users/userA/orders/100">경로 변수 다중</a></li>  
            <li><a href="/mapping-param?mode=debug">특정 파라미터 조건 매핑</a></li>  
            <li><a href="/mapping-header">특정 헤더 조건 매핑(POST MAN 필요)</a></li>  
            <li><a href="/mapping-consume">미디어 타입 조건 매핑 Content-Type(POST  
                MAN 필요)</a></li>  
            <li><a href="/mapping-produce">미디어 타입 조건 매핑 Accept(POST MAN 필  
                요)</a></li>  
        </ul>    </li>    <li>요청 매핑 - API 예시  
        <ul>  
            <li>POST MAN 필요</li>  
        </ul>    </li>    <li>HTTP 요청 기본  
        <ul>  
            <li><a href="/headers">기본, 헤더 조회</a></li>  
        </ul>    </li>    <li>HTTP 요청 파라미터  
        <ul>  
            <li><a href="/request-param-v1?username=hello&age=20">요청 파라미터 v1</  
                a></li>  
            <li><a href="/request-param-v2?username=hello&age=20">요청 파라미터 v2</  
                a></li>  
            <li><a href="/request-param-v3?username=hello&age=20">요청 파라미터 v3</  
                a></li>  
            <li><a href="/request-param-v4?username=hello&age=20">요청 파라미터 v4</  
                a></li>  
            <li><a href="/request-param-required?username=hello&age=20">요청 파라미  
                터 필수</a></li>  
            <li><a href="/request-param-default?username=hello&age=20">요청 파라미터  
                기본 값</a></li>  
            <li><a href="/request-param-map?username=hello&age=20">요청 파라미터  
                MAP</a></li>  
            <li><a href="/model-attribute-v1?username=hello&age=20">요청 파라미터  
                @ModelAttribute v1</a></li>  
            <li><a href="/model-attribute-v2?username=hello&age=20">요청 파라미터  
                @ModelAttribute v2</a></li>  
        </ul>    </li>    <li>HTTP 요청 메시지  
        <ul>  
            <li>POST MAN</li>  
        </ul>    </li>    <li>HTTP 응답 - 정적 리소스, 뷰 템플릿  
        <ul>  
            <li><a href="/basic/hello-form.html">정적 리소스</a></li>  
            <li><a href="/response-view-v1">뷰 템플릿 v1</a></li>  
            <li><a href="/response-view-v2">뷰 템플릿 v2</a></li>  
        </ul>    </li>    <li>HTTP 응답 - HTTP API, 메시지 바디에 직접 입력  
        <ul>  
            <li><a href="/response-body-string-v1">HTTP API String v1</a></li>  
            <li><a href="/response-body-string-v2">HTTP API String v2</a></li>  
            <li><a href="/response-body-string-v3">HTTP API String v3</a></li>  
            <li><a href="/response-body-json-v1">HTTP API Json v1</a></li>  
            <li><a href="/response-body-json-v2">HTTP API Json v2</a></li>  
        </ul>    </li></ul>  
</body>  
</html>

다음과 같이 나온다.

스프링 부트 Welcome 페이지 지원에 대해서 알려면 다음 링크로 들어가면 된다.

https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#web.servlet.spring-mvc.welcome-page

2. 본론

2-1. 로깅 간단히 알아보기

앞으로 로그를 사용할 것이기 때문에, 이번시간에는 로그에 대해서 간단히 알아본다.

운영 시스템에서는 System.out.println() 같은 시스템 콘솔을 사용해서 필요한 정보를 출력하지 않고, 별도의 로깅 라이브러리를 사용해서 로그를 출력한다.

참고로 로그 관련 라이브러리도 많고, 깊게 들어가면 끝이 없기 때문에, 여기서는 최소한의 사용 방법만 알아본다.

스프링 부트 라이브러리를 사용하면 스프링 부트 로깅 라이브러리(spring-boot-starter-logging)가 함께 포함된다.
스프링 부트 로깅 라이브러리는 기본으로 다음 로깅 라이브러리를 사용한다.

로그 라이브러리는 Logback, Log4J,Log4J2 등등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 바로 SLF4J 라이브러리다.
쉽게 이야기해서 SLF4J는 인터페이스이고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다.
실무에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

로그를 선언하는 방법
로그를 선언하는 방법은 다음과 같다.

  • private Logger log = LoggerFactory.getLogger(getClass());
  • private static final Logger log = LoggerFactory.getLogger(Xxx.class)
  • @Slf4j : 롬복 사용 가능

로그 호출
로그를 호출하는 방법은 다음과 같다.

  • log.info("hello")
  • System.out.println("hello")

코드로 확인해보자.

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RestController;  

@RestController  
public class LogTestController {  

    private final Logger log = LoggerFactory.getLogger(getClass());  

    @RequestMapping("/log-test")  
    public String logTest() {  
        String name = "Spring";  

        System.out.println("name = " + name);  
        log.info(" info log={}", name);  

        return "ok";  
    }  
}

서버 실행 후, localhost:8080에서 로그 테스트를 클릭하면 다음과 같이 확인할 수 있다.

(@RestController를 사용했기 때문에 다음과 같이 나온다.)

출력을 보면 다음과 같다.

name = Spring
2024-04-08T09:03:35.820+09:00  INFO 10840 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  info log=Spring

name = Spring이 System.out.println()으로 찍은 것이고, 그 밑에 내용이 log로 나오는 부분이다.

이처럼 출력하는데 있어서 정보의 량이 다르다.

다음 코드들도 추가해서 확인해보자.

log.trace("trace log={}", name);  
log.debug("debug log={}", name);    
log.info(" info log={}", name);    
log.warn(" warn log={}", name);  
log.error("error log={}", name);

서버 실행 후, 출력 결과는 다음과 같다.

name = Spring
2024-04-08T09:13:15.654+09:00  INFO 2772 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  info log=Spring
2024-04-08T09:13:15.656+09:00  WARN 2772 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  warn log=Spring
2024-04-08T09:13:15.656+09:00 ERROR 2772 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : error log=Spring

현재 trace와 debug 로그는 찍히지 않았다.
이를 설정해줄 수 있는데, application.properties(혹은 yml)에서 다음과 같이 설정해주면 된다.

logging.level.hello.springvmc=trace

이렇게 설정하면 다음과 같이 trace 레벨부터 error 레벨 까지 보여준다.

name = Spring
2024-04-08T09:17:31.003+09:00 TRACE 23116 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : trace log=Spring
2024-04-08T09:17:31.004+09:00 DEBUG 23116 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : debug log=Spring
2024-04-08T09:17:31.004+09:00  INFO 23116 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  info log=Spring
2024-04-08T09:17:31.004+09:00  WARN 23116 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  warn log=Spring
2024-04-08T09:17:31.004+09:00 ERROR 23116 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : error log=Spring

debug로 하면 debug부터 error까지 보여준다.

name = Spring
2024-04-08T09:18:19.657+09:00 DEBUG 30476 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : debug log=Spring
2024-04-08T09:18:19.658+09:00  INFO 30476 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  info log=Spring
2024-04-08T09:18:19.658+09:00  WARN 30476 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  warn log=Spring
2024-04-08T09:18:19.658+09:00 ERROR 30476 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : error log=Spring

그런데 지금 System.out.println()에 해당하는 name = Spring이 계속 찍히고 있다.

실무나 운영에서는 많은 정보들이 로그로 기록되는데, (배달의 민족에서는 수천, 수만 명이 동시에 접속한다고 함.... ㄷㄷ;;)
로그가 많아져도 로그 폭탄을 맞게 된다.
따라서 로그를 출력할 때는 System.out.println()보다 log 라이브러리를 사용해서 로그를 남기는 게 더욱 좋다.

실무에서의 팁으로는
로컬에서는 trace를 , 개발 환경에서는 debug를 운영에서는 info로 설정해서 사용한다고 한다.

참고로 properties에서 해당 설정을 주석처리하고 테스트해보자.

#logging.level.hello.springvmc=debug

서버를 실행하고, 테스트 를 해보면, 

name = Spring
2024-04-08T09:23:58.373+09:00  INFO 36080 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  info log=Spring
2024-04-08T09:23:58.375+09:00  WARN 36080 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      :  warn log=Spring
2024-04-08T09:23:58.375+09:00 ERROR 36080 --- [springvmc] [nio-8080-exec-1] h.springvmc.basic.LogTestController      : error log=Spring

이와 같이 나온다.
info 레벨부터 나오는데, 이는 기본이 info라는 의미다.

만약 기본을 바꾸고 싶다면 아래와 같이 설정하면된다.

#전체 로그 레벨 설정(기본 info) 
logging.level.root=info

위의 값을 info에서 다른 값을 주면 전역적으로 다르게 적용된다.

그리고 컨트롤러에서 로그를 사용하기 위해 다음과 같이 코드를 작성했는데,

private final Logger log = LoggerFactory.getLogger(getClass());

롬복에서 제공하는 애너테이션인 @Slf4j를 사용하면 이를 생략하고 사용할 수 있다.

@Slf4j  
@RestController  
public class LogTestController { ... }

그리고 로그를 사용할 때 올바르게 사용해야 한다.

log.trace("trace log={}", name);  
log.debug("debug log={}", name);  
log.info(" info log={}", name);  
log.warn(" warn log={}", name);  
log.error("error log={}", name);

위와 같이 name을 출력하기 위해 {}를 사용했다.

그런데, 다음 코드를 보자.

log.trace("trace log=" + name);

물론 사용할 수도 있고, 레벨이 trace이기 때문에 trace 레벨에서는 출력된다.

그런데, 위와 같이 사용할 경우 다음과 같은 연산이 일어난다.
참고로 name은 "Spring"이라는 문자열이다.

log.trace("trace log=" + name);     // 연산 전
log.trace("trace log=" + "Spring"); // 연산 1
log.trace("trace log=Spring);       // 연산 2

이처럼 만약 trace 레벨에서 "trace log=Spring"이라는 값이 출력된다고 해보자.
그런데, 로그 레벨은 trace가 찍히지 않는 debug 혹은 info이다.

즉 연산된 문자열은 쓰이지 않는 것이다.

쓰이지는 않지만 계속 연산을 하게 되는데, 이렇게 되면 사용하지도 않는데, 불필요한 리소스를 사용하게 되는 것이다.

그러나, {}를 사용하면 연산이 일어나지 않고, debug나, info일 때 trace라면 연산이 일어나지 않고, 코드를 넘어간다.

로그 사용시 장점

  • 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.
  • 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.
  • 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다. 특히 파일로 남길 때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.
  • 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등을 이용) 그래서 실무에서는 꼭 로그를 사용해야 한다.

로그에 대해서 더 자세한 내용은 slf4j, logback을 검색해보면 된다.

스프링 부트가 제공하는 로그 기능은 다음을 참고하면 된다.

2-2. 요청 매핑

요청 매핑은 단순하게 url 로 매핑하는 것이 아니라, 여러가지 요소들을 가지고 조합해서 매핑하게 된다.

basic.requestmapping 패키지에서 MappingController 클래스를 작성한다.

package hello.springvmc.basic.requestmapping;  

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RestController;  

@RestController  
public class MappingController {  

    private Logger log = LoggerFactory.getLogger(getClass());  

    @RequestMapping("/hello-basic")  
    public String helloBasic() {  
        log.info("helloBasid");  
        return "ok";  
    }  

}

결과는 다음과 같다.

참고로 @RestController는 view가 아니라, ok 라는 문자열을 메시지 바디에 넣어서 반환한다.

그리고 url에 두개를 넣을 수 있다.

@RequestMapping({"/hello-basic", "/hello-gp"})

결과는 아래와 같다.

@RequestMapping은 메서드를 지정하지 않는한 아무 HTTP 메서드로 요청을 보내더라도 받는다.

참고 - 스프링 부트 3.0 이전

다음 두가지 요청은 다른 URL이지만, 스프링은 다음 URL 요청들을 같은 요청으로 매핑한다.

  • 매핑: /hello-basic
  • URL 요청: /hello-basic ,/hello-basic/

- 스프링 부트 3.0 이후

스프링 부트 3.0 부터는 /hello-basic, /hello-basic/ 는 서로 다른 URL 요청을 사용해야 한다.
기존에는 마지막에 있는 / (slash)를 제거했지만, 스프링 부트 3.0 부터는 마지막의 /(slash)를 유지한다.
따라서 다음과 같이 다르게 매핑해서 사용해야 한다.

  • 매핑: /hello-basic -> URL 요청: /hello-basic
  • 매핑: /hello-basic/ -> URL 요청: /hello-basic/

축약

/** 
* 편리한 축약 애노테이션 (코드보기) 
* @GetMapping 
* @PostMapping 
* @PutMapping 
* @DeleteMapping 
* @PatchMapping 
*/ 
@GetMapping(value = "/mapping-get-v2") public String mappingGetV2() { 
    log.info("mapping-get-v2"); 
    return "ok"; 
}

HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이다.
코드를 보면 내부에서 @RequestMapping 과 method 를 지정해서 사용하는 것을 확인할 수 있다.

@GetMapping 예시다.

...
@RequestMapping(  
    method = {RequestMethod.GET}  
)  
public @interface GetMapping {
...
}

PathVariable(경로 변수) 사용

/** 
* PathVariable 사용 
* 변수명이 같으면 생략 가능 
* @PathVariable("userId") String userId -> @PathVariable String userId 
*/ 
@GetMapping("/mapping/{userId}") public String mappingPath(@PathVariable("userId") String data) { 
    log.info("mappingPath userId={}", data); 
    return "ok"; 
}

실행은 다음과 같이 한다.
http://localhost:8080/mapping/userA

최근 HTTP API는 다음과 같이 리소스 경로에 식별자를 넣넣는 스타일을 선호한다.

  • /mapping/userA /users/1

  • /users/1

  • @RequestMapping 은 URL 경로를 템플릿화 할 수 있는데, @PathVariable 을 사용하면 매칭되는 부분을 편리하게 조회할 수 있다.

  • @PathVariable의 이름과 파라미터 이름이 같으면 생략할 수 있다.

(@PathVariable("userId") String userId) 

// 위를 아래와 같이 사용할 수 있다.

(@PathVariable String userId)

PathVariable 사용 - 다중

/** 
* PathVariable 사용 다중 
*/ 
@GetMapping("/mapping/users/{userId}/orders/{orderId}") public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) {
    log.info("mappingPath userId={}, orderId={}", userId, orderId); 
    return "ok"; 
}

실행은 아래와 같은 방식으로 요청할수있다.

  • http://localhost:8080/mapping/users/userA/orders/100

특정 파라미터 조건 매핑

잘 사용하진 않지만, 쿼리 파라미터를 조건에 매핑할 수 있다.

/** 
* 파라미터로 추가 매핑 
* params="mode", 
* params="!mode" 
* params="mode=debug" 
* params="mode!=debug" (! = ) 
* params = {"mode=debug","data=good"} 
*/ 
@GetMapping(value = "/mapping-param", params = "mode=debug") public String mappingParam() { 
    log.info("mappingParam"); 
    return "ok"; 
}

http://localhost:8080/mapping-param?mode=debug 로 실행할 수 있는데,

특정 파라미터가 있거나 없는 조건을 추가할 수 있다.
즉 위와 같은 경우에는 파라미터의 mode에 debug 라는 값이 있어야 한다.

잘 사용하지는 않는다.

파라미터가 조건에 맞으면 잘 응답하지만,

그렇지 않으면 매핑되지 아래와 같이 매핑되지 않는다.

특정 헤더 조건 매핑

/** 
* 특정 헤더로 추가 매핑 
* headers="mode", 
* headers="!mode" 
* headers="mode=debug" 
* headers="mode!=debug" (! = ) 
*/ 
@GetMapping(value = "/mapping-header", headers = "mode=debug") public String mappingHeader() {
    log.info("mappingHeader"); 
    return "ok"; 
}

HTTP 요청의 Content-Type 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 415 상태코드(Unsupported Media Type)을 반환한다.

그냥 매핑하면 아래와 같이 나오지 않지만,

header를 넣어주면 잘 응답한다.

미디어 타입 조건 매핑 - HTTP 요청 Content-Type, consume

스프링 MVC를 사용할 때,
만약 애플리케이션의 컨첸츠 타입이 JSON이라면, 그에 맞게 처리하고,
text/html이라면 또 그에 맞는 적절한 것으로 처리하는 식으로 content-type을 분리할 수 있다.

그런데 이러한 경우에는 headers를 쓰는 것이 아니라, consume을 써야 한다.

왜냐하면 Spring MVC가 내부적으로 consume을 통해 처리하는 것들이 있기 때문이다.

/** 
* Content-Type 헤더 기반 추가 매핑 Media Type 
* consumes="application/json" 
* consumes="!application/json" 
* consumes="application/*" 
* consumes="*\/*" 
* MediaType.APPLICATION_JSON_VALUE 
* */ 
@PostMapping(value = "/mapping-consume", consumes = "application/json") public String mappingConsumes() { 
    log.info("mappingConsumes"); 
    return "ok"; 
}

위의 경우는 애플리케이션의 header의 컨텐트 타입이 JSON이어야 한다.

그냥 이렇게 하면 응답이 제대로 이루어지지 않는다.
따라서 JSON 형태로 보내줘야 한다.

아래는 성공 결과다.

미디어 타입 조건 매핑 - HTTP 요청 Accept, produce

/** 
* Accept 헤더 기반 Media Type 
* produces = "text/html" 
* produces = "!text/html" 
* produces = "text/*" 
* produces = "*\/*" 
*/ @PostMapping(value = "/mapping-produce", produces = "text/html") public String mappingProduces() { 
    log.info("mappingProduces"); 
    return "ok"; 
};

HTTP 요청의 Accept 헤더를 기반으로 미디어 타입으로 매핑한다.
만약 맞지 않으면 HTTP 406 상태코드(Not Acceptable)을 반환한다.

위와 같이 `application/json`으로 Accept를 설정하기 때문에 접근하지 못한다.

참고로 Accept는 클라이언트가 나는 컨텐트 타입이 test/html이라는 걸 받아들일 수 있다. 는 의미다.

최종적인 코드는 다음과 같다.

package hello.springvmc.basic.requestmapping;  

import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
import org.springframework.web.bind.annotation.*;  

@RestController  
public class MappingController {  

    private Logger log = LoggerFactory.getLogger(getClass());  

    @RequestMapping("/hello-basic")  
    public String helloBasic() {  
        log.info("helloBasic");  
        return "ok";  
    }  



    /**  
     * PathVariable 사용  
     * 변수명이 같으면 생략 가능  
     * @PathVariable("userId") String userId -> @PathVariable String userId  
     *///    @GetMapping("/mapping/{userId}") public String mappingPath(@PathVariable String data) { // 이와 같이도 사용할 수 있다.  
    @GetMapping("/mapping/{userId}") public String mappingPath(@PathVariable("userId") String data) {  
        log.info("mappingPath userId={}", data);  
        return "ok";  
    }  



    /**  
     * PathVariable 사용 다중  
     */  
    @GetMapping("/mapping/users/{userId}/orders/{orderId}") public String mappingPath(@PathVariable String userId, @PathVariable Long orderId) {  
        log.info("mappingPath userId={}, orderId={}", userId, orderId);  
        return "ok";  
    }  


    /**  
     * 파라미터로 추가 매핑  
     * params="mode",  
     * params="!mode"     * params="mode=debug"     * params="mode!=debug" (! = )     * params = {"mode=debug","data=good"}     */    @GetMapping(value = "/mapping-param", params = "mode=debug") public String mappingParam() {  
        log.info("mappingParam");  
        return "ok";  
    }  


    /**  
     * 특정 헤더로 추가 매핑  
     * headers="mode",  
     * headers="!mode"     * headers="mode=debug"     * headers="mode!=debug" (! = )     */    @GetMapping(value = "/mapping-header", headers = "mode=debug") public String mappingHeader() {  
        log.info("mappingHeader");  
        return "ok";  
    }  

    /**  
     * Content-Type 헤더 기반 추가 매핑 Media Type  
     * consumes="application/json"     * consumes="!application/json"     * consumes="application/*"     * consumes="*\/*"     * MediaType.APPLICATION_JSON_VALUE     * */    @PostMapping(value = "/mapping-consume", consumes = "application/json") public String mappingConsumes() {  
        log.info("mappingConsumes");  
        return "ok";  
    }  


    /**  
     * Accept 헤더 기반 Media Type  
     * produces = "text/html"     * produces = "!text/html"     * produces = "text/*"     * produces = "*\/*"     */ @PostMapping(value = "/mapping-produce", produces = "text/html") public String mappingProduces() {  
        log.info("mappingProduces");  
        return "ok";  
    };  
}

2-3. 요청 매핑 - API 예시

만약 회원 관리를 HTTP API로 만든다면 어떻게 만들까 생각하면서 매핑을 어떻게 하는지 알아보자.
(실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만 고려한다.)

회원 관리 API

  • 회원 목록 조회: GET /users
  • 회원 등록: POST /users
  • 회원 조회: GET /users/{userId}
  • 회원 수정: PATCH /users/{userId}
  • 회원 삭제: DELETE /users/{userId}

MappingClassController 라는 클래스를 다음과 같이 작성한다.

package hello.springvmc.basic.requestmapping;  

import org.springframework.web.bind.annotation.*;  

@RestController  
public class MappingClassController {  


    @GetMapping("/mapping/users")  
    public String user() {  
        return "get users";  
    }  

    @PostMapping("/mapping/users")  
    public String addUser() {  
        return "post user";  
    }  

    @GetMapping("/mapping/users/{userId}")  
    public String findUser(@PathVariable String userId) {  
        return "get userId=" + userId;  
    }  


    @PatchMapping("/mapping/users/{userId}")  
    public String updateUser(@PathVariable String userId) {  
        return "update userId=" + userId;  
    }  

    @DeleteMapping("/mapping/users/{userId}")  
    public String deleteUser(@PathVariable String userId) {  
        return "delete userId=" + userId;  
    }  

}

포스트맨으로 테스트 해본다.

회원 목록 조회 결과다.

회원 등록 결과다.

회원 조회 결과다.

회원 수정 결과다.

회원 삭제 결과다.

현재 보면 /mapping/users url이 중복되고 있는 것을 볼 수 있다.

이 중복된 url을 클래스레벨의 @RequestMapping에 두고,
메서드레벨의 mapping url에서는 생략가능하다.

package hello.springvmc.basic.requestmapping;  

import org.springframework.web.bind.annotation.*;  

@RestController  
@RequestMapping("/mapping/users")  
public class MappingClassController {  


    @GetMapping  
    public String user() {  
        return "get users";  
    }  

    @PostMapping  
    public String addUser() {  
        return "post user";  
    }  

    @GetMapping("/{userId}")  
    public String findUser(@PathVariable String userId) {  
        return "get userId=" + userId;  
    }  


    @PatchMapping("/{userId}")  
    public String updateUser(@PathVariable String userId) {  
        return "update userId=" + userId;  
    }  

    @DeleteMapping("/{userId}")  
    public String deleteUser(@PathVariable String userId) {  
        return "delete userId=" + userId;  
    }  

}

동작은 이전과 같이 잘 동작한다.

2-4. HTTP 요청 - 기본, 헤더 조회

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

basic/request 패키지에서 RequestHeaderController 클래스를 아래와 같이 작성하자.

package hello.springvmc.basic.request;  

import jakarta.servlet.http.HttpServletRequest;  
import jakarta.servlet.http.HttpServletResponse;  
import lombok.extern.slf4j.Slf4j;  
import org.springframework.cglib.core.Local;  
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 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";  
    }  

}

실행하면 다음과 같다.

http://localhost:8080/headers url로 요청하면, 아래와 같이 나온다.

2024-04-11T22:45:56.874+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : request=org.apache.catalina.connector.RequestFacade@51dbbfb1
2024-04-11T22:45:56.875+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : response=org.springframework.web.context.request.async.StandardServletAsyncWebRequest$LifecycleHttpServletResponse@1d2124c7
2024-04-11T22:45:56.875+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : httpMethod=DELETE
2024-04-11T22:45:56.876+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : locale=ko_KR
2024-04-11T22:45:56.876+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : headerMap={accept=[text/html], content-type=[application/json], user-agent=[PostmanRuntime/7.37.3], cache-control=[no-cache], postman-token=[29b66d88-86b0-4d43-ba26-7b6a01f97121], host=[localhost:8080], accept-encoding=[gzip, deflate, br], connection=[keep-alive], content-length=[16]}
2024-04-11T22:45:56.876+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : header host=localhost:8080
2024-04-11T22:45:56.876+09:00  INFO 8752 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestHeaderController    : myCookie=null
  • HttpServletRequest
  • HttpServletResponse
  • HttpMethod : HTTP 메서드를 조회한다. org.springframework.http.HttpMethod
  • Locale : Locale 정보를 조회한다.
  • @RequestHeader MultiValueMap headerMap
    • 모든 HTTP 헤더를 MultiValueMap 형식으로 조회한다.
  • @RequestHeader("host") String host
    • 특정 HTTP 헤더를 조회한다.
    • 속성
      • 필수 값 여부: required
      • 기본 값 속성: defaultValue
    • @CookieValue(value = "myCookie", required = false) String cookie
      • 특정 쿠키를 조회한다.
      • 속성
        • 필수 값 여부: required
        • 기본 값: defaultValue

MultiValueMap

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

map.add("keyA", "value1"); 
map.add("keyA", "value2"); 

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

@Slf4j

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

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

참고

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

HTTP 요청 데이터 조회 - 개요

HTTP 요청 메시지를 통해 클라이언트에서 서버로 데이터를 전달하는 방법

클라이언트에서 서버로 요청 데이터를 전달할 때는 주로 다음 3가지 방법을 사용한다.

  • GET - 쿼리 파라미터
    • /url?username=hello&age=20
    • 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달
    • 예) 검색 필터, 페이징 등에서 많이 사용하는 방식
  • POST - HTML Form
    • content-type : application/x-www-form-urlencoded
    • 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20
    • 예) 회원 가입, 상품 주문, HTML Form 사용
  • HTTP message body
    • HTTP API에서 주로 사용, JSON, XML, TEXT
    • 데이터 형식은 주로 JSON 사용
    • POST, PUT, PATCH

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

HttpServletRequest 의 request.getParameter() 를 사용하면 다음 두 가지 요청 파라미터를 조회할 수 있다.

GET, 쿼리 파라미터 전송

  • 예시
    • http://localhost:8080/request-param?username=hello&age=20

POST, HTML Form 전송

  • 예시
POST /request-param
content-type: application/x-www-form-urlencoded

username=hello&age=20

GET 쿼리 파라미터 전송 방식이든, POST HTML Form 전송 방식이든 둘 다 형식이 같으므로 구분 없이 조회할 수 있다.

이를 간단히 요청 파라미터(request parameter) 조회라 한다.

스프링으로 요청 파라미터를 조회하는 방법을 단계적으로 알아보자.

springmvc/basic/request 패키지에서 RequestParamController 클래스를 작성한다.

import jakarta.servlet.http.HttpServletRequest;  
import jakarta.servlet.http.HttpServletResponse;  
import lombok.extern.slf4j.Slf4j;  
import org.springframework.stereotype.Controller;  
import org.springframework.web.bind.annotation.RequestMapping;  

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");  

    }  
}

콘솔에 아래와 같은 결과가 나온다.

이번에는 POST 요청을 해보자.

참고로 스프링부트를 사용하면 resources/static 에 있는 파일들은 외부로 다 공개가 된다.
그렇기 때문에 index.html도 공개가 되는 것이다.

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>

서버를 재실행하고, http://localhost:8080/basic/hello-form.html 경로로 들어가자.

다음과 같이 나온다.

아래와 같이 값을 넣고 전송한다.

로그에 다음과 같이 찍힌다.

2024-04-14T21:38:44.765+09:00  INFO 20216 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestParamController     : username = kim, age = 123

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

2-6. HTTP 요청 파라미터 - @RequestParam

스프링이 제공하는 @RequestParam 을 사용하면 요청 파라미터를 매우 편리하게 사용할 수 있다.

RequestParamController 에서 requestParamV2 를 작성해보자.

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

String 타입으로 이렇게 반환하면, ViewResolver가 "ok"라는 view를 찾지만,
@ResponseBody 애너테이션을 위에 두면, 메세지 바디로 들어간다.

즉, 클래스 레벨에 @RestController를 둔 것과 같은 효과를 가져온다.

  • @RequestParam: 파라미터 이름으로 바인딩
  • @ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용 입력

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

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

그리고 RequestParam으로 받는 key 와 변수명이 같으면 name 속성을 생략할 수 있다.

requestParamV3 을 작성해보자.

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

PathVariable과 똑같은 매커니즘이다.

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

requestParamV4 메서드이다.

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

주의

@RequestParam 애노테이션을 생략하면 스프링 MVC는 내부에서 required=false 를 적용한다. required 옵션은 바로 다음에 설명한다.

참고

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

주의! 스프링 부트 3.2 파라미터 이름 인식 문제

다음 예외가 발생하면 해당 내용을 참고하자.

발생하는 예외

java.lang.IllegalArgumentException: Name for argument of type [java.lang.String] not specified, and parameter name information not found in class file either.

스프링 부트 3.2부터 자바 컴파일러에 -parameters 옵션을 넣어주어야 애너테이션에 적는 이름을 생략할 수 있다.

주로 다음 두 애너테이션에서 문제가 발생한다.

  • @RequestParam
  • @PathVariable

@RequestParam 관련

//애노테이션에 username이라는 이름이 명확하게 있다. 문제 없이 작동한다. @RequestMapping("/request") 
public String request(@RequestParam("username") String username) { 
... 
} 

//애노테이션에 이름이 없다. -parameters 옵션 필요 
@RequestMapping("/request") 
public String request(@RequestParam String username) {
... 
} 

//애노테이션도 없고 이름도 없다. -parameters 옵션 필요 
@RequestMapping("/request") 
public String request(String username) { 
... 
}

@PathVariable 관련(이후에 학습한다)

//애노테이션에 userId라는 이름이 명확하게 있다. 문제 없이 작동한다. 
public String mappingPath(@PathVariable("userId") String userId) { 
... 
} 

//애노테이션에 이름이 없다. -parameters 옵션 필요 

@RequestMapping("/request") 
public String request(@RequestParam String username) { 
... 
}

  • 해결 방안1(권장)

    • 애노테이션에 이름을 생략하지 않고 다음과 같이 이름을 항상 적어준다. 이 방법을 권장한다.
    • @RequestParam("username") String username

  • 해결 방안2

    • 컴파일 시점에 -parameters 옵션 적용
        1. IntelliJ IDEA에서 File -> Settings를 연다. (Mac은 IntelliJ IDEA Settings)
        1. Build, Execution, Deployment → Compiler → Java Compiler로 이동한다.
        1. Additional command line parameters라는 항목에 다음을 추가한다.
          • -parameters
        1. out 폴더를 삭제하고 다시 실행한다. 꼭 out 폴더를 삭제해야 다시 컴파일이 일어난다.

  • 해결 방안3

    • Gradle을 사용해서 빌드하고 실행한다.

문제 원인

참고로 이 문제는 Build, Execution, Deployment -> Build Tools ->Gradle에서 Build and run using를 IntelliJ IDEA로 선택한 경우에만 발생한다.
Gradle로 선택한 경우에는 Gradle이 컴파일 시점에 해당 옵션을 자동으로 적용해준다.

자바를 컴파일할 때 매개변수 이름을 읽을 수 있도록 남겨두어야 사용할 수 있다. 컴파일 시점에 -parameters 옵션 을 사용하면 매개변수 이름을 사용할 수 있게 남겨둔다.

스프링 부트 3.2 전까지는 바이트코드를 파싱해서 매개변수 이름을 추론하려고 시도했다.
하지만 스프링 부트 3.2 부터 는 이런 시도를 하지 않는다.

파라미터 필수 여부 - requestParamRequired

파라미터의 필수 여부를 다음과 같이 설정할 수 있다.

@ResponseBody  
@RequestMapping("/request-param-required")  
public String requestParamRequired(  
        @RequestParam(required = true) String username,  
        @RequestParam(required = false) Integer age) {  
    log.info("username={}, age={}", username, age);  
    return "ok";  
}

  • @RequestParam.required

    • 파라미터 필수 여부
    • 기본값이 파라미터 필수( true )이다.

  • /request-param-required 요청

    • username 이 없으므로 400 예외가 발생한다.

주의! - 파라미터 이름만 사용

  • /request-param-required?username=
  • 침고로 위와 같이 파라미터 이름만 있고 값이 없는 경우 빈문자로 통과한다.

주의! - 기본형(primitive)에 null 입력

  • 위의 코드에서 Integer age를 int age로 변경한 경우
  • /request-param 요청
  • @RequestParam(required = false) int age

이처럼 age가 없다.

따라서 Integer로 받는 것이 안전하다.

null 을 int 에 입력하는 것은 불가능(500 예외 발생)하다.
따라서 null 을 받을 수 있는 Integer 로 변경하거나, 또는 다음에 나오는 defaultValue를 사용하면 된다.

기본 값 적용 - requestParamDefault

@ResponseBody  
@RequestMapping("/request-param-default")  
public String requestParamDefault(  
        @RequestParam(required = true, defaultValue = "guest") String username,  
        @RequestParam(required = false, defaultValue = "-1") int age) {  
    log.info("username={}, age={}", username, age);  
    return "ok";  
}
  • username이 없으면, "guest"
  • age가 없으면 -1

로 값을 넣겠다는 의미다.

위처럼 age를 뺘고 요청을 넣으면 age에 -1이 들어간다. (아래)

파라미터에 값이 없는 경우 defaultValue 를 사용하면 기본 값을 적용할 수 있다.
이미 기본 값이 있기 때문에 required 는 의미가 없다.

defaultValue는 빈 문자의 경우에도 설정한 기본 값이 적용된다.

  • /request-param-default?username=

위와 같이 빈 문자열을 주었는데,
아래와 같이 "guest"로 나온다.

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

@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 을 사용하자.

  • 예시
    • username=kim&username=park

참고

파라미터의 값은 보통 하나를 쓴다. 애매하게 두 개를 쓰는 경우는 그렇게 많지 않다.
라고 하신다.

2-7. HTTP 요청 파라미터 - @ModelAttribute

실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고 그 객체에 값을 넣어주어야 한다.
스프링은 이 과정을 완전히 자동화해주는 @ModelAttribute 기능을 제공한다.

요청 파라미터를 바인딩 받을 객체를 만들자.

springmvc/basic 패키지에 HelloData 클래스를 만들자.

package hello.springvmc.basic;  

import lombok.Data;  

@Data  
public class HelloData {  

    private String username;  
    private int age;  
}
  • 롬복 @Data
    • @Getter , @Setter , @ToString, @EqualsAndHashCode , @RequiredArgsConstructor 를 자동으로 적용해준다.

RequestParam 클래스에 다음과 같은 코드를 작성한다.

@ModelAttribute 적용 - modelAttributeV1

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

    return "ok";  
}

서버 실행후, 다음과 같은 url에 요청을 보내면, 다음과 같이 나온다.

http://localhost:8080/model-attribute-v1?username=a&age=10

로그 드를 추가해서 확인해보자.

...

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

return "ok";

서버를 재실행해서 확인해보면 다음과 같이 나온다.

2024-04-14T22:30:27.311+09:00  INFO 12888 --- [springvmc] [nio-8080-exec-2] h.s.b.request.RequestParamController     : username=a, age=10

참고로 @Data르는 애너테이션을 사용했기 때문에, 아래처럼 사용할 수 있다.

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

그런데, Model을 사용하면 다음과 같이 코드를 줄일 수 있다.

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


// 아래처럼 바뀜.
@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 = HelloData(username=a, age=10)

마치 마법처럼 HelloData 객체가 생성되고, 요청 파라미터의 값도 모두 들어가 있다.
스프링MVC는 @ModelAttribute 가 있으면 다음을 실행한다.

  • HelloData 객체를 생성한다.
  • 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩) 한다.
  • 예) 파라미터 이름이 username 이면 setUsername() 메서드를 찾아서 호출하면서 값을 입력한다.

프로퍼티

객체에 getUsername() ,setUsername() 메서드가 있으면, 이 객체는 username 이라는 프로퍼티를 가지고 있다.

username 프로퍼티의 값을 변경하면 setUsername() 이 호출되고, 조회하면 getUsername() 이 호출된다. 

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

바인딩 오류

age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException이 발생한다.

참고로 이런 바인딩 오류를 처리하는 방법은 검증 부분에서 다룬다.

참고로 의아했던 건 BindException 이 아니라, MethodArgumentNotValidException 이 나왔는데,
커뮤니티 글에서 다음과 같은 답변을 주셨다.

영한님 말대로 BindException을 상속받고 있다!!

@ModelAttribute 생략 - modelAttributeV2

ModelAttribute 는 다음과 같이 생략할 수 있다.

@ResponseBody  
@RequestMapping("/model-attribute-v2")  
public String modelAttributeV2(HelloData helloData) {  
    log.info("username={}, age={}", helloData.getUsername(),  
            helloData.getAge());  
    return "ok";  
}

서버를 재실행하고 해당 url로 위와 같이 요청했다.
그럼 아래와 같이 잘 나온다.

이처럼 @ModelAttribute 는 생략할 수 있다.
그런데 @RequestParam 도 생략할 수 있으니 혼란이 발생할 수 있다.

스프링은 해당 생략시 다음과 같은 규칙을 적용한다.

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

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

argument resolver 예시는 아래와 같다.

2-8. HTTP 요청 메시지 - 단순 텍스트

요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam , @ModelAttribute 를 사용할 수 없다. (물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.)

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

springvmc.basic.request 패키지에서 RequestBodyStringController 클래스를 작성하자.


import jakarta.servlet.ServletInputStream;  
import jakarta.servlet.http.HttpServletRequest;  
import jakarta.servlet.http.HttpServletResponse;  
import lombok.extern.slf4j.Slf4j;  
import org.springframework.stereotype.Controller;  
import org.springframework.util.StreamUtils;  
import org.springframework.web.bind.annotation.PostMapping;  

import java.io.IOException;  
import java.nio.charset.StandardCharsets;  

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

스트림은 항상 bytecode다.

bytecode로 문자를 받을 때는 어떤 인코딩으로 문자를 바꿀건지 항상 지정해줘야 한다.
만약 지정을 하지않으면 그냥 디폴트를 사용한다.
(디폴트는, OS에 기본 설정된 거라던가, Java를 실행할 때 기본으로 뜨는 것을 의미한다.)

포스트맨을 이용해서 요청을 보낸다.

아래와 같이 응답이 왔다.

로그는 다음과 같다.

2024-04-14T22:59:39.975+09:00  INFO 26284 --- [springvmc] [nio-8080-exec-1] h.s.b.r.RequestBodyStringController      : messageBody = hello

이제 V2를 만들어보자.
참고로 스프링 매뉴얼을 확인해보면, 파라미터로 InputStream과 Reader 타입을 받을 수 있다.

또한, OutputStream과 Writer 타입을 받을 수 있다.

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

V1 보다 더욱 간결해졌다.

위처럼 요청을 보내면,
아래와 같이 응답을 받는다.

그러면 로그에 다음과 같이 남는다.

스프링 MVC는 다음 파라미터를 지원한다.

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

스트림을 일일이 넣는 코드가 사실 귀찮다.
그런데 이런 코드를 우리가 작성하지 않아도 알아서 스프링이 해준다.

그게 바로 HTTP 메세지 컨버터라는 기능인데, 자세한 건 추후에 보고,
일단 스프링이 이러한 기능을 제공해준다는 것을 알아보자.

V3 버전

@PostMapping("/request-body-string-v3")  
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) {  
    String messageBody = httpEntity.getBody();  
    log.info("messageBody={}", messageBody);  
    return new HttpEntity<>("ok");  
}

HttpEntity 의 제너릭이 문자열인 것을 보고, httpBody에 있는 데이터를 문자로 변환해주는 HttpMessageConverter라는 것이 동작한다.
그리고 httpBody에 있는 데이터를 문자로 변환해서 messageBody에 넣는다.

위와 같이 요청을 보내면,
아래와 같은 결과가 나온다.

로그는 다음과 같다.

스프링 MVC는 다음 파라미터를 지원한다.

  • HttpEntity: HTTP header, body 정보를 편리하게 조회한다.
    • 메시지 바디 정보를 직접 조회
    • 요청 파라미터를 조회하는 기능과 관계 없다. @RequestParam X, @ModelAttribute X
  • HttpEntity는 응답에도 사용 가능하다.
    • 메시지 바디 정보 직접 반환한다.
    • 헤더 정보 포함 가능하다.
    • view를 조회하지는 않는다.(당연히)

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

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

      참고

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

이것은 조금 뒤에 HTTP 메시지 컨버터에서 자세히 설명한다.

@RequestBody - requestBodyStringV4

V3보다 더욱 더 간결하게 @ResponseBody 와 @RequestBody 를 사용할 수 있다.

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

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

위와 같이 요청을 보내면, 아래와 같이 응답이 온다.

로그는 다음과 같다.

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

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

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

@ResponseBody

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

2-9. HTTP 요청 메시지 - JSON

이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회한다.

기존 서블릿에서 사용했던 방식과 비슷하게 시작해서 점진적으로 발전되는 것을 보자.

springvmc.basic.request 패키지에서 RequestBodyJsonController 를 작성한다.

import com.fasterxml.jackson.databind.ObjectMapper;  
import hello.springvmc.basic.HelloData;  
import jakarta.servlet.ServletInputStream;  
import jakarta.servlet.http.HttpServletRequest;  
import jakarta.servlet.http.HttpServletResponse;  
import lombok.extern.slf4j.Slf4j;  
import org.springframework.stereotype.Controller;  
import org.springframework.util.StreamUtils;  
import org.springframework.web.bind.annotation.PostMapping;  

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

포스트맨으로 확인한다.

header에서 content-type이 application/json으로 되어있는지 확인하자.

위와 같이 요청을 보내면, 아래와 같은 결과가 나온다.

로그는 다음과 같다.

이를 더욱 더 간결하게 하면 다음과 같다.

@ResponseBody  
@PostMapping("/request-body-json-v2")  
public String requestBodyJsonV2(@ResponseBody String messageBody) throws IOException {  

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

    return "OK";  

}

한번 더 발전시켜서 V3로 바꾸면 다음과 같다.
V3는 ObjectMapper로 굳이 바꿔주지 않아도 된다.

@ResponseBody  
@PostMapping("/request-body-json-v3")  
public String requestBodyJsonV3(@RequestBody HelloData helloData) throws IOException {  

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

    return "OK";  
}

결과는 다음과 같다.

위와 같이 요청을 보내면, 아래와 같은 결과가 나온다.

로그는 다음과 같다.

@RequestBody

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

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

@RequestBody는 생략 불가능
@ModelAttribute 에서 학습한 내용을 떠올려보자.
스프링은 @ModelAttribute , @RequestParam 과 같은 해당 애노테이션을 생략시 다음과 같은 규칙을 적용한다.

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

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

주의

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

requestBodyJsonV4 - HttpEntity

HttpEntity를 사용해보자.

@ResponseBody  
@PostMapping("/request-body-json-v4")  
public String requestBodyJsonV4(HttpEntity<HelloData> httpEntity) {  
    HelloData data = httpEntity.getBody();  
    log.info("username= {}, age = {}", data.getUsername(), data.getAge());  
    return "OK";  
}

위와 같이 반환타입을 String이 아니라, 데이터가 들어온대로 반환을 할 수 있다.

@ResponseBody  
@PostMapping("/request-body-json-v5")  
public HelloData requestBodyJsonV5(@RequestBody HelloData data) {  
    log.info("username= {}, age = {}", data.getUsername(), data.getAge());  
    return data;  
}

HttpMessageConverter가 들어올 때도 적용되지만, 나갈 떄도 적용된다.

@ResponseBody
응답의 경우에도 @ResponseBody 를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다.
물론 이 경우에도 HttpEntity 를 사용해도 된다.

  • @RequestBody 요청
    • JSON 요청 -> HTTP 메시지 컨버터 -> 객체
      @ResponseBody응답
      객체 -> HTTP 메시지 컨버터 -> JSON 응답

참고로 요청 헤더에서 JSON으로 요청할 때 Accept에서 application/json으로 되어있는지 확인해야 한다.
Accept 가 클라이언트를 받아들일 수 있는 응답 타입인데 어떤 메세지 컨버터를 선택할지에 영향을 주는 요소이다.

2-10. 응답 - 정적 리소스, 뷰 템플릿

스프링(서버)에서 응답 데이터를 만드는 방법은 크게 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

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>

위 html을 사용하는 Controller를 만들어보자.

springvmc.basic.response 패키지에서 ResponseViewController 클래스를 작성하자.

import org.springframework.stereotype.Controller;  
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;  
    }  

}

결과는 다음과 같다.

페이지 소스는 다음과 같다.

html의 p 태그 부분이 변경되어있다.

이번에는 String을 반환하는 V2를 만들어보자. 

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

경로의 이름과 html 파일의 경로가 똑같다.
따라서 return이 없어도 된다.

결과는 다음과 같다.

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

@ResponseBody 가 없으면 response/hello 로 뷰 리졸버가 실행되어서 뷰를 찾고, 렌더링 한다.
@ResponseBody 가 있으면 뷰 리졸버를 실행하지 않고, HTTP 메시지 바디에 직접 response/hello 라는 문자가 입력된다.

여기서는 뷰의 논리 이름인 response/hello 를 반환하면 다음 경로의 뷰 템플릿이 렌더링 되는 것을 확인할 수 있다.

  • 실행: `templates/response/hello.html

Void를 반환하는 경우

  • @Controller 를 사용하고, HttpServletResponse , OutputStream(Writer) 같은 HTTP 메시지 바디를 처리하는 파라미터가 없으면 요청 URL을 참고해서 논리 뷰 이름으로 사용
    • 요청 URL: /response/hello
    • 실행: templates/response/hello.html
  • 참고로 이 방식은 명시성이 너무 떨어지고 이렇게 딱 맞는 경우도 많이 없어서, 권장하지 않는다.

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

Thymeleaf 스프링 부트 설정

다음 라이브러리를 추가하면(이미 추가되어 있다.)
build.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

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

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

참고

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

springmvc.basic.response 패키지에서 ResponseDodyController 클래스를 작성하자.

import hello.springvmc.basic.HelloData;  
import jakarta.servlet.http.HttpServletResponse;  
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 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");  
    }  

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

    //=======위에까지는 문자열 처리 =======//    //=======아래부터는 JSON 처리 =======//  

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

}

  • responseBodyV1

    • 서블릿을 직접 다룰 때 처럼 HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok 응답 메시지를 전달한다.
    • response.getWriter().write("ok")

  • 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 를 사용하면 된다.

  • @RestController

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

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

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

    • 참고로 @ResponseBody 는 클래스 레벨에 두면 전체 메서드에 적용되는데, @RestController 에노테이션 안에 @ResponseBody 가 적용되어 있다. (아래 참고)

        package org.springframework.web.bind.annotation;  

  import java.lang.annotation.Documented;  
  import java.lang.annotation.ElementType;  
  import java.lang.annotation.Retention;  
  import java.lang.annotation.RetentionPolicy;  
  import java.lang.annotation.Target;  
  import org.springframework.core.annotation.AliasFor;  
  import org.springframework.stereotype.Controller;  

  @Target({ElementType.TYPE})  
  @Retention(RetentionPolicy.RUNTIME)  
  @Documented  
  @Controller     // controller
  @ResponseBody   // responseBody
  public @interface RestController {  
      @AliasFor(  
          annotation = Controller.class  
      )  
      String value() default "";  
  }

서버 실행 후 매핑 결과는 아래와 같다.

2-12. HTTP 메시지 컨버터

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

스프링 입문 강의에서 설명했던 내용 중에 있는 내용 중 @ResponseBody 사용 원리 내용이다.

  • @ResponseBody 를 사용
    • HTTP의 BODY에 문자 내용을 직접 반환한다.
    • viewResolver 대신에 HttpMessageConverter 가 동작한다.
    • 기본 문자처리: StringHttpMessageConverter
    • 기본 객체처리: MappingJackson2HttpMessageConverter (더 많은 것들이 있다.)
    • byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있다.

참고로 응답의 경우 클라이언트의 HTTP Accept 해더와 서버의 컨트롤러 반환 타입 정보들을 조합해서 HttpMessageConverter 가 선택된다.

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

  • HTTP 요청: @RequestBody , HttpEntity(RequestEntity)
    • 그림에서 Controller가 호출되기 전 HttpMessageConverter가 적용되서 @RequestBody가 있으면, HttpMessageBody의 데이터를 꺼내서 변환한 다음 객체든 스트링이든, 데이터를 넘겨준다.
  • HTTP 응답: @ResponseBody , HttpEntity(ResponseEntity)
    • 응답의 경우 @ResponseBody, HttpEntity(ResponseEntity) 가 있으면 HttpMessageConverter를 적용한다.

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

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

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

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

SpringBoot는 기본적으로 메세지 컨버터를 Spring Boot에 올라올 때 몇 개를 등록해놓는다.
컨버터는 다음과 같다. (참고로 일부 생략되었다.)

0 = ByteArrayHttpMessageConverter 
1 = StringHttpMessageConverter 
2 = MappingJackson2HttpMessageConverter

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

미디어 타입은 Http의 요청에서 content-type을 말한다.
예를 들면, text/html 혹은 application/json 과 같은 것이 있다.

몇가지 주요한 메시지 컨버터는 다음과 같다.

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

HTTP 메시지에 body 데이터가 있으면 항상 그 컨텐츠 타입을 지정해 줘야 한다!

StringHttpMessageConverter

content-type: application/json 

@RequestMapping void hello(@RequestBody String data) {}

MappingJackson2HttpMessageConverter

content-type: application/json 


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

?

content-type: text/html 

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

HTTP 요청 데이터 읽기(예시)

  • HTTP 요청이 오고, 컨트롤러에서 @RequestBody , HttpEntity 파라미터를 사용한다.
  • 메시지 컨버터가 메시지를 읽을 수 있는지 확인하기 위해 canRead() 를 호출한다.(위에서 봤던 메세지 컨버터 우선순위대로 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 응답 메시지 바디에 데이터를 생성한다.

2-13. 요청 매핑 핸들러 어댑터 구조

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

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

컨트롤러에서 메서드들을 보면, 많은 데이터 타입을 파라미터로 받고 있는데,
과연 메서드에 어떻게 파라미터들이 잘 들어갈까?
누군가 던져주고 있는데, ArgumentResolver가 이러한 데이터들을 준다.

RequestMappingHandlerAdapter 동작 방식

생각해보면, 애노테이션 기반의 컨트롤러는 매우 다양한 파라미터를 사용할 수 있었다. HttpServletRequest,Model, @RequestParam , @ModelAttribute 같은 애노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함을 보여주었다.
이렇게 파라미터를 유연하게 처리할 수 있는 이유가 바로 ArgumentResolver 덕분이다.

애노테이션 기반 컨트롤러를 처리하는 RequestMappingHandlerAdapter 는 바로 이 ArgumentResolver 를 호출해서 컨트롤러(핸들러)가 필요로 하는 다양한 파라미터의 값(객체)을 생성한다.
그리고 이렇게 파리미터의 값이 모두 준비되면 컨트롤러를 호출하면서 값을 넘겨준다.

참고로 스프링은 30개가 넘는 ArgumentResolver를 기본으로 제공한다.

참고로 가능한 파라미터 목록은 다음 공식 문서에서 확인할 수 있다.

다음 그은 HandlerMethodArgumentResolver 인터페이스이다.

그리고 구현체가 많음을 확인할 수 있다.

동작 방식

ArgumentResolver 의 supportsParameter() 를 호출해서 해당 파라미터를 지원하는지 체크하고,
지원하면 resolveArgument() 를 호출해서 실제 객체를 생성한다.
그리고 이렇게 생성된 객체가 컨트롤러 호출시 넘어가는 것이다.

그리고 원한다면 직접 이 인터페이스를 확장해서 원하는 ArgumentResolver 를 만들 수도 있다.
실제 확장 하는 예제는 향후 로그인 처리에서 진행하겠다.

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

아래에는 구현체 예시다.

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

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

참고 가능한 응답 값 목록은 다음 공식 문서에서 확인할 수 있다.

HTTP 메시지 컨버터

![[Pasted image 20240416071556.png]]

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

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

위의 그림을 보면 HttpEntityMethodProcessor 의 부모를 따라가다보면, HandlerMethodArgumentResolver 가 나온다.

즉, HttpEntity를 처리하는 argument-reserver인 것이다.

이 클래스를 내부적으로 보다면, 읽을 수 있는지 canRead() 메서드가 있고, 그리고, read() 메서드로 처리하는 메서드들이 나와있다.

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

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

다음은 RequestResponseBodyMethodProcessor의 다이어그램이다.

이처럼 @RequestBody @ResponseBody를 한 번에 처리할 수 있는 핸들러들을 같이 가지고 있다.

확장

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

  • HandlerMethodArgumentResolver
  • HandlerMethodReturnValueHandler
  • HttpMessageConverter

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

실제 자주 사용하지는 않으나, 실제 기능 확장이 필요할 때 WebMvcConfigurer 를 상속받아서 확장하면 된다.

예를 들면 다음과 같다.

@Bean 
public WebMvcConfigurer webMvcConfigurer() { 
    return new WebMvcConfigurer() { 
        @Override 
        public void addArgumentResolvers(List resolvers) { 
        //... 
        } 
        @Override 
        public void extendMessageConverters(List> converters) { 
        //... 
        } 
    }; 
}

3. 요약

저번 스프링의 구조 이해에 이어서 이번에는 스프링이 제공하는 기본기능들을 알아보았다.

로그도 로그지만,
Controller 계층의 요청과 응답에 대한 동작방식에 대한 해부 수준이었다.

물론 조금더 살펴보고 싶은 흥미로운 내용이 있었지만, 일단 나중으로 미루고,
실무적으로 컨트롤러 계층에서 사용하는 내용들을 자세히 살펴보았던 거 같다.

로그도 실무적으로 어떻게 찍도록 해야되는지 꿀팁을 얻었다.. ㅎㅎ

다음 스프링 MVC 1편 포스팅은 스프링 MVC 1편의 마지막 세션이다.

-끝-

728x90
저작자표시

'Spring > Spring & Spring Boot' 카테고리의 다른 글

스프링 MVC 2편 - Ch01. 타임리프 - 기본기능  (1) 2024.05.01
스프링 MVC 1편 - Ch07. 스프링 MVC - 웹 페이지 만들기  (1) 2024.04.19
스프링 MVC 1편 - Ch05. 스프링 MVC - 구조 이해  (0) 2024.04.08
스프링 MVC 1편 - Ch04. MVC 프레임워크 만들기  (1) 2024.03.28
스프링 MVC 1편 - Ch03. 서블릿, JSP, MVC 패턴  (0) 2024.03.22
'Spring/Spring & Spring Boot' Related Articles more
Comments