20230707 [Spring] ResponseEntity에 대해서 알아보자!

ResponseEntity란

httpentity를 상속받는, 결과 데이터와 HTTP 상태 코드를 직접 제어할 수 있는 클래스이다.

ResponseEntity에는 사용자의 HttpRequest에 대한 응답 데이터가 포함된다.

에러 코드와 같은 HTTP상태 코드를 전송하고 싶은 데이터와 함께 전송할 수 있기 때문에 좀 더 세밀한 제어가 필요한 경우 사용한다고 한다.

ReponseEntity 구조

ResponseEntity는 HttpEntity를 상속받고 사용자의 응답 데이터가 포함된 클래스이기 때문에
HttpStatus / HttpHeaders / HttpBody 를 포함한다.

주요 기능

1. 응답 본문 지정
   응답 본문을 모든 Java 객체로 설정할 수 있다. 기본적으로 Spring은 요청의 Accept 헤더를 기반으로 객체를 JSON 또는 XML로 자동 직렬화한다.
2. HTTP 헤더 설정
   응답에서 HTTP 헤더를 추가, 수정 또는 제거할 수 있다.
3. 상태 코드 지정
   요청의 성공 또는 실패를 나타내는 HTTP 상태 코드를 명시적으로 설정할 수 있다.
4. 사용자 지정 상태 코드 및 오류 응답 반환
   'ResponseEntity'를 사용하면 사용자 지정 오류 메시지 또는 오류 세부 정보와 함께 404 Not Found 또는 500 Internal Server Error와 같은 특정 상태 코드 및 오류 응답을 반환할 수 있다.

<참고 자료>

https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/ResponseEntity.html
https://thalals.tistory.com/268