HTTP 요청(헤더, 파라미터, 메시지) 처리

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

1. 헤더 정보 조회
2. 요청 파라미터 조회
   (1) 요청 파라미터 직접 조회(@RequestParam)
   (2) 객체를 이용한 조회(@ModelAttribute)
3. 요청 메시지 조회
   (1) 단순 텍스트 (@RequestBody)
   (2) JSON

  하나씩 자세히 알아보자.

 

1. 헤더 정보 조회 🍕

  HTTP 헤더 정보를 아래와 같이 조회할 수 있다.

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

• HttpServletRequest
• HttpServletResponse
• HttpMethod
• Locale
  Locale 정보를 조회한다.
  Locale 정보란 'ko_KR'과 같이 언어정보를 뜻한다.
• @RequestHeader MultiValueMap<String, String> headerMap
  모든 HTTP 헤더를 MultiValueMap 형식으로 가져온다.
  MultiValueMap이란 하나의 키에 여러 값을 가질 수 있는 것이다. 
• @RequestHeader("host") String host
  특정 HTTP 헤더를 조회한다.
• @CookieValue(value = "myCookie", required = false) String cookie
  특정 쿠키 정보를 조회한다.

 

2. 파라미터 조회 - 직접 조회(@RequestParam) 🍔

  파라미터를 2가지로 나눌 수 있다.

• 쿼리 파라미터(GET)
  메시지 바디 없이, URL의 쿼리 파라미터에 데이터를 포함해서 전달하는 것
  /url?username=amenable&age=20
• HTML Form(POST)
  메시지 바디에 쿼리 파라미터 형식으로 전달하는 것 (username=amenable&age=20)
  content-type: application/x-www-form-urlencoded

  두 가지 모두 아래의 방식들로 조회할 수 있다.

V1. HttpServletRequest의 request.getParameter()

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

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

    return "home";
}

V2. @RequestParam

@RequestMapping("/request-param-v2")
public String requestParamV2(@RequestParam("username") String memberName,
                             @RequestParam("age") int memberAge) {
    return "home";
}

  파라미터 이름으로 바인딩을 한다.

V3. @RequestParam 인수 생략

@RequestMapping("/request-param-v3")
public String requestParamV3(@RequestParam String username,
                             @RequestParam int age) {
    return "home";
}

  HTTP 파라미터 이름이 변수 이름과 같으면 @RequestParam의 인수를 생략할 수 있다. 원래는 @RequestParam("username")인데 변수 이름을 username으로 해줬기 때문에 생략이 가능한 것이다.

V4. @RequestParam 생략

@RequestMapping("/request-param-v4")
public String requestParamV4(String username,
                             int age) {
    return "home";
}

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

  하지만 @RequestParam이 생략하지 않으면, 명확하게 요청 파라미터에서 데이터를 읽는다는 것을 알 수 있다는 장점이 있긴 하다.

+α. Map을 이용한 조회

@RequestMapping("/request-param-map")
public String requestParamMap(@RequestParam Map<String, Object> paramMap) {

    Object username = paramMap.get("username");
    Object age = paramMap.get("age");

    return "home";
}

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

 

3. 파라미터 조회 - 객체를 이용한 조회(@ModelAttribute) 🍟

  지금까지는 요청 파라미터를 직접 받는 것을 알아보았다. 하지만 실제 개발을 하다 보면 요청 파라미터를 바로 쓰는 게 아니라, 필요한 객체에 요청 파라미터 값을 넣어서 해당 객체를 사용한다. 이것을 스프링에서 제공하는 @ModelAttribute를 이용하여 사용해 보자.

V1. @ModelAttribute

@Data
public class Person {

    private String name;
    private int age;
}

----------

@RequestMapping("/model-attribute-v1")
public String modelAttributeV1(@ModelAttribute Person person) {
    return "home";
}

  사용법은 상당히 간단하다. 위의 코드처럼 작성해 주면 스프링이 Person 객체를 생성하고 해당 객체의 setter를 이용하여 파라미터 값을 입력(바인딩)한다.

