컨트롤러 반환 타입 - DTO vs ResponseEntity 재논의

[june-777]

2024.08.13. 팀원 모두와 함께 논의한 내용입니다.

이전 회의에서 ResponseEntity 결정했던 배경

• DTO를 반환하도록하면, RestControllerAdvice에서 ResponsEntity로 매핑하는 로직이 필요함
• 이 때, 성공 상태코드를 세분화 (200, 201)하기 어렵다고 판단함
• 따라서 ResponseEntity 를 반환하도록 결정

재논의 하는 배경

• 컨트롤러의 메서드에 @httpstatus로 상태코드를 지정할 수 있다.
• 따라서, 기존에 어렵다고 생각된 이유는 해결되었고, DTO를 반환하는 형식의 구조적 간결성이 장점이라 생각들어 재논의
• 예외 처리를 ExceptionHandler에게 위임함으로서, 응답를 컨트롤러에서 동적으로 처리할 필요가 없어짐. 따라서 ResponseEntity를 반환할 필요성가 없어짐

DTO 반환 시 장단점

DTO 반환 시 장점:

1. 컨트롤러의 구조적 간결성과 ResponseEntity 설정 로직의 응집도 향상.
2. 컨트롤러 단위 테스트가 용이함.

DTO 반환 시 단점

1. 커스텀 헤더가 존재한다면 처리하기 까다로워질 수 있다.
2. 하지만 우리 서비스에서는 아직까지 커스텀헤더를 넣을일이 없기 때문에 현재까지는 큰 단점이 아니다.

결론

Controller에서는 @ResponseStatus로 상태값을 정의하고 ResponseDTO를 반환하도록하고, RestControllerAdvice에서 공통적으로 API Format에 맞게 매핑해주도록 설계하기.