[Spring] 🌱 ResponseEntity

---

🌱 ResponseEntity

스프링에서는 ResponseEntity라는 것을 제공합니다.

기존 제 개인 프로젝트에서 저는 아래와 같이 그저 값 자체를 반환하곤 했었습니다. @RestController 어노테이션을 달아두고 반환값을 객체로 하게 된다면 Jackson 라이브러리가 응답 객체를 JSON으로 변환하여 주었습니다. 하지만 이러한 방법처럼 객체를 return 하는 경우 HTTP 응답을 제어할 수 없다는 단점이 존재합니다.

@GetMapping
    public List<PostResponseDto> findAllPosts() {

    return postService.findAllPosts();
}

그러나 일반적인 API에서 반환하는 리소스를 생각해본다면 단순한 객체 Value만 있지 않고 상태코드, 응답 메세지 등이 포함되어 있다는 걸 알 수 있습니다. 이러한 응답을 보낼 수 있도록 도와주는 것이 ResponseEntity입니다.

ResponseEntity는 내부 필드 변수로 status를 가져야 하기에 생성시에 status 값을 반드시 추가해 주어야 합니다.

또한 제네릭을 통해 body 부분에 원하는 객체를 집어넣어 응답할 수 있습니다.

ResponseEntity 적용하기

ResponseEntity는 매개변수로 body, HttpStatusCode 를 담아 생성할 수 있습니다.

new ResponseEntity<>(body,httpStatusCode);

간단한 응답 만들기

우선 간단하게 상태코드와 메세지를 반환하고 싶다면

public class Message {

    private int statusCode;
    private String message;
}

응답으로 보낼 값들을 담을 수 있는 객체를 하나 생성하고

@GetMapping
public ResponseEntity<Message> test() {
	Message message = new Message(HttpStatus.OK, "ResponseEntity 응답 성공");
    return new ResponseEntity<>(message,HttpStatus.OK);
}

위와같이 return 값으로 ResponseEntity에 body, statusCode를 전달하여 객체를 반환하면

{
    "statusCode": 200,
    "message": "ResponseEntity 응답 성공",
}

위와같은 응답을 받을 수 있습니다.

데이터를 담고있는 응답 만들기

public class Message<T> {

    private int statusCode;
    private String message;
    private T data;
}

위와같이 data를 담을 필드 변수를 추가하여

@GetMapping
    public ResponseEntity<Message> findAllPosts() {

	List<PostResponseDto> postResponseDtos = postService.findAllPosts();
	Message message = new Message(HttpStatus.OK, "전체 게시물 조회 성공",postResponseDtos);
    return new ResponseEntity<>(message,HttpStatus.OK);
    
}

ResponsEntity를 반환해 준다면, 아래와 같이 응답에 데이터를 추가하여 반환할 수 있습니다.

{
    "httpStatus": "OK",
    "message": "전체 게시물 조회 성공",
    "data": [
        {
            "id": 2,
            "title": "title",
            "content": "content",
            "author": "jihyun",
            "createdAt": "2023-09-05T02:23:04.44935",
            "modifiedAt": "2023-09-05T02:23:04.44935"
        },
        {
            "id": 1,
            "title": "title",
            "content": "content",
            "author": "jihyun",
            "createdAt": "2023-09-05T02:23:03.730723",
            "modifiedAt": "2023-09-05T02:23:03.730723"
        }
    ]
}

---

🌱 ResponseEntity를 생성하는 두 가지 방법

responseEntity를 생성하는 방법에는 두가지가 있습니다.

하나는 위에서 다뤘던 new 키워드를 통한 생성자 호출이고,

new ResponseEntity<>(body,httpStatusCode);

두번째 방법은 빌더 패턴을 사용하는 것 입니다.

return ResponseEntity.ok()
	.headers(headers)
	.body(body);

위와같이 메소드 체이닝으로 연결하여 ResponseEntity를 생성하는 것도 가능합니다.