스프링 MVC - 기본 기능

공부/Spring

스프링 MVC - 기본 기능

Stair 2025. 3. 20. 17:15

https://surrealcode.tistory.com/129

스프링 MVC - 구조 이해

https://surrealcode.tistory.com/128 MVC 프레임워크 만들기프론트 컨트롤러 패턴 소개https://surrealcode.tistory.com/127 서블릿, JSP, MVC 패턴간단한 웹 애플리케이션을 만들어 보도록 하자.서블릿으로 만든 후 J

surrealcode.tistory.com

스프링 MVC의 기본 기능을 알아보기 전에 스프링MVC의 구조에 대해 숙지하여 보자.

우선 새로 프로젝트를 하나 생성한다.

https://start.spring.io/

War 대신 Jar를 선택해주어야 한다.

Jar를 사용하면 항상 내장 서버(톰캣등)을 사용하고 'webapp' 경로도 사용하지 않는다.. 내장 서버 사용에 최적화 되어있는 기능이다. 최근에는 주로 이 방식을 사용한다.

War를 사용하면 내장 서버도 사용가능 하지만, 주로 외부 서버에 배포하는 목적으로 사용합니다.

이제 Welcome 페이지를 만들 것이다.

스프링 부트에 Jar를 사용하면 /resources/static/index.html 위치에 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>

정상적으로 html이 출력되는 것을 볼 수 있다.

로깅 간단히 알아보기

앞으로 로그를 사용할 것이기 떄문에, 로그에 대해서 알아보자.

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

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

*로깅 라이브러리*

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

SLF4J - http://www.slf4j.org

Logback = http://logback.qos.ch

로그 라이브러리는 Logback, Log4J, Log4J2등 수 많은 라이브러리가 있는데, 그것을 통합해서 인터페이스로 제공하는 것이 SJF4J 라이브러리이다.

쉽게 이야기해서 SLF4J는 인터페이스고, 그 구현체로 Logback 같은 로그 라이브러리를 선택하면 된다.

실부에서는 스프링 부트가 기본으로 제공하는 Logback을 대부분 사용한다.

패키지는 다음과 같다

//@Controller
@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.trace("trace log={}", name);
        log.debug("debug log={}", name);
        log.info("info log={}", name);
        log.warn("warn log={}", name);
        log.error("error log={}", name);

        return "ok";
    }

}

매핑 정보

- @RestController

- @Controller는 반환값이 String이면 뷰 이름으로 인식이 된다. 따라서 뷰를 찾고 뷰가 렌더링 된다.

- @RestController는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다. 따라서 실행 결과로 ok 메시지를 받을 수 있다. @ResponseBody와 관련이 있다.

테스트

- 로그가 출력되는 포멧 확인

- 시간, 로그 레벨, 프로세스 ID, 쓰레드 명, 클래스명, 로그 메시지 등이 출력 된다.

2025-03-18T09:38:10.272+09:00 INFO 13336 --- [springmvc] [nio-8080-exec1] h.springmvc.basic.LogTestController : info log=Spring

- 로그도 중요도에 따라 분류되며 레벨이 존재한다. SLF4J의 레벨은 다음과 같다

- Level : TRACE > DEBUG > INFO > WARN > ERROR > FATAL

- 보통 개발 서버는 debug를 출력하고, 운영 서버는 info를 출력한다.

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

를 대신하는 어노테이션이 존재하는데 @Slf4j이다. 위와 똑같은 기능을 하기 때문에 둘 중 하나만 쓰여야한다.

@Slf4j
@RestController
public class LogTestController {

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

        System.out.println("name = " + name);

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

        return "ok";
    }

}

System.out.println은 무조건 출력이 되는 것이다. 개발 서버에 이런 저런걸 남길 수 있지만 운영 서버에서는 남기면 안된다. 그렇기에 배포시엔 sout보다 logger의 레벨을 잘 조정해서 사용해야 한다.

application.properties에서 전체 로그 레벨을 설정하거나, 패키지를 지정하여 그 하위 로그의 레벨을 설정해줄수도 있다.

logging.level.root=info
logging.level.hello.springmvc=debug

