HTTP API를 제공하는 경우에는 HTML이 아니라 데이터를 전달해야 하므로, HTTP 메시지 바디에 JSON 같은 형식으로 데이터를 실어 보낸다.
@Slf4j
@Controller
//@RestController
public class ResponseBodyController {
@GetMapping("/response-body-string-v1")
public void responseBodyV1(HttpServletResponse response) throws IOException {
response.getWriter().write("ok");
}
/**
* HttpEntity, ResponseEntity(Http Status 추가)
* @return
*/
@GetMapping("/response-body-string-v2")
public ResponseEntity<String> responseBodyV2() {
return new ResponseEntity<>("ok", HttpStatus.OK);
}
@ResponseBody
@GetMapping("/response-body-string-v3")
public String responseBodyV3() {
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;
}
}
responseBodyV1
ok
응답 메시지를 전달한다.response.getWriter().write("ok")
responseBodyV2
ResponseEntity
엔티티는 HttpEntity
를 상속 받았는데, HttpEntity는 HTTP 메시지의 헤더, 바디 정보를 가지고 있다.ResponseEntity
는 여기에 더해서 HTTP 응답 코드를 설정할 수 있다.HttpStatus.CREATED
로 변경하면 201 응답이 나가는 것을 확인할 수 있다.responseBodyV3
@ResponseBody
를 사용하면 view를 사용하지 않고, HTTP 메시지 컨버터를 통해서 HTTP 메시지를 직접 입력할 수 있다.ResponseEntity
도 동일한 방식으로 동작한다.responseBodyJsonV1
ResponseEntity
를 반환한다.responseBodyJsonV2
ResponseEntity
는 HTTP 응답 코드를 설정할 수 있는데, @ResponseBody
를 사용하면 이런 것을 설정하기 까다롭다.@ResponseStatus(HttpStatus.OK)
애노테이션을 사용하면 응답 코드도 설정할 수 있다.ResponseEntity
를 사용하면 된다.