2) 도메인 분석 설계

요구사항 분석

미리보는 구현 결과

 

 

 

도메인 모델과 테이블 설계

회원, 주문, 상품의 관계

 

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

그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다.

하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용하지 않는다.

따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어냈다.

 

 

상품 분류

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

 

 

회원 엔티티 분석

 

회원(Member)

이름과 임베디드 타입인 주소( Address ), 그리고 주문( orders ) 리스트를 가진다

[회원이 오더리스트를 가지고있는것은 좋은 설계가 아니다. 일반적으로는 단방향으로 설계해야한다. 이 예제는 많은 연관관계를 보여주기 위해 추가된것이다.  멤버와 오더를 같은 레벨로 생각했을때 오더는 멤버가 있어야 생성된다. 멤버는 오더가 없더라도 생성될수있다. 그러므로 오더가 멤버필드를 가지고있는게 맞고 멤버가 오더리스트를 가지고있는것보다는 오더에서 멤버를 이용해서 조회해오는것이 맞다.]

 

주문(Order)

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

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

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

 

주문상품(OrderItem)

주문한 상품 정보와 주문 금액( orderPrice ), 주문 수량( count ) 정보를 가지고 있다.

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

 

상품(Item)

이름, 가격, 재고수량( stockQuantity )을 가지고 있다.

상품을 주문하면 재고수량이 줄어든다.

상품의 종류로는 도서, 음반, 영화가 있는데 각각은 사용하는 속성이 조금씩 다르다.

 

배송(Delivery)

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

 

카테고리(Category)

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

[다대다 연관관계는 만들면 안되지만 예제이므로 ]

 

주소(Address)

값 타입(임베디드 타입)이다. 회원과 배송(Delivery)에서 사용한다

 

 

참고

회원 엔티티 분석 그림에서 Order와 Delivery가 단방향 관계로 잘못 그려져 있다. 양방향 관계가 맞다.

 

참고

회원이 주문을 하기 때문에, 회원이 주문리스트를 가지는 것은 얼핏 보면 잘 설계한 것 같지만,

객체 세상은 실제 세계와는 다르다. 실무에서는 회원이 주문을 참조하지 않고,

주문이 회원을 참조하는 것으로 충분하다.

여기서는 일대다, 다대일의 양방향 연관관계를 설명하기 위해서 추가했다.

 

회원 테이블 분석

 

MEMBER

회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어갔다. 이것은 DELIVERY 테이블도 마찬가지다.

 

ITEM

앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었다. DTYPE 컬럼으로 타입을 구분한다.

[ 상속관계매핑 전략중 싱글 테이블 전략을 사용한것이다. ]

 

카테고리

엔티티상에서는 다대다로 매핑했고 양방향으로 연관관계를 구현했다

[ 엔티티 설계상 다대다는 컬렉션(리스트같은)을 가지면 된다.]

하지만 관계형 데이터베이스 테이블설계상은 불가능하므로  중간에 매핑테이블을 두고

다대다 관계를 일대다 관계로 풀어야한다.

 

참고

테이블명이 ORDER 가 아니라 ORDERS 인 것은 데이터베이스가 order by 때문에 예약어로 잡고 있는 경우가 많다.

그래서 관례상 ORDERS 를 많이 사용한다.

 

참고

실제 코드에서는 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는 사용하지 말자. 여기서는 다대다 관계를 예제로 보여주기 위해 추가했을 뿐이다)

 

 

 

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

연관관계의 주인은 단순히 외래 키를 누가 관리하냐의 문제이지 비즈니스상 우위에 있다고 주인으로 정하면 안된다.

예를 들어서 자동차와 바퀴가 있으면, 일대다 관계에서 항상 다쪽에 외래 키가 있으므로 외래 키가 있는 바퀴 를 연관관계의 주인으로 정하면 된다.

물론 자동차를 연관관계의 주인으로 정하는 것이 불가능 한 것은 아니지만,

