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

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

HTTP API에서는 주로 HTTP message body에 데이터를 직접 담아 요청한다.

이때 데이터 형식으로는 JSON, XML, TEXT 등이 사용되며, 특히 JSON 형식이 가장 일반적으로 사용된다.

이 방식은 주로 POST, PUT, PATCH 등의 HTTP 메서드에서 사용된다.

요청 파라미터와는 달리 HTTP 메시지 바디를 통해 데이터가 직접 전달되는 경우에는 @RequestParam, @ModelAttribute와 같은 어노테이션을 사용할 수 없습니다. (다만 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정된다.)

가장 간단한 형태로 HTTP message body에 텍스트 메시지를 담아 보내고, 이를 읽어 보려면 InputStream을 사용하여 데이터를 직접 읽을 수 있으며, 이를 통해 서버 측에서 전달된 데이터를 처리할 수 있다.

---

RequestBodyStringController

@Slf4j
@Controller
public class RequestBodyStringController {

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

실행 : http://localhost:8080/request-body-string-v1

INFO 25304 --- [nio-8080-exec-2] h.s.b.r.RequestBodyStringController      : messageBody=hello-springV1

---

 

Input, Output 스트림, Reader - requestBodyStringV2

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

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

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

실행 : http://localhost:8080/request-body-string-v2

INFO 19332 --- [nio-8080-exec-2] h.s.b.r.RequestBodyStringController      : messageBody=hello-springV2

---

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

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

---

 

HttpEntity - requestBodyStringV3

/**
 * HttpEntity: HTTP header, body 정보를 편리하게 조회
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * 응답에서도 HttpEntity 사용 가능
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@PostMapping("/request-body-string-v3")
public HttpEntity<String> requestBodyStringV3(HttpEntity<String> httpEntity) throws IOException {

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

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

실행 : http://localhost:8080/request-body-string-v3

INFO 19076 --- [nio-8080-exec-1] h.s.b.r.RequestBodyStringController      : messageBody=hello-springV3

---

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

 

HttpEntity를 사용하면 HTTP header와 body 정보를 편리하게 조회가 가능하다.

• 메시지 바디 정보를 직접 조회할 수 있다.
• 따라서 @RequestParam, @ModelAttribute 어노테이션을 사용하지 않는다.

HttpEntity는 응답에도 사용할 수 있다.

• 메시지 바디 정보를 직접 반환할 수 있다.
• 헤더 정보를 포함할 수 있습니다. 
• 그러나 HttpEntity는 view를 조회하지 않는다.

---

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

RequestEntity

• HttpMethod, url 정보가 추가, 요청에서 사용

ResponseEntity

• HTTP 상태 코드 설정 가능, 응답에서 사용

return new ResponseEntity("Hello World", responseHeaders, HttpStatus.CREATED)

 

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

---

 

@RequestBody - requestBodyStringV4

/**
 * @RequestBody
 * - 메시지 바디 정보를 직접 조회(@RequestParam X, @ModelAttribute X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 *
 * @ResponseBody
 * - 메시지 바디 정보 직접 반환(view 조회X)
 * - HttpMessageConverter 사용 -> StringHttpMessageConverter 적용
 */
@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) {
    log.info("messageBody={}", messageBody);

    return ("ok");
}

실행 : http://localhost:8080/request-body-string-v4

INFO 7328 --- [nio-8080-exec-1] h.s.b.r.RequestBodyStringController      : messageBody=hello-springV4

 

@RequestBody

@RequestBody 를 사용하면 HTTP 메시지 바디 정보를 편리하게 조회할 수 있다.

참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.

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

 

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

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

 

@ResponseBody

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

 

 

 

출처 : 인프런 - 스프링 MVC 1편  by 우아한형제 김영한이사님