🛠️ BE 코드 컨벤션

1. import문 설정

• 순서 : 인텔리제이 Code Style - Java - Import Layout에서 Layout static imports separately 적용한다.

import all other imports
import javax.*
import java.*
<blank line>
import static all other imports

• wildcard : 인텔리제이 Code Style - Java - Classcount to use … 및 Names count to use … 99로 설정한다.

2. 스타일 파일

• 인텔리제이 Code Style - Java - Schema에서 WootecoStyle 적용하여 일괄적으로 코드 스타일을 맞춘다.

3. 패키지 구조

• 패키지 구조는 도메인형으로 한다.

  • 계층형으로 했을 때에 패키지 안에 클래스가 쌓이며 가독성이 떨어진 경험이 있다.
  • 도메인으로 나눌 경우 각 기능에 따라 나뉘어 있어서 처음부터 파악하기 용이하다.

• 패키지 이름은 다음과 같다.

  - domain
      - controller
      - service
      - domain
      - repository
  

5. Controller

• 상태 코드 쉽게 설정하기 위해 ResponseEntity를 사용한다.

6. Service

• DTO를 파라미터로 받고, DTO를 반환한다.
• 변경 감지 기능 활용한다.

7. Domain

• equals & toString & hashcode
  • domain 및 entity에서 모두 재정의한다.
  • equals 시 id만 비교한다.
• id는 Long 타입을 사용한다.

8. Repository

• repository element 없을 때 get 함수를 추가로 작성해 find시 empty일 경우 예외를 발생시킨다.

9. DTO

static 메서드

• from : 파라미터의 개수가 1개일 경우 사용한다.
• of : 파라미터의 개수가 2개 이상일 경우 사용한다.
• toEnity, toDamain 사용한다.

9. 오류 및 예외처리

• handler를 사용하여 처리한다.
• 에러 메시지는 Enum으로 관리한다. 따로 커스텀 예외 클래스를 생성하지 않는다.
• ErrorHandler로 들어오는 것들은 로그를 남기고, 추후 필요한 것들에 대해서는 개인적 판단으로 로그를 남긴다.

10. 공통 스타일 가이드

메서드

• public 메서드내의 private 메서드는 public 메서드와 가까운 아래 위치시킨다.
• private이 계속 사용될 경우, 가장 처음 사용한 public 메서드 아래에 위치한다.
• 컨트롤러와 서비스에서 모두 create, read, update, delete로 작성하고, CRUD 순서대로 정렬한다.
  • 협업할 때 처음 해당 코드를 보는 사람이 순차적으로 코드 의미 파악하기가 더 용이하다.

개행

• class 첫 필드는 한 줄 개행 후 작성한다.
• class 마지막 중괄호는 method 마지막 중괄호 한 줄 아래 위치하도록 한다.
• 메서드 내의 개행은 논리적 단위로 삽입한다.

어노테이션

• 어노테이션 정렬 순서는 중요도가 높은 것부터 클래스 가까이 둔다.
• 롬복 등 getter, setter 자동 생성 어노테이션은 사용하지 않는다.

yml

• OSIV 설정 끄고 시작한다.

11. 테스트

DisplayName

• [기능] 성공 : ~ 경우 (생략 가능)
  • ex) 회원가입 성공, 회원가입 실패: 이메일 중복인 경우
• (긍정) 메서드명 + 상황 있을 경우 _상황
  • ex) login / save
• (부정) 메서드명_실패이유_exception
  • ex) login_passwordMismatch_exception / save_duplicatedName_exception

TDD

• TDD의 경우, 희망하는 인원만 진행하도록 한다.
• domain
  • 유닛 테스트 진행한다.
• service
  • fixture 만들어서 사용한다.
  • 테스트용 DB를 사용한다.
• controller

  • fixture 만들어서 사용한다.

  • E2E로 진행한다.

  • 다이나믹 테스트를 선택적으로 도입한다.

  • repository

    • 쿼리문을 따로 작성하는 경우에만 테스트용 DB로 작성한다.

진행

• 일주일 동안 페어를 진행해 본 후, 추후 지속 여부를 결정한다.
• 문서화는 노션과 swagger UI로 진행한다.