Naming Convention

📋 Naming Convention

✅ 개요

• 클래스 : UpperCamelCase, and·or와 같은 접속사를 사용하지 않고 25자 내외로 작성
• 메서드 : lowerCamelCase
• 변수 : lowerCamelCase
• DB 테이블: lower_snake_case
• 패키지: kebab-case
• ENUM, 상수: Upper_snake_case ex) ERROR_CODE
• 컬렉션(Collection): 컬렉션을 명시한다.
• LocalDateTime: 접미사에 Time을 붙인다. ex) currentDateTime
• LocalDate: 접미사에 Date를 붙인다. ex) todayDate

✅ 메소드 명

• 메서드 규칙 : lowerCamelCase
• 메서드가 하는 역할을 자세하게 설명하기!
• get/set 남발 금지 🥲🥲

Controller : 접두사 + 도메인

• getProject : 단 건 상세 조회 유형
• getProjectList : 목록 조회 유형
• addProject : 등록 유형
• modifyProject : 수정 유형
• removeProject : 삭제 유형

Service : 접두사 + 도메인

• getProject : 단 건 상세 조회 유형
• getProjectList : 목록 조회 유형
• addProject : 등록 유형
• modifyProject : 수정 유형
• removeProject : 삭제 유형

팩토리 메서드 명명 규칙

• from : 하나의 매개 변수를 받아서 객체를 생성
• of : 여러개의 매개 변수를 받아서 객체를 생성
• toEntity() : DTO에서 엔티티를 만들때 사용

Boolean 값 반환 메서드명 기준

• isNumber() : 맞는지 틀린지 체크
• hasData() : 가지고 있는지 체크
• canOrder() : 할 수 있는지 체크

✅ Reference

• 🔗 좋은 코드를 위한 자바 메서드 네이밍
• 🔗 Spring Convention