[베이스 코드]백엔드 개발 명세서

[polyglot-k]

Architecture

• DDD 기반의 아키텍처를 통한 구조화
• api, common, domain 패키지 구조를 분리
  • api 패키지
    • Presentation Layer 들이 포함되어있음.
  • common 패키지
    • config 나 공통으로 사용이 될 수 있는 요소들이 포함.
  • domain 패키지
    • domain 을 기준으로 service, repository 에 대한 로직 포함, 이는 하나의 service 모듈 단위로써, 사용

Service 명세

• auction (경매)

  • 경매를 생성, 종료
  • 경매에 대한 정보를 가져올 수 있음.

• bid (입찰) - auction 생성이 필수 선행 조건

  • 입찰 진행, 금액 수정

  적절한 기저 필요

• product (제품) - 경매와 1대1 대응 관계

  • 제품을 등록
  • 이미지를 생성( Bulk Upload 지원)

• review (리뷰)

  • 최종 입찰이 완료된 사용자만 쓸 수 있음
  • 글을 쓴 이후, 수정 및 삭제 불가

• user

  • 일반적인 유저의 동작

기본 컨벤션

1. DTO 내부의 비즈니스 로직 최소화
2. service 로직 내부에서 객체를 지속적으로 생성하는 것보다는 해당 책임을 entity 쪽으로 추가하는 것이 단일 책임 원칙에 맞음
3. god class 가 되지 않도록 DTO 를 적절히 활용
4. Query 에 대한 성능을 확인한 이후에, Custom Repository 를 해야할지에 대한 유무를 반드시 확인 후 진행 -> 무조건적인 JPA 가 좋은 것은 아님