기술, 툴

• 프로젝트 사용 기술, 툴 정하기

  • Java 17
    • record 사용 가능
    • stream 관련 더 간결한 메소드 존재.
  • SpringBoot 2.7.7
    • 3.X.X 버전은 reference가 부족함.
  • DB : MySQL 8.0
    • 팀원들 모두가 공통적으로 사용할 수 있는 DB
  • Test DB : MySql
    • 도커 이용
    • 운영환경과 DB 를 같게한다.
  • TEST Framework: JUnit5, Mockito
  • Build Tool : Gradle
    • Maven에 비해서 dependency 파일의 가독성이 너무 좋음.
  • API 문서화 Tool : RestDocs
    • 비즈니스와 API 문서화 코드의 분리를 위해서 Swagger가 아닌 RestDocs.
  • 프로젝트 관리 툴
    • Jira vs Github issue + project

• rest api 컨벤션 → 프엔 협의 필요

• 예외 컨벤션 → 프엔 협의 필요

코드 패키지 구조

- └─domain
│  ├─performance
│  │  ├─controller
│  │  ├─dto
│  │  │   ├─ request
│  │  │   └─ response
│  │  ├─repository
│  │  └─service
│  └─user
└─ common
   ├─config
   ├─exception
   ├─dto
   ├─mapper
   └─model

컨벤션

코드 컨벤션

DTO 컨벤션

• 형식 : record로 관리한다. → Builder도 정해야할 듯
• 네이밍 : 끝에 DTO 빼고 UserCreateRequest, UserCreateResponse와 같이 작성한다.
  • 책임이 다르다면 필드와 검증 내용이 같더라도 분리한다.
• DTO ↔ Entity 변환 위치 : Mapper 사용 (mapconstruct 고려)
  • Entity → DTO 로직을 엔티티에 두면 엔티티가 DTO의 변화에 영향을 받게 되고 엔티티 로직이 비대해짐.
  • Entity → DTO 로직을 DTO에서 static 메서드로 하면 코드의 통일성이 흐트러진다.
  • 그러므로 Mapper를 사용하기로 함.

검증 컨벤션