[MVC] HTTP 요청 데이터를 조회하는 여러가지 방법 (@ModelAttribute, @RequestBody 등)

 

 

 

 

 

 

🧐 Http 요청 헤더 조회

예시를 통해 살펴보겠습니다.

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

import java.util.Locale;

@Slf4j
@RestController
public class RequestHeaderController {

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

        return "ok";
    }
}

HttpMethod 

HTTP 메서드를 조회합니다. 
(org.springframework.http.HttpMethod)

Locale

Locale 정보를 조회합니다.

@RequestHeader MultiValueMap<string, string> headerMap 

모든 HTTP 헤더를 MultiValueMap 형식으로 조회합니다.

@RequestHeader("host") String host

특정 HTTP 헤더를 조회합니다.
- 속성 필수 값 여부: required
- 기본 값 속성: defaultValue

@CookieValue(value = "myCookie", required = false) String cookie

특정 쿠키를 조회합니다.
- 속성필수 값 여부: required
- 기본 값: defaultValue

 

 

@Conroller 의 사용 가능한 파라미터 목록은 다음 공식 메뉴얼에서 확인할 수 있습니다.

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-arguments

Web on Servlet Stack

 

 

@Conroller 의 사용 가능한 응답 값 목록은 다음 공식 메뉴얼에서 확인할 수 있습니다.

https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc-ann-return-types

Web on Servlet Stack

 

 

 

 

 

 

 

 

 

 

 

 

🧐 Http 요청 데이터

요청 데이터를 전달하는 방법은 주로 다음과 같은 3가지 방법을 사용하여 전달합니다.

 

 

 

📕 GET - 쿼리 파라미터 방식

/url?username=hello&age=20

위와 같이 메시지 바디 없이 URL의 쿼리 파라미텅 데이터를 포함하여 전달하는 방식으로, 주로 검색 시 필터링, 페이징을 하기 위해 많이 사용합니다.

 

 

 

 

 

 

 

📙 POST - HTML Form

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

위 방식은 메시지 바디에 쿼리 파라미터 형식으로 전달합니다. (예: username=hello&age=20)

이 방식은 주로 회원 가입 등에 사용합니다.

 

 

 

 

GET의 쿼리 파라미터 전송 방식이든, POST의 HTML Form 전송 방식이든 둘 다 형식이 똑같기 때문에 이 둘을 구분없이 조회할 수 있습니다.

이것을 간단히 요청 파라미터(Request Parameter)조회라 부릅니다.

 

 

 

 

 

 

 

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

JSON이 대표적인 예시로, HTTP API에서 주로 사용합니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 요청 파라미터를 조회하는 방법

우선 GET의 쿼리 파라미터, 혹은 POST의 HTML Form 등에서 데이터를 전달하는 방식인 요청 파라미터를 조회하는 방법에 대해 알아보도록 하겠습니다.

 

 

 

 

다음과 같이 요청을 보냅니다.

~~/path?username=shin&age=20

 

 

 

 

📕 HttpServeltRequest 사용

다음과 같이 사용할 수 있습니다.

