[Spring] ResponseEntity란?

우리는 RESTful API로 설계하는 것이 좋은 설계라고 배웠다. 그럼 RESTful API를 위해 우리는 클라이언트와 서버 간의 통신에 대한 필요한 정보를 클라이언트한테 전달해줘야한다. 그때 유용하게 사용할수 있는것이 ResponseEntity이다.

ResponseEntity

ResponseEntity는 Spring 프레임워크에서 제공하는 클래스 중 HttpEntity라는 클래스가 존재하는데 ResponseEntity는 RequestEntity와 더불어 HttpEntity클래스를 상속받아 구현한 클래스이다. 클래스의 이름 그대로 Request는 클라이언트로부터 요청을, Response는 서버로부터 클라이언트에게 요청에대한 결과를 담는 Entity로서 기존에 dto를 통해 객체상태로 응답되던 것을 해당클래스에 여러가지 http요청결과,데이터 등 담아서 더욱 자세하게 요청에 대한결과를 응답할수 있게되었다.

그럼 자세하게 ResponseEntity를 한번 뜯어 살펴보자.

ResponseEntity의 구현된 인터페이스를 살펴보면 바디,헤더,상태코드로 순으로 생성자가 만들어진다는것을 알수있다.

다시 정리해서 헤더에는 클라이언트로부터 요청한 사항에 대한 응답이 담겨있으며, 바디에는 데이터값이 담겨있다. 상태코드는 요청에대한 결과가 3자리 숫자의 코드로 들어가있다.

이와 같이 해당 데이터가 null값으로 존재하면 상태코드와 바디에 메세지를 보내 클라이언트에게 응답할수있으며 객체형태의 데이터 또한 바디에 담아 응답할수있다.