bong-u/til

Spring - ResponseEntity 정리

수정일 : 2024-11-15

ResponseEntity

  • Spring에서 HttpEntity라는 클래스를 지원한다
  • HttpEntity를 상속받는 두 클래스가 RequestEntity와 ResponseEntity이다
  • RequestEntity는 http요청을 보낼때 사용하고
  • ResponseEntity는 http응답을 할때 사용한다

정의

  • body, header, status를 인자로 넘길 수 있다
 1public class ResponseEntity<T> extends HttpEntity<T> {
 2    public ResponseEntity(HttpStatusCode status) {...}
 3
 4    public ResponseEntity(@Nullable T body, HttpStatusCode status) {...}
 5
 6    public ResponseEntity(MultiValueMap<String, String> headers, HttpStatusCode status) {...}
 7
 8    public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatusCode status) {...}
 9
10    public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, int rawStatus) {...}
11}

예제 - ResponseEntity

  • 생성자를 이용하거나 builder 패턴을 활용해서 생성할 수 있다
1return new ResponseEntity<>(object, HttpStatus.valueOf(200));
2/* 또는 */
3return ResponseEntity.status(HttpStatus.valueOf(200)).body(object);