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

HTTP message body는 데이터를 직접 담아서 요청을 보내는 것이다.

 - HTTP API에서 주로 사용하고, JSON, XML, TEXT 등이 있다.

 - 데이터 형식은 주로 JSON을 사용한다.

 - POST, PUT, PATCH가 있다.

 

요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 넘어오는 경우는 @RequestParam, @ModelAttribute를 사용할 수 없다.

물론 HTML Form 형식으로 전달되는 경우는 요청 파라미터로 인정 된다.

 

가장 단순한 텍스트 메시지를 HTTP 메시지 바디에 담아서 전송하고 읽어본다.

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

 

RequestBodyStringController

package hello.springmvc.basic.request;

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.util.StreamUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.io.Writer;
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");

    }
}

 

 

Postman을 사용해서 테스트해본다.

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

Body 탭의 row, Text 선택

 

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

}

 

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

 1) InputStream(Reader) : HTTP 요청 메시지 바디의 내용을 직접 조회한다.

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

 

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

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

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

    - 요청 파라미터를 조회하는 기능과 관계 없음 : @RequestParam X, @ModelAttribute X

 2) HttpEntity는 응답에도 사용 가능하다

    - 메시지 바디 정보를 직접 반환한다.

    - 헤더 정보를 포함할 수 있다.

    - view 조회는 불가능하다.

 

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

1) RequestEntity

    - HttpMethod, url 정보가 추가, 요청에서 사용된다.

2) ResponseEntity

    - HTTP 상태 코드를 설정할 수 있고, 응답에서 사용이 가능하다.

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

 

 

※ 참고

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

 

    /**
     * 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 ResponseEntity<>("ok", HttpStatus.CREATED);
    }

 

 

@RequestBody - requestBodyStringV4

@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 와는 전혀 관계가 없다.

 

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

 - 요청 파라미터를 조회하는 기능 : @RequestParam, @ModelAttribute

 - HTTP 메시지 바디를 직접 조회하는 기능 : @RequestBody

 

@ResponseBody

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

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