46. HTTP 요청 메시지 - JSON

이번에는 HTTP API에서 주로 사용하는 JSON 데이터 형식을 조회해보았다.

 

package hello.springmvc.basic.request;

import com.fasterxml.jackson.databind.ObjectMapper;
import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
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.nio.charset.StandardCharsets;

@Slf4j
@Controller
public class RequestBodyJsonController {

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

    }

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

    @ResponseBody
    @PostMapping("/request-body-json-v3")
    public String requestBodyJsonV3(@RequestBody HelloData helloData){

        log.info("username={}, age={}",helloData.getUsername(), helloData.getAge());
        return "ok";
    }
}

먼저 3가지 방법으로 해보았다.

1번 방법은 

HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어오고, 문자로 변환하고

ObjectMapper를 사용해서 자바 객체로 변환하였다.

 

2번 방법은

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

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

 

여기서 @ModelAttrubete처럼 한번에 객체로 변환하는 방법이 3번방법에서 쓰인다.

@RequestBody 객체 파라미터

@RequestBody HelloData helloData

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

 

HttpEntity, @RequestBody를 사용하면 HTTP 메시지 컨버터가 HTTP 메시지 바디의 내용을 우리가

원하는 문자나 객체 등으로 변환해준다.

 

HTTP 메시지 컨버터는 문자 뿐만 아니라 JSON도 객체로 변환해주는데, 방금 V2에서 했던 작업을 대신

처리해준다.

 

@RequestBody는 생략 불가능

 

@ModelAttrubute,@RequestParam은 생략시 규칙이 있다.

String, int ,Integer 같은 단순 타입은 @RequestParam

나머지 경우에 @ModelAttribute(argument resolver로 지정해둔 타입 외)

 

따라서 이 경우 HelloData에 @RequestBody를 생략하면 @ModelAttribte가 적용되어 버린다.

HelloData data -> @ModelAttribute HelloData helloData

생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

 

    @ResponseBody
    @PostMapping("/request-body-json-v4")
    public String requestBodyJsonV4(HttpEntity<HelloData> data){
        HelloData helloData = data.getBody();
        log.info("username={}, age={}",helloData.getUsername(), helloData.getAge());
        return "ok";
    }

    @ResponseBody
    @PostMapping("/request-body-json-v5")
    public HelloData requestBodyJsonV5(@RequestBody HelloData helloData){
        log.info("username={}, age={}",helloData.getUsername(), helloData.getAge());
        return helloData;
    }

4번 방법은 앞선 포스팅에서 나왔던 HttpEntity를 사용하였다. 제네릭이란 무지하게 편리한것 같다.

 

5번 방법은

@ResponseBody

응답은 경우에도 @ResponseBody를 사용하면 해당 객체를 HTTP 메시지 바디에 직접 넣어줄 수 있다.

물론 이 경우에도 HttpEntity를 사용해도 된다.

 

@RequestBody 요청

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

 

@ResponseBody 응답

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