logging.level.root = info

- 로그 레벨을 info로 설정

logging.level.hello.springmvc=debug

- #hello.springmvc 패키지와 그 하위 로그 레벨 설정

또한 로그를 사용하는 사용 방법 또한 중요하다.

/**
 * 문자열 더하기 연산이 일어나는 것이 문제이다.
 * debug 레벨일 떄 출력을 하지도 않는데, 더하기 연산이 일어나며 쓸모없는 메모리 낭비가 일어난다.
 */
log.trace("trace my log=" + name); //사용 금지
log.trace("trace log={}", name); //파라미터만 넘김

log.trace("trace my log=" + name); 처럼 문자열 더하기를 하여 로그를 출력하여도 trace레벨이라면 출력이 되기는 한다.

하지만 로그 레벨을 info로 설정해도 해당 코드에 있는 "trace my log=" + name의 문자열 더하기가 실행이 되어 버린다. 결과적으로 쓸모 없는 메모리 낭비가 일어난다.

log.trace("trace log={}", name);은 로그 출력 레벨을 info로 설정하면 아무 일도 발생하지 않는다. 따라서 문자열 더하기와 같은 의미없는 연산이 발생하지 않는다.

*로그 사용시 장점*

- 쓰레드 정보, 클래스 이름 같은 부가 정보를 함께 볼 수 있고, 출력 모양을 조정할 수 있다.

- 로그 레벨에 따라 개발 서버에서는 모든 로그를 출력하고, 운영 서버에서는 출력하지 않는 등 로그를 상황에 맞게 조절할 수 있다.

- 시스템 아웃 콘솔에만 출력하는 것이 아니라, 파일이나 네트워크 등, 로그를 별도의 위치에 남길 수 있다. 특히 파일로 남길때는 일별, 특정 용량에 따라 로그를 분할하는 것도 가능하다.

- 성능도 일반 System.out보다 좋다. (내부 버퍼링, 멀티 쓰레드 등등) 그래서 실무에서는 꼭 로그를 사용해야 한다.

요청 매핑

MappingController라는 클래스를 하나 만들어보자. 패키지는 다음과 같다.

기본적이였던 요청을 확인해보자.

@Slf4j
@RestController
public class MappingController {

    /**
     * 기본 요청
     */
    @RequestMapping(value = {"/hello-basic", "/hello-go"}) //URL을 가지고 매핑
    public String helloBasic() {
        log.info("helloBasic");
        return "ok";
    }
}

매핑정보

- @RestController

- @Controller는 반환 값이 String이면 뷰 이름으로 인식된다. 그래서 뷰를 찾고 뷰가 렌더링 된다.

- @RequestMapping("/hello-basic")

- /hello-basic URL 호출이 오면 이 메서드가 실행되도록 매핑한다.

- 대부분의 속성을 배열로 제공하므로 다중 설정이 가능하다. {"/hello-basic","/hello-go"}

*스프링 부트 3.0 이전에는 URL 요청 끝에 슬래쉬가 들어가도 매핑이 되었으나, 3.0 이후부터는 /를 넣으면 절대 안된다.

따라서 다음과 같이 다르게 매핑해서 사용해야 한다.

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

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

HTTP 메서드

@RequestMapping에 method 속성으로 HTTP 메서드를 지정해주지 않으면, HTTP 메서드와 무관하게 호출 된다. 따라서 @RequestMapping을 사용한다면 method 지정을 해주자.

/**
 * method 특정 HTTP 메서드 요청만 허용
 * GET, HEAD, POST, PUT, PATCH, DELETE
 */
@RequestMapping(value = "/mapping-get-v1", method = RequestMethod.GET)
public String mappingGetV1() {
    log.info("mapping-get-v1");
    return "ok";
}

현재 /mapping-get-v1은 GET 메서드이다 만약 Postman으로 POST를 요청한다면 405 에러 코드를 반환한다.

HTTP 메서드 매핑 축약

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

@RequestMapping에 method를 일일히 지정해 주는것은 매우 불편하다. HTTP 메서드를 축약한 애노테이션을 사용하는 것이 더 직관적이고 깔끔하다. 그래서 @GetMapping등과 같은 편리한 축약 애노테이션이 나타나게 되었다.

