네이밍

• 클래스 : UpperCamelCase, and·or와 같은 접속사를 사용하지 않고 25자 내외로 작성합니다.
• 함수 : lowerCamelCase
• 변수, 상수 : lowerCamelCase
• DB 테이블: lower_snake_case
• ENUM, 상수: Upper_snake_case
• 컬렉션(Collection): 복수형을 사용합니다. (Ex. users)
• LocalDateTime: 접미사에 Date를 붙입니다.

클래스명

• 각 패키지명을 접미사에 명시합니다.
• 구현체의 경우 ~ Impl를 접미사에 추가합니다. (ex. UserServiceImpl, UserRepositoryImpl)

controller: UserApiController
service: UserService
repository: UserRepository
dto/request: UserCreateRequest
dto/response: UserCreateResponse
entity: User
config: WebConfig
exception: EntityNotFoundException

메서드명

• event, design과 같은 이중적인 단어를 가지는 단어는 지양합니다.

• 메소드의 부수효과를 구체적으로 설명합니다.

  void getTemp() {
  	Object temp = findTemp();
  	if (temp == null) {
  		temp = new Temp();
  	}
  	return temp;
  }
  

  해당 예시에서, 단순히 Temp를 조회하는 것이 아니고 비어있으면 새롭게 생성하는 역할을 하고 있습니다. 따라서 getTemp 보다 getOrCreateTemp() 가 적절합니다. 단, 위는 예시일 뿐 한 개의 메소드는 한 개의 역할만 하는 것을 지향합니다.

• 의도가 전달되도록 최대한 간결하게 표현합니다.

• 메소드의 목적을 동사로 표현해 메소드의 앞에 붙입니다.

  • find~, add~, update~, remove~, create~