백엔드 개발문서

1️⃣ 코드 컨벤션

코드 컨벤션은 기본적으로 Google Java Style Guide를 따른다.

추가적으로 정의한 하루스터디만의 코드 컨벤션은 아래와 같다.

1.1 테스트

1.1.1 네이밍

• 테스트 메소드명은 기본적으로 한글로 작성한다.
• 기능을 하나의 테스트 메소드로 검증하는 경우에는, 기능을 메소드명으로
• 여러 메소드로 하나의 기능을 검증하는 경우에는, Nested Class명을 기능으로, 메소드명을 입/출력으로(예시)

1.1.2 패턴

• BDD 스타일(given, when, then)으로 작성한다.

1.1.3 규칙

• 성공하는 케이스와 실패하는 케이스에 대한 테스트는 메소드를 분리한다.
• 동일한 케이스를 검증하는데 여러 파라미터가 필요한 경우, @ParameterizedTest를 사용한다.

1.2 클래스, 메소드

1.2.1 공통

• 정적 팩토리 메소드는 다음과 같은 경우에만 사용한다.

  • 도메인 -> DTO 변환 시
  • enum 내부에서 enum 객체 반환 시

• 생성자가 여러개인 경우 생성자 체이닝을 사용한다.

1.2.2 DTO

• UI와 관련된 DTO는 Request, Response 접미사를 붙인다.
  • 이외의 DTO는 모두 DTO 접미사를 붙인다.