@GetMapping의 내부 코드를 보면 method를 지정해서 사용하고 있는 것을 확인할 수 있다.

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

PathVariable(경로 변수) 사용

    /**
     * PathVariable 사용 (경로변수)
     * 변수명이 같으면 생략 가능
     * @PathVariable("userId") String userId -> @PathVariable userId
     * /mapping/userA
     */
    @GetMapping("/mapping/{userId}")
    public String mappingPath(@PathVariable("userId") String data) {
        log.info("mappingPath userId={}", data);
        return "ok";
    }
    
/**
위 코드와 아래의 코드는 동일한 결과를 나타낸다.
*/
    
    
    
    /**
 * PathVariable 사용 (경로변수)
 * 변수명이 같으면 생략 가능
 * @PathVariable("userId") String userId -> @PathVariable userId
 * /mapping/userA
 */
@GetMapping("/mapping/{userId}")
public String mappingPath(@PathVariable String userId) {
    log.info("mappingPath userId={}", userId);
    return "ok";
}

최근 HTTP API에서는 위처럼 리소스 경로에 식별자를 넣는 스타일을 선호한다.

- /mapping/userA

- /users/1

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

- @PathVariable의 이름과 파라미터 이름이 같으면 생략 또한 가능하다.

Postman으로 확인해보자.

PathVariable 사용 - 다중

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

스프링 부트에서는 @PathVariable을 여러개 사용하여 URL에서 여러 값을 추출할수도 있다.

URL에 경로 변수가 두개이고 변수 이름에 맞게 파라미터를 넣어주도록 하자.

postman을 찔러보면 다음과 같은 결과와 로그값이 나온다.

2025-03-18T13:05:35.229+09:00 INFO 12528 --- [springmvc] [nio-8080-exec-5] h.s.b.requestmapping.MappingController : mapping userId=userA, orderId=123

특정 파라미터 조건 매핑

/**
 * 파라미터로 추가 매핑
 * 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";
}

@GetMapping에 params 속성을 지정하면, 특정 요청 파라미터(Query Parameter)가 있는 경우에만 매핑되도록 설정할 수 있다.

위의 코드에서는 mode=debug 파라미터가 필수적이다. 포함되어 있어야 mappingParam()이 실행된다.

즉 @GetMapping(params = "key=value")를 사용하면 특정 쿼리 파라미터가 있을 때만 요청을 처리할 수 있다. 잘 사용되지는 않는다.

특정 헤더 조건 매핑

/**
 * 특정 헤더로 추가 매핑
 * 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 헤더가 있을 경우에 사용할 수 있다.

postman header에 mode를 debug를 설정한 이후 찔러보면 값이 나오는 것을 확인할 수 있다.

미디어 타입 조건 매핑 - HTTP 요청 Content-Type, 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";
}

HTTP 요청의 Content-Type를 기반으로 미디어 타입을 매핑한다.

맞지 않으면 HTTP 415 상태 코드를 반환한다.(Unsupported Media Type)

/**
 * 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 상태코드(NotAcceptable)을 반환한다.

요청 매핑 - API 예시

회원 관리를 HTTP API로 만든다 생각하고 매핑을 어떻게 하는지 알아보자.

(실제 데이터가 넘어가는 부분은 생략하고 URL 매핑만 진행해보자.)

*회원 관리 API*

- 회원 목록 조회 : GET '/users'

- 회원 등록 : POST '/users'

- 회원 조회 : GET '/users/{userId}'

- 회원 수정 : PATCH '/users/{userId}'

- 회원 삭제 : DELETE '/users/{userId}'

MappingClassController를 만들어보자. 패키지 위치는 다음과 같다.

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

    /**
     * *회원 관리 API*
     * - 회원 목록 조회 : GET '/users'
     * - 회원 등록 : POST '/users'
     * - 회원 조회 : GET '/users/{userId}'
     * - 회원 수정 : PATCH '/users/{userId}'
     * - 회원 삭제 : DELETE '/users/{userId}'
     */

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

