도메인 분석 설계

※ 요구사항 분석

 

 

기능 목록

 

- 회원 기능

 

• 회원 등록
• 회원 조회

- 상품 기능

 

• 상품 등록
• 상품 수정
• 상품 조회

- 주문 기능

 

• 상품 주문
• 주문 내역 조회
• 주문 취소

- 기타 요구사항

 

• 상품은 제고 관리가 필요하다.
• 상품의 종류는 도서, 음반, 영화가 있다.
• 상품을 카테고리로 구분할 수 있다.
• 상품 주문시 배송 정보를 입력할 수 있다.

 

 

※ 도메인 모델과 테이블 설계

 

 

1. 회원은 여러 상품을 주문할 수 있다.

2. 한 번 주문시 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계이다.

     다대다 관계는 RDB, 엔티티에서 거의 사용하지 않으므로, 주문상품이라는 엔티티를 추가해서

     다대다 관계를 일대다, 다대일 관계로 설정하였다.

3. 상품은 도서, 음반, 영화로 구분되며 상품이라는 공통 속성을 사용하므로 상속 구조로 표현하였다.

 

 

★ 회원 엔티티 분석

 

 

- 회원(Member) : 이름, 임베디드 타입인 주소(Address), 그리고 주문(orders) 리스트를 가진다.

 

- 주문(Order) : 한 번 주문시 여러 상품을 주문할 수 있으므로 주문과 주문상품(OrderItem) 은 일대다 관계다.

   주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태(status) 를 가지고 있다.

   주문 상태는 열거형을 사용했는데 주문(Order), 취소(Cancel) 을 표현할 수 있다.

 

- 주문상품(OrderItem) : 주문한 상품 정보와 주문 금액(orderPrice), 주문 수량(count) 정보를 가지고

   있다. (보통 OrderLine, LineItem 으로 많이 표현)

 

- 상품(Item) : 이름, 가격, 재고수량(stockQuantity) 을 가지고 있다.

   상품을 주문하면 재고 수량이 줄어들고, 종류로는 도서, 음반, 영화가 있으며 각가은 사용하는 속성이 다르다.

 

- 배송(Delivery) : 주문시 하나의 배송 정보를 생성한다. (주문과 배송은 일대일 관계)

 

- 카테고리(Category) : 상품과 다대다 관계를 맺는다. (parent, child 로 부모, 자식 카테고리 연결)

 

- 주소(Address) : 값 타입(임베디드 타입) 이다. (회원과 배송에서 사용)

 

 

★ 회원 테이블 분석

 

 

MEMBER : 회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어갔다.

                     DELIVERY 테이블도 마찬가지로 들어갔다.

 

ITEM : 앨범, 도서, 영화 타입을 통합하여 하나의 테이블로 만들었다.

             DTYPE 을 통해 타입을 구분할 수 있다.

 

참고1 : 테이블명이 ORDER 가 아니라 ORDERS 인 것은 데이터베이스가 order by 때문에 예약어로

잡고 있는 경우가 있다.

따라서 관례상 ORDERS 를 많이 사용한다고 한다.

 

참고2 : 실제 코드에서는 DB에 소문자 + _(언더스코어) 스타일을 사용한다.

데이터베이스 테이블명, 컬럼명에 대한 관례는 회사마다 다르다고 한다.

보통은 대문자 + _(언더스코어) 또는 소문자 + _(언더스코어) 방식 중 하나를 지정해서 일관성 있게 사용한다.

앞으로 진행할 코드에서는 소문자 + _(언더스코어) 스타일로 할 것이다.

 

 

★ 연관관계 매핑 분석

 

회원과 주문 : 일대다, 다대일의 양방향 관계이다.

따라서 연관관계의 주인을 정해양 하는데, 외래 키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. 

그러므로 'Order.member' 를 'ORDERS.MEMBER_ID' 외래 키와 매핑한다.

 

주문상품과 주문 : 다대일 양방향 관계이다.

외래 키가 주문상품에 있으므로 주문상품이 연관관계의 주인이다.