V2. @ModelAttribute 생략

@RequestMapping("/model-attribute-v2")
public String modelAttributeV2(Person person) {
    return "home";
}

  @ModelAttribute을 위와 같이 생략할 수 있다.

앞에서 살펴본 것과 같이 @RequestParam도 생략할 수 있었는데, 생략과 관련해서 스프링은 다음과 같은 규칙을 따른다.

1. String, int, Integer 같은 단순 타입인 경우 → @RequestParam
2. 나머지 → @ModelAttribute

 

4. 메시지 조회 - 단순 텍스트(@RequestBody) 🌭

  요청 메시지란 HTTP message body에 데이터를 직접 담아서 요청하는 것이다. HTTP API에서 주로 사용되고, 종류로는 JSON, XML, TEXT 등이 있다. 먼저 단순 텍스트를 조회하는 방법에 대해서 알아보자.

V1. HttpServletResponse + InputStream

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

    return "home";
}

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

V2. InputStream

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

    return "home";
}

  스프링 MVC에서 제공하는 InputStream 파라미터를 이용하여 HTTP 요청 메시지 바디의 내용을 직접 조회할 수 있다. (OutputStream을 이용해서 직접 결과를 출력할 수도 있다.)

V3. HttpEntity

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

    return "home";
}

  스프링 MVC에서 제공하는 HttpEntity 파라미터를 이용하여 HTTP header, body 정보를 편리하게 조회할 수 있다. HttpEntity는 메시지 바디 정보를 직접 조회한다. 

  이는 위에서 살펴본 @RequestParam과 @ModelAttribute와는 관련이 없다.

V4. @RequestBody

@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {
    return "home";
}

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

  이것 또한 @RequestParam과 @ModelAttribute와는 관련이 없다.

 

5. 메시지 조회 - JSON(@RequestBody) 🍿

  이번에는 요청 메시지 중에서 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해 보자.

V1. HttpServletRequest + JSON 변환

private ObjectMapper objectMapper = new ObjectMapper();

@PostMapping("/request-body-json-v1")
public String requestBodyJsonV1(HttpServletRequest request,
                                HttpServletResponse response) throws IOException {

    ServletInputStream inputStream = request.getInputStream();
    String messageBody = StreamUtils.copyToString(inputStream, StandardCharsets.UTF_8);

    Person person = objectMapper.readValue(messageBody, Person.class);

    return "home";
}

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

V2. @RequestBody + JSON 변환

private ObjectMapper objectMapper = new ObjectMapper();

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

    Person person = objectMapper.readValue(messageBody, Person.class);

    return "home";
}

  이전에 살펴봤던 @RequestBody를 사용하여 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다. 그리고 문자로 된 JSON 데이터인 messageBody를 objectMapper를 통해서 자바 객체로 변환한다.

V3. @RequestBody

@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody Person person) throws IOException {

    return "home";
}

  @RequestBody에 직접 객체를 지정하여 HTTP 메시지 바디의 내용을 우리가 원하는 객체로 변환한다.

  @RequestBody는 '@RequestParam과 @ModelAttribute'와 달리 생략이 불가능하다. 그 이유는 @RequestBody가 생략된다고 하면 @ModelAttribute가 적용되어 버리기 때문이다.

+α. HttpEntity

@PostMapping("/request-body-json-v4")
public String requestBodyJsonV4(HttpEntity<Person> httpEntity) throws IOException {
    Person person = httpEntity.getBody();

    return "home";
}

  물론 JSON을 처리할 때 단순 텍스트에서 사용했던 HttpEntity를 이용해도 된다.

 

해당 글은 김영한 님의 '스프링 MVC 1편 - 백엔드 웹 개발 핵심 기술'을 참고하였습니다.