[Spring] ResponseEntity

 

🚀 ResponseEntity

    🔽  개요

`Spring Framework`에서 제공하는 Class 중 `HttpEntity`라는 Class가 존재하는 것이에요.

이 친구는 `HTTP Request 또는 Response`에 해당 하는 `HttpHeader`와 `HttpBody`를 포함하는 Class인 것이에요.

 

public class HttpEntity<T> {

	private final HttpHeaders headers;

	@Nullable
	private final T body;
}

 

public class RequestEntity<T> extends HttpEntity<T>

public class ResponseEntity<T> extends HttpEntity<T>

 

`HttpEntity` Class를 상속 받아 구현한 Class가 바로 `RequestEntity`, `ResponseEntity` Class인 것이에요. `ResponseEntity`는 이용자의 `HttpRequest`에 대한 응답 Data를 포함하는 Class인 것이에요.

따라서 `HttpStatus`, `HttpHeaders`, `HttpBody`가 포함되는 친구인 것이에요.

 

`ResponseEntity`의 생성자를 살펴보면 `this()`를 통해 매개변수가 3개인 생성자를 호출하는데, 이를 통해 아래 Code 예시에서 보듯 매개 변수가 3개인 생성자로 가도록 작동하는 것이에요.

 

public ResponseEntity(HttpStatus status) {
	this(null, null, status);
}

 

public ResponseEntity(@Nullable T body, HttpStatus status) {
	this(body, null, status);
}

반응형

 

예를 들어 좀 더 정리를 해 볼게요!

 

예시 코드

@RestController
public class SampleController {

    @GetMapping("users")
    public ResponseEntity getAllUsers() {
        return new ResponseEntity(HttpStatus.OK);
    }
}

 

 

결과

 

위의 Code로 Postmans을 통해 Request를 던지면 Http Status Code가 200으로 돌아오는 것을 볼 수 있는 것이에요.

 

이 친구는 Http Status Code, Http Headers, ResponseData를 담는 생성자도 존재하는 것이에요.

public class ResponseEntity<T> extends HttpEntity<T> {
	
	public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatus status) {
		super(body, headers);
		Assert.notNull(status, "HttpStatus must not be null");
		this.status = status;
	}
}