HTTP 요청 메시지 - 텍스트, JSON

 

HTTP message body 데이터 조회 - text

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

 

1. InputStream

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

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

실행 결과

 

2. InputStream, OutputStream, Reader

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

InputStream(Reader)

HTTP 요청 메시지 바디의 내용을 직접 조회

 

OutputStream(Writer)

HTTP 응답 메시지의 바디에 직접 결과 출력

 

3. HttpEntity

@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가 제공하는 파라미터

• HttpEntity
  • HTTP header, body 정보를 편리하게 조회
  • 메시지 바디 정보를 직접 조회
  • 요청 파라미터를 조회하는 기능과 관계 없음 @RequestParam X, @ModelAttribute X

 

• RequestEntity
  • HttpEntity 를 상속받은 객체 
  • HttpMethod, url 정보가 추가, 요청에서 사용

 

• ResponseEntity
  
  • HttpEntity 를 상속받은 다음 객체  
  • HTTP 상태 코드 설정 가능, 응답에서 사용

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

 

4. @RequestBody, @ResponseBody

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

@ResponseBody
@PostMapping("/request-body-string-v4")
public String requestBodyStringV4(@RequestBody String messageBody) throws IOException {

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

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

메시지 바디 내용 가져와서 문자로 변환해주는 과정을 스프링 mvc가 자동으로 해준다. 그게 httpMessageConverter이다

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

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

view를 사용하지 않는다?
뷰 리졸버 자체를 사용하지 않는다는 뜻. HTTP body에 필요한 데이터만 담아서 클라이언트에 넘겨버린다.

 

 

 

HTTP message body 데이터 조회 - JSON

 

1. HttpServletRequest

private ObjectMapper objectMapper = new ObjectMapper();

@PostMapping("/request-body-json-v1")
public void requestBodyJsonV1(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());
    response.getWriter().write("ok");
}

직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다

문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

 

2. @RequestBody 

@ResponseBody
@PostMapping("/request-body-json-v2")
public String  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());

    return "ok";
}

@RequestBody 를 사용해서 HTTP 메시지에서 데이터를 꺼내고 messageBody에 저장한다

문자로 된 JSON 데이터인 messageBody 를 objectMapper 를 통해서 자바 객체로 변환한다.

 

1. @RequestBody를 사용해서 HTTP message에서 데이터(json)을 꺼내서 messageBody 변수에 저장
2. 문자로 된 json 데이터인 messageBody를 objectMapper를 통해 자바 객체로 변화

위 과정이 너무 귀찮다. @ModelAttribute처럼 한번에 객체로 변환할 수 있는 방법은? 

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

 

@ResponseBody
@PostMapping("/request-body-json-v3")
public String  requestBodyJsonV3(@RequestBody HelloData data) {
    log.info("username={}, age={}", data.getUsername(), data.getAge());

    return "ok";
}

HttpEntity , @RequestBody 를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가 원하는 문자나 객체 등으로 변환해준다

HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해준다.

 

@RequestBody는 생략 불가능

→ HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.

 

HTTP 요청시에 content-type이 application/json인지 꼭! 확인해야 한다. 그래야 JSON을 처리할 수 있는 HTTP 메시지 컨버터가 실행된다

 

content-type확인

HttpEntity 사용 가능

 

@RequestBody 요청

JSON 요청 → HTTP 메시지 컨버터 → 객체

 

@ResponseBody 응답

객체 → HTTP 메시지 컨버터 → JSON 응답