@RequestMapping("/request-param-v1")
public void requestParamV1(
        HttpServletRequest request,
        HttpServletResponse response
) {

    String username = request.getParameter("username");
    int age = Integer.parseInt(request.getParameter("age"));

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

 

 

 

 

 

 

 

 

 

📙 @RequestParam 사용

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

 

 

 

HTTP 파라미터 이름이 변수 이름과 같으면 (name="xx")에 대한 생략이 가능합니다.

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

 

 

 

 

HTTP 파라미터 이름이 변수 이름과 같을 때,
String, int, Integer 등의 단순 타입이면 @RequestParam 도 생략이 가능합니다.

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

 

 

 

 

 

@RequestParam 사용 시, 반드시 있어야 하는 값이 있다면 required를 통해 이를 설정할 수 있습니다.

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

 

 

 

👉 required

/**
 * /request-param-required -> username이 없으므로 예외
 *
 * [주의]
 * /request-param-required?username= -> 빈문자로 통과
 *
 * [주의]
 * /request-param-required?username=shin 으로 요청한 경우
 * age가 없는데, age의 타입은 int, null을 int에 입력하는 것은 불가능하므로 500 에러가 발생한다.
 * 따라서 Integer로 변경해야 함(또는 다음에 나오는 defaultValue 사용)
 */
@RequestMapping("/request-param-required")
public void requestParamRequired(
        @RequestParam(required = true) String username,
        @RequestParam(required = false) Integer age
) {
    log.info("username={}, age={}", username, age);
}

 

기본값은 true 입니다.

 

만약 필수 파라미터가 없으면 400 예외가 발생하고, username=  처럼 뒤에 아무것도 입력하지 않는 경우 빈 문자("")로 통과됩니다.

 

그런데 만약 @RequestParam(required = false) int age 처럼 

primitive type의 required가 false인 경우, 아무런 값을 입력하지 않으면 null이 들어오므로 예외가 발생합니다.

발생하는 예외
java.lang.IllegalStateException: Optional int parameter 'age' is present but cannot be translated into a null value due to being declared as a primitive type. Consider declaring it as object wrapper for the corresponding primitive type

 

 

따라서 null이 들어올 가능성이 있는 타입은 Integer처럼 래퍼 클래스로 감싸거나, 혹은 defaultValue를 사용해야 합니다.

 

 

 

 

 

 

👉 defaultValue

/**
 * defaultValue 사용
 *
 * 참고: defaultValue는 빈 문자의 경우에도 적용
 * [/request-param?username=] 인 경우 guest가 입력
 *
 * default value를 설정하였다면, required 속성이 필요 없다 (없으면 기본 값이 세팅된다.)
 *
 */
@RequestMapping("/request-param-default")
public void requestParamDefault(
        @RequestParam(required = true, defaultValue = "guest") String username,
        @RequestParam(required = false, defaultValue = "-1") int age
) {
    log.info("username={}, age={}", username, age);
}

위의 주석에 나온 바와 같이 username= 과 같이 빈 문자가 들어오는 경우에도 빈 문자열("")이 아닌 기본 문자열이 적용됩니다.

 

또한 defaultValue를 사용한 경우 요청 파라미터 값이 없는 경우 자동으로 defaultValue로 지정한 값이 들어가기 때문에 required true를 해주지 않아도 됩니다.

 

 

 

 

 

 

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

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

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

 

Map
- 하나의 key에 value가 한개인 경우 사용합니다.

 

MultiValueMap 
- 하나의 key에 value가 여러개인 경우 사용합니다.
- ex) username=shin&username=dong

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

(만약 Map을 사용했는데 여러개를 입력한다면 맨 처음 입력한 것이 출력됩니다.)

 

 

 

 

 

 

 

 

 

 

 

 

📗 @ModelAttribute 사용

@RequestParam을 통해 클라이언트에서 보낸 파라미터를 받아올 수 있었습니다.

하지만 대부분의 경우, 받아온 파라미터를 사용해서 객체를 만들어 사용합니다.

 

이러한 과정을 간편하게 진행하기 위해 스프링이 제공하는 @ModelAttribute를 사용할 수 있습니다.

이를 통해 파라미터를 바로 객체 형태로 만들어서 받을 수 있습니다.

 

우선 다음과 같이 파라미터를 통해 생성할 객체를 정의합니다.

@Getter
@Setter
public class HelloData {

    private String username;
    private int age;
}

 

 

 

기존 @RequestParam만을 사용한다면 다음과 같이 코드를 작성해야 할 것입니다.

@RequestMapping("/model-attribute-v1")
public void 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());
}

 

 

그러나 @ModelAttribute를 사용하면 다음과 같이 코드가 바뀝니다.

@RequestMapping("/model-attribute-v1")
public void modelAttributeV1(
        @ModelAttribute HelloData helloData
) {
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
}

 

 

 

 

 

@ModelAttribute는 생략 가능합니다.

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

 