내부에 데이터 없이 일단 Mapping만 하였다.

@RequestMapping("/mapping/users")

- 클래스 레벨에 매핑 정보를 두면 메서드 레벨에서 해당 정보를 조합하여 사용한다.

HTTP 요청 - 기본, 헤더 조회

애노테이션 기반의 스프링 컨트롤러는 다양한 파라미터를 지원한다.

이번 시간에는 HTTP 헤더 정보를 조회하는 방법을 알아보자.

RequestHeaderController 클래스를 생성해보자.

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

    }
}

HttpServletRequest : HTTP 요청 정보를 담고 있다. 요청 값을 받을 수 있다.

HttpServletResponse : HTTP 응답 정보를 담고 있다. 응답 값을 실어 보낸다

HttpMethod : HTTP 메서드를 조회한다. GET인지 POST인지 등의 확인이 가능하다.

Locale : 클라이언트가 요청한 언어 및 지역 정보를 가져온다.

@RequestHeader MultiValueMap : 모든 요청 헤더를 MultiValueMap 형태로 가져옴

@RequestHeader ("host") : 특정 요청 헤더 값을 가져옴 --> 현재는 "host"값을 가져옴

@CookieValue : 클라이언트가 보낸 쿠키 값을 가져옴, required = false상태이므로 쿠키가 없어도 오류가 발생하지 않는다.

@Slf4j : 이 애노테이션은 아래 코드를 자동으로 생성해서 로그를 선언해준다. 개발자는 편리하게 log라고 사용하면 된다.

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

** 중요 : System.out.println이 아닌 log로 찍었다. 앞으로는 System.out.println 대신 log를 찍도록 하자.

참고

@Controller의 사용 가능한 파라미터 목록과 응답 값 목록은 다음 공식 메뉴얼에서 더 알아보도록 하자.

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/arguments.html

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/return-types.html

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

HTTP 요청 데이터 조회 - 개요

서블릿에서 학습했던 HTTP 요청 데이터를 조회하는 방법을 다시 떠올려보자. 그리고 서블릿으로 학습했던 내용을 스프링이 얼마나 깔끔하고 효율적으로 바꾸어주는지 알아보자.

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

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

1. GET - 쿼리 파라미터

- /url**?username=hello&age=20**

- 메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달한다.

- 예) 검색, 필터, 페이징 등에서 많이 사용하는 방식

2. POST - HTML Form

- content-type: application/x-www-form-urlencoded

- 메시지 바디에 쿼리 파라미터 형식으로 전달 username=hello&age=20

- 예) 회원 가입, 상품 주문, HTML Form 사용

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

- HTTP API에서 주로 사용, JSON, XML, TEXT

- 데이터 형식은 주로 JSON 사용

- POST, PUT, PATCH

RequestParamController 클래스를 생성해보자.

@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가 제공하는 방식으로 요청 파라미터를 조회하였다.

http://localhost:8080/request-param-v1?username=hello&age=20 를 검색하면 다음과 같은 로그가 찍히게 된다.

2025-03-18T15:33:14.477+09:00 INFO 16076 --- [springmvc] [nio-8080-exec-5] h.s.b.request.RequestParamController : username =hello, age=20

Post를 활용한 HTML Form을 사용해도 로그를 확인할 수 있다.

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 방식의 액션을 하는 html이다. username과 age가 text 타입으로 input 된다.

버튼을 누르면 마찬가지로 동작하게 된다.

2025-03-18T15:41:44.747+09:00 INFO 16076 --- [springmvc] [nio-8080-exec-1] h.s.b.request.RequestParamController : username =kim, age=20

HTTP 요청 파라미터 - @RequestParam

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

@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(~) : 파라미터 이름으로 바인딩을 한다.

@ResponseBody : View 조회를 무시하고, HTTP message body에 직접 해당 내용을 입력한다.

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

- @RequestParam("username") String memberName

---> request.getParameter("username")

requestParamV3

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

    return "ok";
}

HTTP파라미터 이름이 변수 이름과 같으면 @RequestParam(name = "xx") 생략이 가능하다.

@RequestParam String username

