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

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

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

  - POST, PUT, PATCH

 

요청 파라미터와 다르게, HTTP 메시지 바디를 통해 데이터가 직접 데이터가 넘어오는 경우는 

@RequestParam, @ModelAttribute 를 사용할 수 없다. 물론 HTML Form 형식으로 전달되는 경우는

요청 파라미터로 인정된다.

 

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

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

 

package hello.springmvc.basic.request;

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

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

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

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

}

 

 

두번째 방법은

InputStream, OutputStream을 사용하였다.

스프링은 이들을 지원하고 

전자는 HTTP 요청 메시지 바디의 내용을 직접 조회하고

후자는 HTTP 응답 메시지의 바디에 직접 결과를 출력한다.

 

세번째 방법은

HttpEntity를 사용하였다.

 

HttpEntitiy : Http header, body정보를 편리하게 조회한다.

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

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

 

HttpEntity는 응답에도 사용 가능

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

 - 헤더 정보 포함 가능

 - view 조회 하지않음

 

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

        return "ok";
    }

4번째 방법이다.

@RequestBody

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

필요하다면 HttpEntity를 사용하거나 @RequestHeader를 사용하면 된다.

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

 

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

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

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

 

@ResponseBody

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

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

+ Recent posts