자동차를 연관관계의 주인으로 정하면 자동차가 관리하지 않는 바퀴 테이블의 외래키 값이 업데이트 되므로

관리와 유지보수가 어렵고, 추가적으로 별도의 업데이트 쿼리가 발생하는 성능 문제도 있다.

자세한 내용은 JPA 기본 편을 참고하자.

 

 

 

 

엔티티 클래스 개발

예제에서는 설명을 쉽게하기 위해 엔티티 클래스에 Getter, Setter를 모두 열고, 최대한 단순하게 설계

실무에서는 가급적 Getter는 열어두고, Setter는 꼭 필요한 경우에만 사용하는 것을 추천

 

참고

이론적으로 Getter, Setter 모두 제공하지 않고, 꼭 필요한 별도의 메서드를 제공하는게 가장 이상적이다.

하지만 실무에서 엔티티의 데이터는 조회할 일이 너무 많으므로, Getter의 경우 모두 열어두는 것이 편리하다.

Getter는 아무리 호출해도 호출 하는 것 만으로 어떤 일이 발생하지는 않는다.

하지만 Setter는 문제가 다르다.

Setter를 호출하면 데이터가 변한다.

Setter를 막 열어두면 가까운 미래에 엔티티가 도대체 왜 변경되는지 추적 하기 점점 힘들어진다.

그래서 엔티티를 변경할 때는 Setter 대신에 변경 지점이 명확하도록

변경을 위한 비즈니 스 메서드를 별도로 제공해야 한다.

 

 

 

엔티티 설계시 주의점

엔티티에는 가급적 Setter를 사용하지 말자

 

Setter가 모두 열려있다. 변경 포인트가 너무 많아서, 유지보수가 어렵다. 나중에 리펙토링으로 Setter 제거

 

 

모든 연관관계는 지연로딩으로 설정!

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

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

[ order가 member와 @ManyToOne이고 EAGER로 해놨다고 가정하면 -> order 엔티티 필드에 멤버가 존재
만약 모든 order 엔티티를 조회하는 쿼리가 있다고해보자.  만약 오더 엔티티가 100개라면

100번의 멤버 엔티티조회 쿼리가 필요하다. 즉 오더 조회 쿼리 1개 + 100번의 멤버 엔티티 조회 쿼리가 발생한다.

[claude 답변

@ManyToOne 관계를 통해 Order와 Member 엔티티가 매핑되어 있습니다. 이때 Order 엔티티 목록을 조회하면, 각 Order에 대해 Member 엔티티를 조회하는 쿼리가 추가로 실행됩니다. 만약 Order 엔티티가 100개라면, 총 101번의 쿼리(1번의 Order 조회 쿼리 + 100번의 Member 조회 쿼리)가 실행되어 N+1 문제가 발생합니다.]

 

 

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

 

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

 

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

[ ~ To One 은 모두 즉시로딩이 기본값이므로 지연로딩 설정필요. ]

 

컬렉션은 필드에서 초기화 하자.

private List<OrderItem> orderItems = new ArrayList<>();

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

 

null 문제에서 안전하다.

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

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

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

 

Member member = new Member();
System.out.println(member.getOrders().getClass());
em.persist(member);
System.out.println(member.getOrders().getClass());
//출력 결과
class java.util.ArrayList
class org.hibernate.collection.internal.PersistentBag

영속화 후,  orders가 ArrayList에서 하이버네이트가 제공하는 컬렉션으로 변경된것을 확인 가능.

 

 

회원 엔티티

@Getter
@Setter
@Entity
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<Order>();
    
}

 

참고

엔티티의 식별자는 id 를 사용하고 PK 컬럼명은 member_id 를 사용했다.

엔티티는 타입(여기서는 Member )이 있으므로 id 필드만으로 쉽게 구분할 수 있다.

테이블은 타입이 없으므로 구분이 어렵다.

그리고 테이블은 관례상 테이블명 + id 를 많이 사용한다.

참고로 객체에서 id 대신에 memberId 를 사용해도 된다.

