ResponseEntity on YuuuuuuYu

springframework.http.ResponseEntity

Fri, 24 Jan 2025 11:05:00 +0900

🔔 ResponseEntity 개요
🔔 다른 방법과 비교

What? Why?

스프링 3 버전부터 도입되었으며, 스프링 MVC에서 HTTP 응답을 다루는 주요 클래스 중 하나이다. HTTP 응답의 전체 내용을 제어할 수 있도록 해주며, 이를 통해 다음과 같은 요소들을 설정할 수 있다.

상태 코드 (HTTP Status Code)
: 200 OK, 404 Not Found, 500 Internal Server Error 등
헤더 (Headers)
: 응답 헤더에 특정 값을 추가/수정
본문 (Body)
: 실제로 클라이언트에게 전달될 데이터

@GetMapping("/example")
public ResponseEntity<String> getExample() {
 String body = "Hello, World!";
 HttpHeaders headers = new HttpHeaders();
 headers.add("Custom-Header", "CustomValue");
 return new ResponseEntity<>(body, headers, HttpStatus.OK);
}

@ResponseBody

객체를 직렬화하여 반환하는 어노테이션으로, 이것만 사용할 경우 헤더를 유연하게 설정할 수 없다.
@ResopnseStatus를 사용하여 헤더를 설정할 수 있지만, 어노테이션을 별도로 추가해야하는 단점이 있다.