HTTP API 응답 정리

 

 

 

HTTP 메세지 바디를 직접 조회하고 싶을 때, 스프링 MVC는 다음 파라미터를 지원한다.

 

HttpEntity

---

HTTP header, body 정보를 편리하게 조회할 수 있다.

 

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

- 요청 파라미터를 조회하는 기능과 관계 없음

  (@RequestParam X, @ModelAttribute X HttpEntity는 응답에도 사용 가능)

- 메시지 바디 정보 직접 반환, 헤더 정보 포함 가능

- view 조회X

 

 

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

 

RequestEntity

HttpMethod, url 정보가 추가, 요청에서 사용

 

ResponseEntity

HTTP 상태 코드 설정 가능, 응답에서 사용

 

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

 

 

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

 

 

@RequestBody

---

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

참고로 헤더 정보가 필요하다면 HttpEntity 를 사용하거나 @RequestHeader 를 사용하면 된다.
이렇게 메시지 바디를 직접 조회하는 기능은 요청 파라미터를 조회하는 @RequestParam , @ModelAttribute 와는 전혀 관계가 없다.

 

@ResponseBody

---

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

@ResponseBody 인 경우엔 응답코드를 설정할 수 없다. 만약 응답코드가 필요하다면 @ResponseStatus나 ResponseEntity를 이용해야 한다. 그리고 참고로 ResponseEntity를 사용하는 경우엔 @ResponseBody가 없어도 view resolver를 거치지 않는다.

 

 //동적으로 조건에 따라 코드를 변경해서 응답하는 경우
 @GetMapping("/response-body-json-v1")
    public ResponseEntity<HelloData> responseBodyJsonV1() {
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return new ResponseEntity<>(helloData, HttpStatus.OK);
    }

    //한가지 응답만 설정할 경우
    @ResponseStatus(HttpStatus.OK)
    @GetMapping("/response-body-json-v2")
    public @ResponseBody HelloData responseBodyJsonV2() {
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return helloData;
    }

 

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

---

 

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

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