---> request.getParameter("username")

requestParamV4

@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까지는 붙혀주는게 더 괜찮아보인다.

파라미터 필수 여부 - 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";

    //int에는 null을 넣을 수 없다.
    //Integer는 객체이기때문에 null 가능
    //"" 빈문자라는 값이 들어갈 수 있는거 주의
}

@RequestParam()에 required를 주어 파라미터의 필수 여부를 넣어줄 수 있다.

- 기본 값은 true이기 때문에 아무것도 적지 않으면 true로 동작한다.

/request-param-required를 요청하면 다음과 같은 결과가 나온다.

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

/request-param-required?username=

위의 URI는 파라미터 이름만 있고 값이 없는 경우이다. --> 이렇게 되면 username="" 이기 때문에 빈 문자로 통과가 된다.

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

@RequestParam(required = false) int age) {

위와같은 @RequestParam에 요청을 하면 500에러가 발생하는데

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

파라미터에 값이 없는 경우 defaultValue를 사용하면 기본 값으로 적용할 수 있다.

이미 기본 값이 있기 때문에 required는 의미가 없게 된다.

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

로그의 결과는 다음과 같다.

2025-03-19T11:09:02.042+09:00 INFO 13984 --- [springmvc] [nio-8080-exec-8] h.s.b.request.RequestParamController : username =guest, age=-1

파라미터를 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으로 조회할수도 있다.

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

** 보통 파라미터의 값이 한개이긴 하다.

HTTP 요청 파라미터 - @ModelAttribute

실제 개발을 하면 요청 파라미터를 받아서 필요한 객체를 만들고, 그 객체 값을 넣어주어야 한다.

보통 다음과 같이 코드를 작성할 것이다.

일단 요청 값을 바인딩 받을 객체를 생성하자.

@Data
public class HelloData {

    private String username;
    private int age;
}

- 롬복 @Data

- @Getter, @Setter, @ToString, @EqualsAndHashCode, @RequiredArgsConstructor를 자동으로 적용해준다.

이후 HelloData 객체를 생성한 뒤 set을 통해 값을 바인딩 해주어야 했다.

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

}

*참고 : helloData 객체도 log로 찍어볼 수 있다.

이 코드를 @ModelAttribute를 통해 한번에 해결할 수 있다.

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

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

마치 Hello 객체가 생성되고, 요청 파라미터 값도 모두 들어가 있는 것을 확인할 수 있을 것이다.

스프링MVC는 @ModelAttribute가 있으면 다음을 실행한다.

- HelloData 객체를 생성한다.

- 요청 파라미터의 이름으로 HelloData 객체의 프로퍼티를 찾는다. 그리고 해당 프로퍼티의 setter를 호출해서 파라미터의 값을 입력(바인딩)한다.

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

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

바인딩 오류 : age=abc 처럼 숫자가 들어가야 할 곳에 문자를 넣으면 BindException이 발생한다. 이런 바인딩 오류를 처리하는 방법은 검증 부분에서 다뤄보자.

@ModelAttribute 생략 - modelAttrubuteV2

@ResponseBody
@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(HelloData helloData) {

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

}

이전에 @RequestParam을 생략하듯이 @ModelAttribute도 생략할 수 있다.

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

- String, int, Integer 같은 단순 타입 = @RequestParam

- 나머지 = @ModelAttribute(argument resolver로 지정해둔 타입 외)

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

서블릿에서 학습한 내용을 떠올려 보자.

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

- HTTP API에서 주로 사용한다. JSON, XML, TEXT형식을 주로 사용

- 데이터 형식은 주로 JSON이 많다.

- POST, PUT, PATCH일때 사용된다.

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

- 먼저 가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고, 읽어보자.

- HTTP 메시지 바디의 데이터를 InputStream을 사용해서 직접 읽을 수 있다.

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

inputStream을 사용해서 HTTP 요청의 body를 읽고, 로그를 찍어보자.

Input, Output 스트림, Reader - requestBodyStringV2

위의 코드가 번거롭기 때문에 스프링은 InputStream과 OutputStream 파라미터를 지원한다.

