ResponseEntity vs 공통 응답 객체 뭐가 옳은 결정일까요?

Question

안녕하세요 백엔드에 입문한지 얼마 안된 학생입니다.기능 구현을 하며 학습을 하던중 컨트롤러에서의 반환 방법에 대한 의문이 생겨 질문을 드리게 되었습니다.json값을 반환시 정형화된 값을 반환을 하고 싶어 학습을 하던중 컨트롤러 코드를 다음과 같이 작성하게 되었는데요.@PostMapping("/api/post")public ResponseEntity savePost(@RequestBody SavePostRequestDto requestDto) { PostResponseDto responseDto = postService.savePost(requestDto); return ResponseEntity.status(HttpStatus.CREATED).body(responseDto);}첫번째로 작성 했던 컨트롤러입니다.예외 발생시 서비스 레이어에서 예외를 던지도록 만들었습니다.현직 개발자 분께서 해주신 피드백으로는 ResponseEntity가 아닌 공통 응답 객체를 만들어 반환을 하는것이 좋다는 피드백을 받았습니다.@PostMapping("/api/post")public ApiResponse savePost@RequestBody SavePostRequestDto requestDto){PostResponseDto responseDto = postService.savePost(requestDto); return ApiResponse.createSuccess(200, "등록 성공", requestDto); }그래서 다시 작성한 컨트롤러입니다.성공 코드, 메세지, 데이터를 담는 공통 응답 객체를 만들었는데요.제가 드리고 싶은 질문은 첫째로 ResponseEntity의 사용을 지양해야 하는 이유가 있는지 입니다.ResponseEntity에 대한 개념과 여러 깃허브 코드를 보면 ResponseEntity를 사용하여 값을 반환하는 경우가 많은것 같아그저 공통 응답객체로 바꿔라 라는 답변에 대해 괴리감이 느껴집니다.두번째는 만약 다시 작성한 컨트롤러처럼 공통 응답객체를 사용한다면 예외 메세지 반환에도 공통 응답 객체를 사용해야 하는걸까요?현재 전역 예외처리 핸들러에도 ResponseEntity를 사용중이었어서 ResponseEntity 사용 부분을 전부 수정을 해야하는지가 궁금합니다.공통 응답 객체와 ResponseEntity 양쪽다 구글링을 해봤는데 둘 다 너무 정리가 잘되어있어서 무엇을 사용해야 할 지 고민이됩니다.그리고 선배님들께서는 어떤식으로 컨트롤러에서 값을 반환 하시는지도 여쭤보고 싶습니다.어떤 피드백 해주시던 감사한 마음으로 받겠습니다긴 질문글 읽어주셔서 감사합니다.

kyuho · Answer

ResponseEntity의 사용을 지양해야 하는 이유가 있는지사용을 지양해야 하는 이유는 없어요. 프로젝트 요구사항에 따라 ResponseEntity, 공통 응답 객체 중 하나를 선택해서 사용해요. 만약 클라이언트에게 ResponseEntity 보다 다양한 메타 데이터를 제공해야 한다면, 공통 응답 객체를 만들어서 사용하고요.공통 응답객체를 사용한다면 예외 메세지 반환에도 공통 응답 객체를 사용해야 하는걸까요?공통 응답 객체를 사용하면 좋아요. 클라이언트 입장에서는 응답 형식을 예측할 수 있고, 성공 및 실패 응답을 동일한 방식으로 처리할 수 있으니까요 😊 ResponseEntity, 공통 응답 객체의 선택은 일관된 구조, 유지보수, 확장성(추가 메타데이터) 이런 관점을 바탕으로 클라이언트, 서버 각각 입장에서 고민해보시면 생각이 정리되실 듯 해요.

chytonpide · Answer

제가 드리고 싶은 질문은 첫째로 ResponseEntity의 사용을 지양해야 하는 이유가 있는지 입니다.없습니다.근데 서버 클라이언트간 리스폰스 페이로드에 대한 컨벤션이 있어서 항상 Response 형태가 동일 해야 한다면, 개발할 때 그걸 타입으로 보장 받고 중복도 제거할 수 있으면 좋겠지요? 예를 들어 서버 클라이언트간 리스폰스 페이로드에 대해서 message 프로퍼티와 data 프로퍼티가 있어야 한다는 계약이 있으면(CustomEnvelope 타입을 써야한다 라는 계약.), ResponseEntity를 쓴다고 하면, CustomEnvelope resPayload &#61; new CustomEnvelope<PostResponseDto>(200, &#34;등록 성공&#34;, &#34;responseDto&#34;); return ResponseEntity.status(HttpStatus.CREATED).body(resPayload); 위처럼 되는데, 계속 위와 같은 코드가 반복될것 같으면 ApiResponse.createSuccess 를 정의해서 쓸 것 같아요! 두번째는 만약 다시 작성한 컨트롤러처럼 공통 응답객체를 사용한다면 예외 메세지 반환에도 공통 응답 객체를 사용해야 하는걸까요?네 아마도 클라이언트와 위와 같은 계약이 있을거기 때문에 에러도 봉투에 담어서 줘야 할 것 같아요.

カワウソ · Answer

ResponseEntity 쓰세요.

장독깨기 · Answer

전 공통으로 처리합니다.근데, 너무 정답을 찾으려고 하지 마세요.어떤 상황이 있으면, 그 상황에 맞춰서 개발하면 됩니다.

넹넹이 · Answer

ResponseEntity 사용을 지양해야하는 이유는 없습니다

집킨 · Answer

ResponseEntity> 도 가능합니다양쪽 모두의 장점을 누릴 수 있죠공통 응답을 제네릭으로 만드십쇼

개발잡부 · Answer

공통응답으로 해놓으면 프론트가 편해요. 그외 딱히 장점 없음

스윀 · Answer

@GetMapping(value = "/test", produces = "application/json") public ResponseEntity

ResponseEntity vs 공통 응답 객체 뭐가 옳은 결정일까요?

8개의 답변

Q&A 목록