백엔드 코드 컨벤션

💡 우테코 자바 컨벤션 을 기본으로 한다.

공통

• static import 문을 최상단에 작성한다.
• 매개변수에 final은 붙이지 않는다.
• 파라미터로 받아온 값을 변경시키지 않는다.
• 롬복을 사용한다.
• 중요도가 높은 어노테이션을 상단에 작성한다.
• getter, setter, equals, toString 순으로 작성한다.

네이밍

• 축약하지 않는다.
• Dto 클래스명은 행위+도메인명+Response/Request 을 따른다. (ex. CreateMemberRequest)
• User 대신 Member를 사용한다.
• 테스트 메서드는 영어로 한다.
• @DisplayName은 형식은 다음과 같다. (ex. 자동차 이름 입력 실패: 쉼표만 입력)

예외

• 커스텀 예외는 CodeZapException을 사용한다.
• 커스텀 예외는 HttpStatusCode를 필드로 가진다.

패키지 구조

• 도메인형 패키지 구조를 사용한다.
• 도메인 패키지 안에서 Controller, Service, Domain, Repository, Dto 등의 패키지를 구분한다.
• Controller - Service - Repository의 웹 계층 준수한다.
• Dto 패키지 안에서 response, request 패키지를 구분한다.