Coding Convention

코드 일관성을 위해 코딩 컨벤션을 정의한다.

1. Server

Camel Case를 원칙으로 한다.

1.1 Controller

• restful api 원칙을 지킨다. (PUT/PATCH 를 구분한다)

1.2 Service

• rollback plan 을 가지고 있어야한다.
• boolean, integer의 리턴타입은 지양한다.
  • is~ Method 에서만 사용한다.

1.3 Model

• dto 간 데이터 변환은 mapstruct 를 사용한다.

1.4 Repository

• JPA QueryDSL 을 사용한다.
• update 시 JPA 영속성 컨텍스트를 사용한다.
• table 의 pk 는 id 가 아닌 명시적 id(book_id, order_id...) 를 사용한다.

1.5 Test

• Controller, Service, Repository 의 단위 테스트를 작성한다.
• Class, Method 별 단위 테스트를 작성한다.
• exception, 조건문의 단위 테스트를 작성한다.

Front