네이밍 컨벤션

• 변수/함수 : camelCase
• 클래스 : PascalCase
• 상수 : UPPER_CASE
• DTO
  • 요청 - *Request
  • 응답 - *Dto
  • 커서 기반 페이지 응답 - CursorPageResponse*

코드 컨벤션

• 코드 들여쓰기 방식

  • 공백 4칸 기준
  • 메서드 간에는 1줄 띄어쓰기

• 주석 스타일

  • 클래스, 메서드에는 Javadoc 주석 사용
    • 서비스, 컨트롤러, 레파지토리
  • 내부 설명은 // 한 줄 주석으로 작성
  • 불필요한 주석 또는 주석 처리된 코드는 작성 금지

• 코드 구성 순서

  • 클래스 내 구성은 다음 순서로 정렬
    • 필드 → 생성자 → 메서드 순

• Lombok 사용 규칙

  • 생성자 및 getter/setter는 Lombok으로 처리

• 로그 출력 방식

  • log.info("회원 ID: {}", userId); 형식 통일

• 패키지 구조

  • 도메인형 구조

  com.example.myproject
  ├── global         ← 전역 사용 항목
  │   ├── config
  │   │   └── SwaggerConfig.java
  │   ├── exception
  │   │   └── GlobalExceptionHandler.java
  │   ├── dto        # 전역에서 사용되는 DTO가 있다면 (PageResponse, ErrorResponse 등)
  │   ├── util       # 유틸 클래스들 (DateUtil, StringUtil 등)
  │   └── base       # 공통 엔티티(BaseEntity), 공통 응답 클래스 등
  ├── domain         ← 도메인별 기능 모듈
  │   ├── user
  │   │   ├── controller
  │   │   │   ├── api
  │   │   │   └── UserController.java
  │   │   ├── service
  │   │   ├── repository
  │   │   ├── entity
  │   │   ├── mapper
  │   │   └── dto
  │   │        └── data
  │   │        └── request     
  │   └── notification
  │       ├── controller
  │       ├── service
  │       ├── repository
  │       ├── entity
  │       ├── mapper
  │       └── dto
  └── Application.java 
  

• 예외 처리 기준

  • 예외 처리는 service 계층에서 수행

  • Controller에서는 예외를 던지고, 전역 예외 처리(@RestControllerAdvice)에서 공통 응답 처리

  • 공통 응답 예시

    {
      "timestamp": "2025-03-06T05:39:06.152068Z",
      "status": 400,
      "message": "잘못된 요청입니다.",
      "details": "부서 코드는 필수입니다."
    }
    

유효성 검사

Swagger UI

• 사용자(UserRegisterRequest, UserLoginRequest,UserUpdateRequest)
  • 이메일
  • 닉네임
  • 비밀번호

예외처리

classDiagram
    class RuntimeException

    class BaseException {
        <<abstract>>
        +Instant timestamp()
        +String getMessage()
        +String getDetails()
        +HttpStatus getHttpStatus()
    }

    class CustomException {
		  
    }

    BaseException --|> RuntimeException
    CustomException --|> BaseException

• 공통예외
  • 비 로그인 요청: MissingRequestHeaderException
  • 유효하지 않은 요청 : InvalidRequestException
  • 인증 실패 : AuthenticationException
  • 정렬/필터 조건이 유효하지 않음 : InvalidQueryParameterException
  • 파일 저장/삭제 실패 : FileIOException

Git

커밋 컨벤션