요구사항

• 키오스크 주문을 위한 상품 후보 리스트 조회하기
  • 상품 후보 리스트 조회 API 필요
• 상품의 판매 상태 : 판매중, 판매보류, 판매중지
  • 이 중 판매중, 판매보류인 상태의 상품을 화면에 보여줘야 합니다.
• 화면에서 필요한 정보는 [id, 상품 번호, 상품 타입, 판매 상태, 상품 이름, 가격] 입니다.

코드 작성

Product 엔티티

@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED) //...1
@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String productNumber; //...2

    @Enumerated(EnumType.STRING)
    private ProductType type; //...3

    @Enumerated(EnumType.STRING)
    private ProductSellingStatus sellingstatus; //...4

    private String name;

    private int price;

}

1. @NoArgsConstructor(access = AccessLevel.PROTECTED)

   → 자세히

2. productNumber

   • 상품 번호
   • 3자릿수 숫자로 001, 002 처럼 뻗어나가는 것으로 정의하겠습니다.

3. type

   • 상품 타입

   • enum 타입

     @Getter
     @RequiredArgsConstructor
     public enum ProductType {
     
         HANDMADE("제조 음료"),
         BOTTLE("병 음료"),
         BAKERY("베이커리");
     
         private final String text; //...1
     
     }
     

4. sellingStatus

   • 판매 상태

   • enum 타입

     @Getter
     @RequiredArgsConstructor
     public enum ProductSellingStatus {
     
         SELLING("판매중"),
         HOLD("판매보류"),
         STOP_SELLING("판매중지");
     
         private final String text; //...1
     
     }
     

     1. enum 에 설명 필드 같은 것을 텍스트로 두는것을 선호합니다. 내부적으로 설명하는 값을 주석으로 다는 것 보다 필드로 두는 것이 낫다고 생각합니다.

BaseEntity

보통 엔티티 같은 경우는 BaseEntity 를 상속받게 해서 엔티티가 생성된 시간과 변경된 시간을 추적합니다. 이렇게 트래킹 하는 것을 JPA에서 제공해줍니다. (Jpa Auditing 이라고 합니다.)

@Getter
@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public abstract class BaseEntity {

    @CreatedDate
    private LocalDateTime createdDateTime;

    @LastModifiedDate
    private LocalDateTime modifiedDateTime;
}

1. BaseEntity 자체로는 인스턴스로 만들 필요가 없기 때문에 추상클래스로 만들겠습니다.