패키지 구조

• src
  • java
    • domain
      • user
        • controller
        • service
          • impl
        • mapper
          • dto
          • entity
        • dto
          • controller
          • service
        • repository
        • entity
      • recipe
      • review
      • …
    • global
    • sample

Naming

• 축약어를 최소화하자
  • 웬만하면 다 써주자
  • 길이가 100자가 넘어가도 나쁠게 하나도 없다
• 클래스 명은 파스칼 케이스
  • 시작을 대문자로 시작하며, 나머지는 단어의 시작마다 대문자
  • 약어도 시작을 소문자로 적음
    • ex) URL → Url
  • ex) public class BoardController {…}
• 필드 명, 메소드 명은 카멜 케이스
  • 시작을 소문자로 시작하며, 나머지는 단어의 시작마다 대문자
  • 약어도 시작을 소문자로 적음
    • ex) URL → Url
  • ex) private String imageUrl;
• 필드는 명사로 시작과 끝을 맺음
  • 필드는 인스턴스의 상태를 나타냄
• 메소드는 동사로 시작 (끝은 명사로 맺어도 됨)
  • 메소드는 인스턴스의 행위를 나타냄

Package

• 소문자로 작명
• 띄워쓰기 금지
• 영어 소문자와 숫자로만 적음
  • 특수문자 금지
    • ex) org.springeel.config_jpa
• 옳바른 예시
  • org.springeel.config.jpa2

Annotation

• Lombok 관련된 annotation은 맨 위로 작성