@ModelAttribute와 @RequestParam 모두 생략 가능한데, 이때 적용되는 규칙은 다음과 같습니다.

String, int, Integer와 같은 단순 타입 - @RequestMapping

(Argument Resolver로 지정해준 타입 외) 나머지 객체 - @ModelAttribute

 

 

그러나 혼동되지 않도록 어노테이션을 사용하는 것을 권장합니다.

 

 

 

 

 

 

 

 

 

 

 

👉 ModelAttribute가 값을 바인딩할 수 있는 조건

기본 생성자와 Setter가 존재해야 합니다.
또는
모든 필드를 매개변수로 받는 생성자가 필요합니다.
또는
몇몇개의 필드를 매개변수로 받는 생성자 + setter가 필요합니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 요청 메세지를 조회하는 방법 - 단순 텍스트

HTTP message body에 데이터를 직접 담아 요청하는 경우, 위에서 살펴본 요청 파라미터를 조회하는 방법으로는 이에 대한 정보를 가져올 수 없습니다.

 

 

 

 

가장 기본적인 방법으로는 다음과 같이 조회할 수 있습니다.

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

 

 

 

 

 

또는 InputStream을 바로 파라미터로 받아 사용할 수 있습니다.

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

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

 

 

 

 

 

HttpEntity(혹은 이를 상속받은 RequestEntity)라는 것을 사용할 수도 있습니다.

이를 사용하면 HTTP Header, Body 정보를 편리하게 조회할 수 있습니다.

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

 

 

 

 

 

 

 

 

 

📕 @RequestBody 사용

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

 

 

 

 

 

위의 모든 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam, @ModelAttribute와는 전혀 관계가 없습니다.

메시지 바디를 처리하는 기능은 HTTP 메시지 컨버터에서 수행됩니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 요청 메세지를 조회하는 방법 - JSON

JSON을 조회하는 방법도 단순 텍스트를 조회하는 방법과 비슷하지만, ObjectMapper를 사용할 수 있습니다.

 

 

예시는 다음과 같습니다.

@PostMapping("/request-body-json-v1")
public void requestBodyJson(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());
}

 

 

 

 

 

 

아래와 같이 @RequestBody + ObjectMapper의 조합도 가능합니다.

@PostMapping("/request-body-json-v2")
public void requestBodyJsonV2(@RequestBody String messageBody) throws IOException {
    log.info("messageBody={}", messageBody);

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

 

 

 

 

 

 

📕 @RequestBody 사용

그러나 가장 추천하는 방법은 다음과 같이 @RequestBody를 통해 객체를 지정하는 것입니다.

@PostMapping("/request-body-json-v3")
public void requestBodyJsonV3(@RequestBody HelloData helloData) throws IOException {
    log.info("username={}, age={}", helloData.getUsername(), helloData.getAge());
}

@RequestBody에 직접 만든 객체를 지정할 수 있습니다.

 

HttpEntity, @RequestBody를 사용하게 되면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 파라미터로 지정된 문자나 객체 등으로 변환해주는 작업을 수행합니다.

 

이는 JSON도 객체로 변환해주며, 이는 다음에 알아보도록 하겠습니다.

 

 

 

 

 

 

 

 

👉 주의사항 1

@RequestBody는 생략이 불가능합니다.

 

스프링은 @ModelAttribute , @RequestParam 해당 생략시 다음과 같은 규칙을 적용합니다.

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

따라서 @RequestBody를 생략하면 @ModelAttribute가 적용되어버립니다.

 

 

 

 

 

 

 

 

👉 주의사항 2

HTTP 요청 시 content-type이 반드시 application/json이어야 합니다.

그래야만 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행됩니다.

 

 

 

 

 

 

 

 

 

 

 

 

 

🧐 ResquestBody가 값을 바인딩할 수 있는 조건

https://ttl-blog.tistory.com/757

[Spring MVC] - @ReqeustBody가 값을 바인딩 할 수 있는 조건

 

 

 

 

 

 

 

 

 

 

 

 

📔 Reference

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