@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 응답 메시지의 바디에 직접 결과를 출력한다.

HttpEntity - requestBodyStringV3

좀 더 간결하게 작성할 수 있게끔 HttpEntity 인터페이스를 지원하기도 한다.

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

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

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

- HttpEntity : HTTP header, body 정보를 편리하게 조회한다.

- 메시지 바디 정보를 직접 조회한다.

- 요청 파라미터를 조회하는 기능(@RequestParam, @ModelAttribute)과 관계 없다.

- HttpEntity는 응답에서도 사용 가능하다.

- 메시지 바디 정보 직접 반환

- 헤더 정보 포함 가능

- view 조회 X

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

-RequestEntity

- HttpMethod, url 정보를 추가적으로 받을 수 있다.

- ResponseEntity

- HTTP 상태 코드 설정이 가능하다.

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

@RequestBody - requestBodyStringV4

스프링은 메시지 바디 정보를 직접 조회하는 기능과, 메시지 바디 정보를 직접 반환하는 기능을 할 수 있다.

여지껏 봐왔던 @ResponseBody가 그러하다.

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

    return "ok";
}

@RequestBody

@RequestBody를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다. 참고로 헤더 정보가 필요하다면 HttpEntity를 사용하거나, @RequestHeader를 사용하면 된다.

이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute와 전혀 관계가 없다.

@RequestBody : HTTP 요청 바디에서 JSON/XML을 변환하여 처리(HTTP 메시지 바디를 직접 조회)

@RequestParam, @ModelAttribute : 쿼리 파라미터나 폼 데이터를 처리(요청 파라미터를 조회)

@ResponseBody

@ResponseBody를 사용하면 응답 결과를 HTTP 메시지 바디에 직접 담아서 전달할 수 있다.

이 경우에도 view를 사용하지 않는다.

HTTP 요청 메시지 - JSON

HTTP API에서 가장 많이 사용하는 JSON 데이터 형식을 조회해보자.

기존 서블릿에서 사용했던 방식에서부터 점진적으로 발전해나갈 것이다.

우선 ObjectMapper에 대해서 알아보자.

*ObjectMapper

ObjectMapper는 JSON 데이터를 Java 객체로 변환하거나, Java 객체를 JSON 문자열로 변환할 때 필요한 Jackson 라이브러리의 핵심 클래스이다.

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을 활용해보자.

2025-03-19T17:37:50.924+09:00 INFO 15312 --- [springmvc] [nio-8080-exec-5] h.s.b.request.RequestBodyJsonController : username=hello, age=20

RequestBodyJsonV2-@RequestBody 문자 변환

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

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

    return "ok";
}

- 이전에 봤던 @RequestBody를 사용해서 HTTP 메시지에서 데이터를 꺼내고, messageBody에 저장한다.

- 문자로 된 JSON 데이터를 ObjectMapper를 통해 자바 객체로 변환시킬수도 있다.

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

requestBodyJsonV3-@RequestBody 객체 변환

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

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

    return "ok";
}

@RequestBody 객체 파라미터

- @RequestBody HelloData data

- @RequestBody에 직접 만든 객체를 저장할 수 있다.

HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다.

HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, V2에서 했던 작업을 대신 처리해주는 것이다.

그렇담 @RequestBody는 이전에 봤던 @RequestParam, @ModelAttribute처럼 애노테이션을 생략해도 적용이 될까?

public String requestBodyJsonV3(HelloData helloData)

아쉽게도 위와 같은 코드는 적용되지 않는다.

스프링은 @ModelAttribute, @RequestParam과 같은 해당 애노테이션을 생략시엔 다음과 같은 규칙을 적용한다.

- String, int, Integer같은 단순 타입 = @RequestParam

- 나머지 타입 = @ModelAttribute (argument resolver로 지정해둔 타입 외)

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

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

RequestBodyJsonV4 - HttpEntity

@ResponseBody
@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<HelloData> data) {
    HelloData helloData = data.getBody();

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

    return "ok";
}

RequestBodyJsonV5

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

    return data;
}

@ResponseBody

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

물론 이 경우에도 HttpEntity를 사용해도 된다.