중요한 것은 일관성이다.

 

 

주문 엔티티

@Entity
@Table(name = "orders")
@Getter @Setter
public class Order {
    @Id
    @GeneratedValue
    @Column(name = "order_Id")
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "member_id")
    private Member member;

    @OneToMany(mappedBy = "order", cascade = CascadeType.ALL) // cascade로 Order를 통해 OrderItem의 생명주기까지 관여가능 + 라이프사이클이 비슷 + OrderItem의 단일사용자
    private List<OrderItem> orderItems = new ArrayList<>();

    @OneToOne(fetch = FetchType.LAZY, cascade =CascadeType.ALL) // delivery 랑 일대일이므로 라이프사이클이 비슷하니까 사용 + delivery의 단일사용자여야한다.
    @JoinColumn(name = "delivery_id")
    private Delivery delivery;

    private LocalDateTime orderDate; // Localdate,localdatetime을 쓰면 날짜관련 어노테이션을 붙이지않아도 하이버네이트가 알아서해준다.

    @Enumerated(EnumType.STRING)
    private OrderStatus status; // 주문상태 -> order, cancel

    // 연관관계 편의 메소드 [ 양방향 연관일때 한쪽의 값만 변경시키지말고 양쪽 다 최신화를 시켜줘야한다, 사용할때마다 매번 DB에서 불러올수없으므로 -> 1차캐시에 저장되어있는 엔티티는 불러온때의 상태를 가지므로 -> 객체 또한 최신화 시켜줘야한다.]
    /*
    Setter 어노테이션을 사용하여 모든 필드에 대한 Setter 메소드를 생성하더라도, 특정 필드에 대한 Setter 메소드를 직접 구현하여 로직을 추가할 수 있다.
    그래서 해당 setter 메소드가 실행된다.
     */
    public void setMember(Member member) {
        this.member = member;
        member.getOrders().add(this);
    }

    public void addOrderItem(OrderItem orderItem) {
        orderItems.add(orderItem);
        orderItem.setOrder(this);
    }

    public void setDelivery(Delivery delivery) {
        this.delivery = delivery;
        delivery.setOrder(this);
    }

}

 

주문상태

public enum OrderStatus {
    ORDER,CANCEL
}

 

 

주문상품 엔티티

@Entity
@Getter @Setter
public class OrderItem {

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

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "item_id")
    private Item item;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "order_id")
    private Order order;

    private int orderPrice;
    private int count;


}

 

상품 엔티티

@Entity
@Getter @Setter
@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
@DiscriminatorColumn(name = "dtype") // 가본값은 DTYPE
public abstract class Item {
    @Id
    @GeneratedValue
    @Column(name = "item_id") // 기본설정은 필드이름으므로 필드이름과 컬럼이름이 다르다면 설정해준다.
    private Long id;

    private String name;

    private int price;
    private int stockQuantity;

    @ManyToMany
    private List<Category> categories = new ArrayList<>();


}

 

상품 - 도서 엔티티

@Entity
@Getter
@Setter
@DiscriminatorValue("B")  // 해당 엔티티가 테이블에 저장될떄  식별 컬럼에 담길 값을 설정
public class Book extends Item{
    private String author;
    private String isbn;

}

 

상품 - 음반 엔티티

@Entity
@Getter @Setter
@DiscriminatorValue("A")  // 해당 엔티티가 테이블에 저장될떄  식별 컬럼에 담길 값을 설정
public class Album extends Item{
    private String artist;
    private String etc;

}

 

상품 - 영화 엔티티

@Entity
@Getter
@Setter
@DiscriminatorValue("M")  // 해당 엔티티가 테이블에 저장될떄  식별 컬럼에 담길 값을 설정
public class Movie extends Item{
    private String director;
    private String actor;

}

 

배송 엔티티

@Entity
@Getter @Setter
public class Delivery {
    @Id
    @GeneratedValue
    @Column(name = "delivery_id")
    private Long id;

    @OneToOne(mappedBy = "delivery", fetch = FetchType.LAZY)
    private Order order;

