HTTP 요청 메시지 - JSON

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

기존 서블릿에서 사용했던 방식과 비슷하게 시작해보자.

/**
 * {"username":"hello", "age":20}
 * content-type: application/json
 */
@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 data = objectMapper.readValue(messageBody, HelloData.class);
 log.info("username={}, age={}", data.getUsername(), data.getAge());
 response.getWriter().write("ok");
 }
}

• HttpServletRequest를 사용해서 직접 HTTP 메시지 바디에서 데이터를 읽어와서, 문자로 변환한다.
• 문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

@RequestBody로 받기

@ResponseBody
@PostMapping("/request-body-json-v2")
public String requestBodyJsonV2 (@RequestBody String message) throws IOException {
    HelloData helloData = objectMapper.readValue(message,HelloData.class);
    log.info("username = {}, age = {}",helloData.getUsername(),helloData.getAge());
    return "ok";
}

@RequestBody로 받는데 우리가 지정한 특정한 객체 타입으로 받기

/**
 * @RequestBody 생략 불가능(@ModelAttribute 가 적용되어 버림)
 * HttpMessageConverter 사용 -> MappingJackson2HttpMessageConverter (contenttype: application/json)
 *
 */
@ResponseBody
@PostMapping("/request-body-json-v3")
public String requestBodyJsonV3(@RequestBody HelloData message) throws IOException {
    log.info("username = {}, age = {}",message.getUsername(),message.getAge());
    return "ok";
}

@RequestBody 객체 파라미터

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

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

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

@RequestBody는 생략 불가능

스프링은 @ModelAttribute , @RequestParam 과 같은 해당 애노테이션을 생략시 다음과 같은 규칙을 적용한다.

• String , int , Integer 같은 단순 타입 = @RequestParam
• 나머지 = @ModelAttribute (argument resolver 로 지정해둔 타입 외)
• 따라서 이 경우 HelloData에 @RequestBody 를 생략하면 @ModelAttribute 가 적용되어버린다.
• HelloData data → @ModelAttribute HelloData data
• 따라서 생략하면 HTTP 메시지 바디가 아니라 요청 파라미터를 처리하게 된다.

물론 HttpEntity<>를 이용해서 Body의 값을 꺼내올 수 도 있다.

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

 

Body에 JSON으로 받은 정보를 직접 반환도 가능하다.

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

이렇게 될 경우 화면에 JSON으로 받아온 Data가 똑같이 JSON형식으로 반환이 된다.

역시 HttpEntity방식으로도 가능하다.

@ResponseBody
@PostMapping("/request-body-json-v6")
public HelloData requestBodyJsonV6(HttpEntity<HelloData> Data) throws IOException {
    HelloData helloData = Data.getBody();
    log.info("username = {}, age = {}",helloData.getUsername(),helloData.getAge());
    return helloData;
}

@ResponseBody
@PostMapping("/request-body-json-v7")
public HttpEntity<HelloData> requestBodyJsonV7(HttpEntity<HelloData> Data) throws IOException {
    HelloData helloData = Data.getBody();
    log.info("username = {}, age = {}",helloData.getUsername(),helloData.getAge());
    return new HttpEntity<HelloData>(helloData);
}

@ResponseBody
@PostMapping("/request-body-json-v8")
public HttpEntity<HelloData> requestBodyJsonV8(@RequestBody HelloData Data) throws IOException {
    log.info("username = {}, age = {}",Data.getUsername(),Data.getAge());
    return new HttpEntity<HelloData>(Data);
}

모두 같은 결과를 보여준다.

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

@RequestBody 요청

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

@ResponseBody 응답

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