@RequestBody 요청

- JSON 요청 -> HTTP 메시지 컨버터 -> 객체

@ResponseBody 응답

- 객체 -> HTTP 메시지 컨버터 -> JSON 응답

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

응답 데이터는 이미 앞에서 일부 다룬 내용들이지만, 응답 부분에 초점을 맞추어서 정리해보자.

스프링(서버)에서 응답 데이터를 만드는 방법은 크게 3가지이다.

1. 정적 리소스

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

2. 뷰 템플릿 사용

- 예) 웹 브라우저에 동적인 HTML을 제공할때는 뷰

3. HTTP 메시지 사용

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

정적 리소스

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

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

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

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

정적 리소스 경로

src/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>

웹 브라우저에서 다음과 같이 실행하면 된다.

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>

ResponseViewController - 뷰 템플릿을 호출하는 컨트롤러

@Controller
public class ResponseViewController {

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

        return mav;
    }

    @RequestMapping("/response-view-v2")
    public String responseViewV2(Model model) {
        model.addAttribute("data", "hello!");
        return "response/hello"; //뷰의 논리적인 이름이 된다.
    }

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

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

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

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

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

실행 : temlplates/response/hello.html

Void를 반환하는 경우 -- 권장되지 않으니 그냥 알아나 보자.

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

- 요청 URL : /response/hello

- 실행 : templates/response/hello.html

- 이 방식은 명시성이 너무 떨어지고, 이렇게 딱 맞는 경우도 많이 없기 때문에, 권장하지 않는다.

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

Thymeleaf 스프링 부트 설정

다음 라이브러리를 추가하면 스프링부트가 자동으로 ThymeleafViewResolver와 필요한 스프링 빈들을 등록한다.

implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'

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

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

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

responseBodyV1

@Slf4j
@RestController
public class ResponseBodyController {

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

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

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

responseBodyV2

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

ResponseEntity 엔티티는 HttpEntity를 상속받는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다. ResponseEntity는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.

responseBodyV3

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

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

responseBodyJsonV1

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

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

responseBodyJsonV2

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

    return helloData;
}

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

따라서 @ResponseStatus(HttpStatus.OK)애노테이션을 사용하면 응답 코드도 설정할 수 있다.

@RestController

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

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

HTTP 메시지 컨버터

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

-@ResponseBody를 사용

- HTTP의 BODY에 문자 내용을 직접 반환한다.

- viewResolver 대신에 HttpMessageConverter가 동작한다.

- 기본 문자처리 : StringHttpMessageConverter

- 기본 객체처리 : MappingJackson2HttpMessageConverter

- byte 처리 등등 기타 여러 HttpMessageConverter가 기본으로 등록되어 있음

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

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

- HTTP 요청 : @RequestBody, HttpEntity(RequestEntity)

- HTTP 응답 : @ResponseBody, HttpEntity(ResponseEntity)

HTTP 메시지 컨버터 인터페이스를 확인해보자.

HTTP 메시지 컨버터

public interface HttpMessageConverter<T> {
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);

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

    List<MediaType> getSupportedMediaTypes();

    default List<MediaType> getSupportedMediaTypes(Class<?> clazz) {
        return !this.canRead(clazz, (MediaType)null) && !this.canWrite(clazz, (MediaType)null) ? Collections.emptyList() : this.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 응답 둘 다 사용된다.

- canRead(), canWrite() : 메시지 컨버터가 해당 클래스, 미디어타입을 지원하는지 체크

- read(), write() : 메시지 컨버터를 통해서 메시지를 읽고 쓰는 기능

스프링 부트 기본 메시지 컨버터는 다음과 같다.(일부 생략되었으니 참고만 하자.)

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

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

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

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 관련

ex) 만약 StringHttpMessageConverter가 사용이 된다 하면 다음과 같다.

content-type: application/json

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

1. @RequestBdoy에 String이며, application/json 컨텐트 타입이다.

2. StringHttpMessageConverter가 String 타입인지 체크하고, 콘텐트 타입을 체크한다.

3. StringHttpMessageConverter가 동작한다.

MappingJackson2HttpMessageConverter가 동작하는 방법도 마찬가지이다.

