• [Default] Formatter 공통 적용하기

🔆 패키지 구조 및 네이밍

• package : com.prgrms.prolog

.
├── domain
│   ├── domain1 (user)
│   │   ├── api (Controller)
│   │   ├── dto (UserRequest, UserResponse..)
│   │   ├── exception (UnauthorizedException..)
│   │   ├── model (Email, User..)
│   │   ├── repository (UserRepostiory..)
│   │   └── service (UserService..) 
│   └›── domain2 (post)
│       ├── api
│       ├── dto│       ├── exception
│       ├── model (Post, PostLike..)   
│       ├── repository    
│       └── service
│   
└›── global
    └── config
		└── exception
		└── common (BaseEntity,BaseResponse..)   

• 🤔 예외상황에 대한 api 응답 메시지는 global - exception 아래에 위치
• global - commons
  • BaseEntity
  • 각종 “공통적인" VO 들

🔆  Service 내부에서 메소드 네이밍

• ex) PostService 내부에서 메소드 이름

  • 엔티티 이름 생략

  public interface PostService {
  		Long save (CreatePostRequest createPostRequest);
  }
  

  • 엔티티를 가져오는 메소드의 경우 find 보다는 get 을 사용 + 내부에서 “존재하지 않는 경우 예외처리"(의미가 더해짐) → ex) get, getAll, getAllByCategory
  • create
  • find
  • update
  • delete

🔆  Controller 내부에서 메소드 네이밍

• ex) PostController 내부에서 메서드 네이밍

  getSinglePost()
  

🔆 DTO 네이밍

• DTO

  • 이너클래스로 작성할 것인지 ? 클래스를 분리할 것인지? → 이너클래스 사용 ✅

    • 이너클래스 request, response
    • record 사용

    public class PostRequest{
     ....
    	record Create(...){}
    	record Update(...){}
    	
    }
    public class PostResponse{
    	...
    }
    

🔆 테이블 네이밍

• 데이터베이스 테이블의 이름은 기본적으로 단수 및 소문자로 사용, 단 DB 예약어의 경우 복수로 사용(user, order 같은 부분)
• 테이블 컬럼명
  • 소문자 + 언더바
  • 외래키일 때, user_id
• @Query(””” SELECT u.username FROM User u ”””);
• Wrapper 타입을 이용한다
  • Long, long