48. HTTP 응답 - HTTP API, 메시지 바디에 직접 입력

HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로

데이터를 실어 보낸다. 

 

HTML이나 뷰 템플릿을 사용해도 HTTP 응답 메시지 바디에 HTML 데이터가 담겨서 전달된다. 

package hello.springmvc.basic.response;

import hello.springmvc.basic.HelloData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Slf4j
@Controller
public class ResponseBodyController {

    @GetMapping("/response-body-string-v1")
    public void responseBodyV1(HttpServletResponse response) throws IOException {
        response.getWriter().write("ok");
    }

    @GetMapping("/response-body-string-v2")
    public ResponseEntity<String> responseBodyV2() throws IOException {
        return new ResponseEntity<>("ok", HttpStatus.OK);
    }

    @ResponseBody
    @GetMapping("/response-body-string-v3")
    public String responseBodyV3() throws IOException {
        return "ok";
    }

    @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)
    @ResponseBody
    @GetMapping("/response-body-json-v2")
    public HelloData responseBodyJsonV2(){
        HelloData helloData = new HelloData();
        helloData.setUsername("userA");
        helloData.setAge(20);

        return helloData;
    }
    
}

5가지 방법 정도 만들어 보았다.

 

responseBodyV1

서블릿을 직접 다룰 때 처럼

HttpServletResponse 객체를 통해서 HTTP 메시지 바디에 직접 ok응답 메시지를 전달한다.

 

responseBodyV2

ResponseEntity엔티티는 HttpEntity를 상속 받았는데, HttpEntity는 HTTP메시지의 헤더, 바디 정보를 가지고 있다.

ResponseEntity는 여기에 더해서 Http응답 코드를 설정할 수 있다.

 

responseBodyV3

@ResponseBody를 사용하면  view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접

입력할 수 있다.ResponseEntity도 동일한 방식으로 동작한다.

 

responseBodyJsonV1

ResponseEntity를 반환한다. HTTP메시지 컨버터를 통해서  JSON 형식으로 변환되어 반환된다.

 

responseBodyJsonV2

ResponseEntity는 HTTP 응답 코드를 설정 할 수 있는데  @ResponseBody를 사용하면 이런 것을

설정하기가 까다롭다.

@ResponseSatatus애너테이션을 사용하면 응답코드를 설정 할 수 있다.

동적으로 변경하기 위해선 ResponseEntity를 사용하면 된다.

 

@RestController

@Controller 대신에 @RestController를 사용하면 해당 컨트롤러에 @ResponseBody가 적용되는 효과가 있다.

따라서 뷰 템플릿을 사용하는 것이 아니라, HTTP 메시지 바디에 직접 데이터를 입력한다. 이름 그대로

RestAPI를 만들때 사용하는 컨트롤러이다.