그러므로 'OrderItem.order' 를 'ORDER_ITEM.ORDER_ID' 외래 키와 매핑한다.

 

주문상품과 상품 : 다대일 단방향 관계이다.

'OrderItem.item' 을 'ORDER_ITEM.ITEM_ID' 외래 키와 매핑한다.

 

주문과 배송 : 일대일 단방향 관계이다.

'Order.delivery' 를 'ORDERS.DELIVERY_ID' 외래 키와 매핑한다.

 

카테고리와 상품 : @ManyToMany 를 사용해서 매핑한다.

(실무에서 @ManyToMany 를 사용하지 않음)

 

참고로 외래 키가 있는 곳을 연관관계의 주인으로 정해야 한다.

 

 

※ 엔티티 클래스 개발

 

 

Member Class

@Entity
@Getter @Setter
public class Member {

    @Id @GeneratedValue
    @Column(name = "member_id")
    private Long id;

    private String name;

    @Embedded
    private Address address;

    @OneToMany(mappedBy = "member")
    private List<Order> orders = new ArrayList<>();
}

 

- id : 주요키로 @Id, @GeneratedValue, @Column(name = "~") 을 달아준다.

- address : 내장형으로 주소 타입이 들어갈 수 있음을 암시한다.

- orders : orders 필드는 member 에 의해 매핑된다.

 

 

Order Class

@Entity
@Table(name = "orders")
@Getter @Setter
public class Order {

    @Id @GeneratedValue
    @Column(name = "order_id")
    private Long id;

    @ManyToOne
    @JoinColumn(name = "member_id")
    private Member member;

    @OneToMany(mappedBy = "order")
    private List<OrderItem> orderItems = new ArrayList<>();

    @OneToOne
    @JoinColumn(name = "delivery_id")
    private Delivery delivery;

    private LocalDateTime orderDate; // 주문시간

    @Enumerated(EnumType.STRING)
    private OrderStatus status; // 주문상태 [ORDER, CANCEL]
}

 

- id : 주요키이다.

- member, delivery : 외래키로 설정된다.

- orderItems : order 에 의해 매핑된다.

 

 

Delivery Class

@Entity
@Getter @Setter
public class Delivery {

    @Id @GeneratedValue
    @Column(name = "delivery_id")
    private Long id;

    @OneToOne(mappedBy = "delivery")
    private Order order;

    @Embedded
    private Address address;

    @Enumerated(EnumType.STRING)
    private DeliveryStatus status; // READY, COMP
}

 

- order : delivery 에 의해 매핑된다. (Order의 delivery)

 

 

OrderItem Class

@Entity
@Getter @Setter
public class OrderItem {

    @Id @GeneratedValue
    @Column(name = "order_item_id")
    private Long id;

    @ManyToOne
    @JoinColumn(name = "item_id")
    private Item item;

    @ManyToOne
    @JoinColumn(name = "order_id")
    private Order order;

    private int orderPrice; // 주문 가격
    private int count; // 주문 수량
}

 

- item, order : 외래키이다.

 

 

Item Class 

@Entity
@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
@DiscriminatorColumn(name = "dtype")
@Getter @Setter
public abstract class Item {

    @Id
    @GeneratedValue
    @Column(name = "item_id")
    private Long id;

    private String name;
    private int price;
    private int stockQuantity;

    @ManyToMany(mappedBy = "items")
    private List<Category> categories = new ArrayList<>();
}

 

- 추상클래스로 단일 테이블로 Album, Book, Movie 모든 데이터를 하나의 테이블로 관리한다.

- categories : items 에 의해 매핑되어진다.

 

 

Album, Book, Movie Class

@Entity
@DiscriminatorValue("A")
@Getter @Setter
public class Album extends Item {

    private String artist;
    private String etc;
}

@Entity
@DiscriminatorValue("B")
@Getter @Setter
public class Book extends Item {

    private String author;
    private String isbn;
}

@Entity
@DiscriminatorValue("M")
@Getter @Setter
public class Movie extends Item {

