목차

코드 스타일 & 포매터

1. Java Naming

   • 클래스는 PascalCase
   • 변수/메서드는 camelCase
   • 상수는 UPPER_SNAKE_CASE

2. IntelliJ 설정

   • linter/formatter → 필요하다고 생각 들면 추후에 추가

   e.g. https://jino-dev-diary.tistory.com/69

패키지 구조

• 패키지 예시

도메인형 패키지 구조를 기반으로, 비즈니스 로직과 핵심 데이터 패키지를 분리합니다. api 패키지에는 Service, DTO, Controller를 두고, domain 패키지에는 entity와 repository를 둡니다. (위는 예시입니다!!)

<aside>

파일 네이밍 시

• Controller: DomainController.java
• Service: DomainService.java
• DTO: FeatureRequestDTO.java/FeatureResponseDTO.java
  • class / record 중 본인 판단 하에 필요한 걸로 하기
  • request와 response, result 패키지 구분
• Repository: DomainRepository.java
• Entity: Domain.java </aside>

공통 응답/예외 처리

1. 성공

   success, code, message, data 통일

2. 에러

   GlobalExceptionHandler 사용 + ErrorCode 커스텀 + GeneralException

   필요에 따라 각 도메인에서 handler 추가

3. 커스텀 에러

   enum: 명시적으로 알아볼 수 있도록 작성 (e.g. LETTER_NOT_FOUND)

   code: DOMAIN_40401

Git 브랜치 전략

브랜치 역할 정리

🔵 main

• 항상 배포 가능한 상태
• 운영 서버에 올라가는 코드
• 직접 작업 X
• PR로만 merge