프로젝트 폴더 구조에 대한 논의

[ckdals4600]

폴더 구조

• 기존에 진행하던 방식대로 큰 틀은 domain, global으로 구분

• 아래는 각 폴더 및 파일들의 용어 및 사용 용도에 대해 작성한 내용입니다.

• 일단 생각나는 내용들 위주로 작성하였으며 확인 후 추가 및 수정 할 내용에 대해 답변해주시면 감사하겠습니다.

• domain

  • domain은 entity와 동일 X
  • 필요하다면 하나의 domain내에 1개 이상의 entity 포함 가능
  • 파일의 경우 마지막에 끝나는 접미사 통일

📁 domain
├─ 📂 api // swagger 문서 작성
├─ 📂 controller // api 
├─ 📂 service
│   ├─ 📄Facade  // 흐름 조율: 유스케이스 중심
│   ├─ 📄Service // 핵심 비즈니스 로직
│   ├─ 📄CommandService // 저장/수정 관련 로직
│   └─ 📄QueryService  // 조회 관련 로직
├─ 📂 repository 
│   ├─ 📄RepositoryImpl // 커스텀 쿼리 로직
│   └─ 📄Repository // 기본 Jpa 로직
├─ 📂 entity
├─ 📂 dto 
│   ├─ 📂 request
│   │   └─📄Req 
│   ├─ 📂 response
│   │   └─📄Res
│   └─ 📄Dto
├─ 📂 enums/type // 둘 다 많이 사용하는 용어라 아직 미정
│   └─ 📄Enum / Type
└─ 📂 error
    └─ 📄ErrorCode // 비즈니스 예외 사용 시 커스텀 예외 정의

• global
  • 아직 global 폴더의 기능은 확정하지 못했습니다. 아래 내용도 하나의 예시이며 해당 요소들이 global 폴더에 포함되어야 하는가에 대해서는 논의가 필요할 거 같습니다.

📁 global
├─ 📂common // 여러 도메인에서 사용되는 요소, 아래는 예시 폴더들
│   ├─ 📂constants // 상수
│   ├─ 📂converter
│   ├─ 📂dto
│   └─ 📂util // 암호화나 이미지 추출 같은 도구 느낌의 요소들
├─ 📂config // 설정 파일
├─ 📂security // jwt, Cors 같은 요소들
├─ 📂infra // 메일이나 redis 같은 외부 요소들
└─ 📂error // 비즈니스 예외 처리 요소

[ckdals4600]

@Goder-0 @minibr 확인 부탁드립니다.

[Goder-0]

오탈자가 있습니다

[ckdals4600]

알려주시면 수정하겠습니다

[Goder-0]

@ckdals4600
현재 구조에 대해서는 이해했습니다.
변경하고 싶은 포인트나, 변경해야한다고 느꼈던 경험이 있으신가요?
아니면 위의 내용이 현재 구조가 아닌 앞으로 지향하는 구조인가요?

[minibr]

구조는 이해했고 방향성에도 동의합니다.
이번 구조가 지향하는 방향이라면 CommandService / QueryService (CQRS)사용 가이드라인이 간략히라도 어느 정도 정리되어 있으면 더 일관성 있게 운영애있어 좋을 것 같습니다.

[ckdals4600]

6월 12일 백엔드 회의 결과

• config, security, infra 는 global 폴더와 동일 level 승격
• common 폴더 삭제 내부 폴더들은 global 폴더로 이동
• controller 내부에 api와 controller 파일 생성, api 폴더 삭제
• ci/cd 폴더 필요
• domain 이름을 가진 repository는 특정 entity가 아닌 해당 domain에 포함된 모든 entity를 이용한 쿼리 로직들이 존재