    private String director;
    private String actor;
}

 

 

Category Class

@Entity
@Getter @Setter
public class Category {

    @Id @GeneratedValue
    @Column(name = "category_id")
    private Long id;

    private String name;

    @ManyToMany
    @JoinTable(name = "category_item",
        joinColumns = @JoinColumn(name = "category_id"),
            inverseJoinColumns = @JoinColumn(name = "item_id"))
    private List<Item> items = new ArrayList<>();

    @ManyToOne
    @JoinColumn(name = "parent_id")
    private Category parent;

    @OneToMany(mappedBy = "parent")
    private List<Category> child = new ArrayList<>();
}

 

- items : 다대다 관계를 갖으며 @joinTable 을 이용한 것을 볼 수 있다.

   테이블 명을 category_item 으로 지정하며, 외래키로 지정되었다.

- parent : 다대일 관계를 갖으며 외래키로 parent_id 이다.

- child : 일대다 관계를 갖으며 parent 에 의해 매핑되어진다.

 

 

위와 같은 엔티티 클래스를 만들었다.

이제 실행을 하면 h2 database 에 테이블이 생성된 것을 확인할 수 있다.

 

 

Address Class 

@Embeddable
@Getter
public class Address {

    private String city;
    private String street;
    private String zipcode;

    protected  Address() {}
    
    public Address(String city, String street, String zipcode) {
        this.city = city;
        this.street = street;
        this.zipcode = zipcode;
    }
}

 

주소 클래스는 @Setter 가 없다.

즉, 생성자 호출시에만 주소값이 세팅되고 그 다음에는 세팅을 방지하는 것이다.

JPA 스펙상 엔티티나 임베디드 타입은 자바 기본 생성자를 public 또는 protected 로 설정해야 한다.

public 으로 두는 것 보다 protected 로 설정하는 것이 그나마 더 안전하다.

 

 

※ 엔티티 설계시 주의점

 

① 엔티티는 가급적 Setter 를 사용하지 않는다.

Setter 가 모두 열려있을 경우 변경 지점이 많아져서 유지보수가 어려워진다.

 

② 모든 연관관계는 지연로딩으로 설정해야 한다.

- 즉시로딩(EAGER) 은 예측이 어렵고 어떤 SQL 이 실행될지 추적하기 어렵다.

   특히 JPQL 을 실행할 때 N+1 문제가 자주 발생한다.

 

N+1 문제 : JPA를 사용하다 보면 의도하지 않았지만 여러 번의 select 문이 순식간에 여러 개가 나가는 현상이 있다.
이러한 현상을 N+1문제라고 부른다.

 

- 실무에서 모든 연관관계는 지연로딩으로 설정해야 한다.

- 연관된 엔티티를 함께 DB 에서 조회해야 하면, fetch join 또는 엔티티 그래프 기능을 사용한다.

- OneToOne, ManyToOne 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 한다.

   (@XToOne 으로 된 것을 전부 fetch = FetchType.LAZY 를 추가해줘야 함)

 

③ 컬렉션은 필드에서 초기화 한다.

컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.

- null 문제에서 안전하다.

- 하이버네이트는 엔티티를 영속화 할 때, 컬렉션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다.

  만약 getOrders() 처럼 임의의 메서드에서 컬렉션을 잘못 생성하면 하이버네이트 내부 메커니즘에 문제가 

  발생할 수 있다.

  따라서 필드레벨에서 생성하는 것이 가장 안전하고, 코드가 간결하다.

 

④ 테이블, 컬럼명 생성 전략

스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다르다.

하이버네이트 기존 구현은 엔티티의 필드명을 그대로 테이블 명으로 사용한다. (SpringPhysicalNamingStrategy)

스프링 부트 신규 설정 (엔티티(필드) -> 테이블(컬럼))

 

1. 카멜 케이스 -> 언더스코어(memberPoint -> member_point)
2. (점) -> _(언더스코어)
3. 대문자 -> 소문자