content-type: application/json

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

1. @RequestBody에 객체가 들어왔고 컨텐트 타입이 application/json이다.

2. MappingJackson2HttpMessageConverter가 객체 타입인지, 콘텐트 타입인지를 체크한다.

3. MappingJackson2HttpMessageConverter가 동작한다.

문제가 발생하는 예도 같이 알아보자.

content-type: text/html

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

1. @RequestBody에 객체가 들어왔고 컨텐트 타입이 application/json이다.

2. MappingJackson2HttpMessageConverter가 객체 타입인것을 확인하였으나 컨텐트 타입이 맞질 않는다.

3. 맞지 않기 때문에 탈락된다.

*HTTP 요청 데이터 읽기 순서*

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

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

- 대상 클래스 타입을 지원하는가

- 예) @RequestBody의 대상 클래스(byte[], String, HelloData)

- HTTP 요청의 Content-Type 미디어 타입을 지원하는가

- 예) text/plain, application/json, */*

3. canRead()의 조건을 만족하면 read()를 호출해서 객체를 생성하고, 반환한다.

*HTTP 응답 데이터 생성*

1. 컨트롤러에서 @ResponseBody or HttpEntity로 값이 반환된다.

2. 메시지 컨버터가 메시지를 쓸 수 있는지 확인하기 위해 canWrite()를 호출한다.

- 대상 클래스 타입을 지원하는가.

- 예) return의 대상 클래스(byte[], String, HelloData)

- HTTP 요청의 Accept 미디어 타입을 지원하는가.(더 정확히는 @RequestMapping의 produces)

- 예) text/plain, application/json, */*

3. canWrite() 조건을 만족하면 write()를 호출해서 HTTP 응답 메시지 마디에 데이터를 생성한다.

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

여태까지 배운 스프링 MVC 구조에서는 HTTP 메시지 컨버터의 위치가 보이진 않았다.

HTTP 메시지 컨버터는 어디쯤에서 사용되는 것일까?

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

* Argument : 매개변수

RequestMappingHandlerAdapter 동작 방식

*ArgumentResolver*

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

HTTPServletRequest, Model은 물론이고, @RequestParam, @ModelAttribute 같은 애노테이션 그리고 @RequestBody, HttpEntity 같은 HTTP 메시지를 처리하는 부분까지 매우 큰 유연함이 있다.

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

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

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

기본으로 제공되는것들은 다음 링크를 참고하도록 하자.

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/arguments.html

정확히는 HandlerMethodArgumentResolver인데 줄여서 ArgumentResolver라고 부른다.

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter parameter);

    @Nullable
    Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception;
}

동작 방식

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

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

*ReturnValueHandler

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

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

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

ex) ModelAndView, @ResponseBody, HttpEntity, String

다음 링크를 참고하도록 하자.

https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-controller/ann-methods/return-types.html

HTTP 메시지 컨버터

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

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

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

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

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

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

'공부 > Spring' 카테고리의 다른 글

타임리프 - 기본 기능 (0)	2025.03.27
스프링 MVC 웹 페이지 만들기 (0)	2025.03.25
스프링 MVC - 구조 이해 (0)	2025.03.17
MVC 프레임워크 만들기 (0)	2025.03.15
서블릿, JSP, MVC 패턴 (0)	2025.03.12

현재글스프링 MVC - 기본 기능

IT 개발자의 공부방

오블완, 다형성, MVC, Thymeleaf, 자바, 객체지향, 메서드, 공부, 참조형, 김영한, 클래스, 티스토리챌린지, bean, java, spring, API, http, jpa, 컬렉션 프레임워크, 스프링,

Today :
Yesterday :

내 블로그 - 관리자 홈 전환	`Q` `Q`
새 글 쓰기	`W` `W`

글 수정 (권한 있는 경우)	`E` `E`
댓글 영역으로 이동	`C` `C`

이 페이지의 URL 복사	`S` `S`
맨 위로 이동	`T` `T`
티스토리 홈 이동	`H` `H`
단축키 안내	`Shift` + `/` `⇧` + `/`

surrealCode