    @Embedded
    private Address address;

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

 

배송 상태

public enum DeliveryStatus {
    READY,COMP
}

 

 

카테고리 엔티티

@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"), //joinColumns: 현재 엔티티(Category)와 중간 테이블(category_item) 간의 외래 키를 정의, 현재 테이블은 category이므로 category_id와 매핑
            inverseJoinColumns = @JoinColumn(name = "item_id")//inverseJoinColumns: 대상 엔티티(Item)에서 중간 테이블(category_item)로의 외래 키를 지정
    )
    private List<Item> items = new ArrayList<Item>();

    //카테고리는 계층 구조이고, 자신의 부모, 자신의 자식을 확인할 수 있어야한다.
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "parent_id") // 자기자신 참조 셀프 단방향
    private Category parent;

    // 자식카테고리는 여러개 가질 수 있다.
    @OneToMany(mappedBy = "parent") // 셀프로 부모카테고리와 양방향 연관관계 매핑
    private List<Category> child = new ArrayList<>();


    // 연관관계 편의 메소드
    public void addChildCategory(Category child) {
        this.child.add(child);
        child.setParent(this);
    }
}

참고

실무에서는 @ManyToMany 를 사용하지 말자

@ManyToMany 는 편리한 것 같지만, 중간 테이블( CATEGORY_ITEM )에 컬럼을 추가할 수 없고,

세밀하게 쿼리 를 실행하기 어렵기 때문에 실무에서 사용하기에는 한계가 있다.

중간 엔티티( CategoryItem 를 만들고 @ManyToOne , @OneToMany 로 매핑해서 사용하자.

정리하면 다대다 매핑을 일대다, 다대일 매핑으로 풀어내 서 사용하자.

[GPT - @ManyToMany 관계에서는 일반적으로 중간 테이블이 자동으로 생성되며, 이 테이블은 연결된 두 엔티티 간의 관계만을 나타냅니다. 그렇기 때문에 중간 테이블에 추가적인 컬럼을 정의할 수 없습니다.]

 

주소 값 타입

@Embeddable // 임베디드(값)타입
@Getter
@NoArgsConstructor (access = AccessLevel.PROTECTED) //JPA에서 기본생성자가 필요해서 열어두지만, 개발자가 사용못하게 접근제한자를 PROTECTED로 설정한다.
@AllArgsConstructor
public class Address {

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

 

 

 

 

 

테이블, 컬럼명 생성 전략

@Table의 기본값에 따르면 테이블명은 엔티티클래스명대로 간다. 

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

Spring Boot Reference Guide

Hibernate ORM 5.4.33.Final User Guide

하이버네이트 기존 구현 -> 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용
( SpringPhysicalNamingStrategy )

 

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

 

1. 카멜 케이스 -> 언더스코어(memberPoint member_point)

 

2. .(점) ->  _(언더스코어)

 

3. 대문자 ->  소문자

 

Order 엔티티 (테이블명은 orders로 설정) 에 orderDate 필드가

private LocalDateTime orderDate;

언더스코어 형식으로 컬럼이 들어간것을 확인가능.

+ 대문자 -> 소문자

 

 

 

적용 2 단계

 

1. 논리명 생성: 명시적으로 컬럼, 테이블명을 직접 적지 않으면 ImplicitNamingStrategy 사용 spring.jpa.hibernate.naming.implicit-strategy : 테이블이나, 컬럼명을 명시하지 않을 때 논리명 적용,

 

2. 물리명 적용: spring.jpa.hibernate.naming.physical-strategy :

모든 논리명에 적용됨, 실제 테이블에 적용 (username usernm 등으로 회사 룰로 바꿀 수 있음)

 

 

스프링 부트 기본 설정

 

spring.jpa.hibernate.naming.implicit-strategy:
org.springframework.boot.orm.jpa.hibernate.SpringImplicitNamingStrategy
spring.jpa.hibernate.naming.physical-strategy:
org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy