컨트롤러에서 클라이언트로 넘기는 DTO 사용하실 때 어떻게 생성, 리턴 하시나요?

Question

안녕하세요.현재 Rest API 구현하는 백엔드쪽 업무를 맡고 있습니다. 이전에 DTO관련해서 이리저리 질문하다가, 어느정도 궤도에 들었나 싶었는데다시 한번 코드를 보니 여전히 이 방법이 맞나 싶어서 다시 질문을 올립니다. 기준은 회원조회로 하겠습니다. 서비스에서 유저를 조회하고, 조회된 데이터로 UserInfoEntity가 생성되었습니다. (여러 의견이 있지만) 저는 서비스에서는 생성된 데이터를 그대로 반환해야 한다고 생각해서Entity를 그대로 호출자 (컨트롤러)에게 리턴하고 있습니다. 그 후 DTO의 목적대로 이 Entity에서 필요한 데이터만 골라서 DTO 객체를 생성한 뒤클라이언트한테 응답해주는 방식인데요. 그 때 사용한 코드가 이렇습니다. public ResponseEntity findUserInfoList(){ return ResponseEntity.status(200).body(new UserDashBoardRes.UserInfoListRes(userDashBoardService.findUserInfoList())); } DTO 객체를 모두 하나씩 클래스파일로 생성하자니 너무 복잡하게 많아질것 같아비슷한 성격의 클래스를 만들고, 내부에 이너클래스로 DTO 객체를 만들어뒀습니다. 그러다보니 응답객체타입도 ResponseEntity 처럼 뭔가 길어지고 DTO 객체를 생성할때도 new UserDashBoardRes.UserInfoListRes(userDashBoardService.findUserInfoList()) 이렇게 되니 뭔가 한눈에 알아보기 어려운(?) 스파게티 코드가 되어버린 느낌입니다..지금이야 한줄이니 그나마 낫지만 다른 코드가 섞이는 순간 어우... 지금 그런데가 있긴 합니다. 이론은 아는데 쓰는 방법이 뭔가 잘못되지 않았..나..? 싶습니다만그럼 이렇게 말고 어떻게 DTO를 생성해서 사용하는거지? 싶은 상황인데요. 올바르게 쓰고 있는게 맞는지.. 아니면 정말 올바르게 사용하는 DTO 생성 및 반환하는 형태가 어떤지 알고 싶습니다.

도각도각 · Answer

저도 13년을 넘게 개발하고 있지만, 할때마다 고민이 되는 부분입니다. 현재의 결론은.. 필요한 모든 DTO 객체를 만듭니다. 동일한 프로퍼티를 가지고 있더라도, 사용하는 목적이나 사용되면 API가 다르다면.. (추후 변경 여지가 있다면) 나눠서 추가합니다. 이너클래스도 만들어보고, 동일한 프로퍼티도 상속시켜보고 했습니다만.. DTO는 대략적으로 3개의 타입으로 나누고 있습니다. Command / Query / One (조회객체) 그래서 각각의 설정이 필요한 기본 프로퍼티를 지정하고, 해당 객체 (Command / Query / One) 를 상속 받아 구현하고 있습니다. 조회하여 클라이언트단으로 내려주는 One 객체의 경우는 Repo에서 DTO(One) 객체로 리턴하고 있습니다. 정답은 없고, 프로젝트마다 조금씩 변경하여 사용하고 있습니다.

183183 · Answer

클래스 이름에서 겹치는 부분(User , Res 등)이 있어 그렇게 생각이 드는 것 같네요내부에 이너클래스로 선언 했다는 건 캡슐화가 되어있기 때문에 똑같은 단어를 다시 쓸 필요 없습니다. 제가 구현했다고 하면List 이렇게 사용 할 것 같네요list를 밖으로 뺀건 info하나만 보내는 경우 , list로 보내는 경우 두 경우 생각해서 뺐습니다 request를 받을때도 사용하는게 dto 이기 때문에 res라는 단어는 응답만 하는 느낌이라서 위처럼 dto로 바꾸는게 어떨까 싶네요 앞에 ResponseEntity<>가 붙는건 크게 신경안쓰셔도 될 것 같아요. 사람마다 사용하는 방식이 다르니 참고만 하시면 좋을 것 같습니다.

카카오콘 · Answer

&#64;도각도각 님 // 답변 감사합니다. 우선 정답이 없는것은.. 언제나 옳은 내용이지만 여전히 슬프게 들리는 내용입니다.. DTO를 다방면으로 쓰기에는 아직 익숙치 못한 상황에서 너무 꼬일것 같아 컨트롤러 반환시에만 사용해보려 합니다. 이런 제 상황에, 제 질문처럼 서비스에서 UserInfoEntiy가 생성되었고, 이 데이터에서 일부를 제거한DTO를 컨트롤러가 생성해서 반환하는 작업을 한다고 한다면 도각도각님께서는 어떻게 코드를 작성하시련지 여쭤봐도 될까요?

카카오콘 · Answer

&#64; 183183 님 // 답변 감사합니다. 우선 여기까지 보셨을 때 아, 방법자체가 잘못되었다. 라는 내용보단중복된 내용들 같은 부분 때문에 그렇게 느껴질 수 있다. 라는 말씀이신거네요. res를 붙인 이유는 요청 DTO 클래스 / 응답 DTO 클래스 를 서로 분리해서 그렇습니다. 혹시 이너클래스로 쓴다고 한다면 request DTO / response DTO를 모두 한 클래스파일로 관리하시나요? 방식은 여러가지지만 그 중 편하고 더 좋은 방법을 찾고 있는것이기 때문에 이런 답변까지 저는 너무 감사하게 생각하고 있습니다.

도각도각 · Answer

저는 일단 BaseApiController를 만들어, 모든 ApiController에서 상속받아 사용하고 있습니다. BaseApiController에.. 대략적으로.. 아래와 같은 메서드를 통해서 리턴하고 있습니다. protected ResponseEntity ok(Object object) { return ResponseEntity.ok(ApiResponse.ok(object)); } 제가 만약 한다면.. @GetMapping("/api/users") public ResponseEntity users(@ModelAttribute UserQuery query) { return ok(userService.findByQuery(query).toRes())); } 이렇게 하겠네요. toRes 메서드는 UserInfoEntity 객체가 가지고 있게요.

183183 · Answer

카카오콘저는 이너클래스로 관리하면 dto에 5개를 만듭니다 save (create) , search(read) ,Info(read) , update(update) , delete(delete) search같은경우 페이징이나 이름별 검색 등등 검색관련 dto입니다res는 info이고 나머지는 모두 req입니다

컨트롤러에서 클라이언트로 넘기는 DTO 사용하실 때 어떻게 생성, 리턴 하시나요?

6개의 답변

Q&A 목록