[JPA 활용 1] 2. 도메인 분석 설계

 요구사항 분석

---

 

실제 동작하는 화면을 먼저 확인합니다.

 

기능 목록

• 회원 기능
  • 회원 등록
  • 회원 조회
• 상품 기능
  • 상품 등록
  • 상품 수정
  • 상품 조회
• 주문 기능
  • 상품 주문
  • 주문 내역 조회
  • 주문 취소
• 기타 요구사항
  • 상품은 제고 관리가 필요하다.
  • 상품의 종류는 도서, 음반 영화가 있다.
  • 상품을 카테고리로 구분할 수 있다.
  • 상품 주문시 배송 정보를 입력할 수 있다.

 

 

도메인 모델과 테이블 설계

---

회원, 주문, 상품의 관계

회원은 여러 상품을 주문할 수 있다. 그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다. 하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용하지 않는다. 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어냈다.

 

상품 분류

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

 

 

회원 엔티티 분석

회원(Member)

이름과 임베디드 타입인 주소 (Address), 주문(orders) 리스트 

 

주문(Order)

한 번 주문시 여러 상품을 주문할 수 있으므로 주문과 주문상품(OrderItem)은 일대다 관계, 주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태(Status)를 가지고 있습니다. 주문 상태는 열거형으로 사용했는데 주문(Order), 취소(Cancel)를 표현할 수 있습니다.

 

주문 상품(OrderItem)

주문한 상품 정보와 주문 금액(orderPrice), 주문 수량(count)

 

상품(Item)

이름, 가격, 재고수량(stockQuantity)

 

배송(Delivery)

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

 

카테고리(Category)

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

 

 

 

회원 테이블 분석

MEMBER

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

 

ITEM

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

 

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

참고 : 실제 코드에서는 DB에 소문자 + _(언터스코어) 스타일을 사용
데이터베이스 테이블명, 컬럼명에 대한 관례는 회사마다 다르다.

 

 

연관관계 매핑 분석

회원과 주문

일대다, 다대일의 양방향 관계다. 따라서 연관관계의 주인을 정해야 하는데, 외래 키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로 Order.member를 ORDERS.MEMBER_ID 외래키와 매핑한다.

 

주문상품과 주문

다대일 양방향 관계다. 외래 키가 주문상품에 있으므로 주문상품이 연관관계의 주인이다. 그러므로 OrderItem.order를 ORDER_ITEM.ORDER_ID 외래 키와 매핑한다.

 

주문상품과 상품

다대일 단방향 관계다. OrderItem.item을 ORDER_ITEM.ITEM_ID 외래 키와 매핑한다.

 

주문과 배송

일대일 양방향 관계다. Order.delibery를 ORDERS.DELIVERY_ID 외래 키와 매핑한다.

 

카테고리와 상품

@ManyToMany를 사용해서 매핑한다. (실무에서 @ManyToMany는 사용하지 말자. 여기서는 다대다 관계를 예제로 보여주기 위해 추가했을 뿐이다.)

 

참고 : 외래 키가 있는 곳을 연관관계의 주인으로 정해라.
연관관계의 주인은 단순히 외래 키를 누가 관리하냐의 문제이지 비즈니스상 우위에 있다고 주인으로 정하면 안된다.. 예를 들어서 자동차와 바퀴가 있으면, 일대다 관계에서 항상 다쪽에 외래 키가 있으므로 외래 키가 있는 바퀴를 연관관계의 주인으로 정하면 된다. 물론 자동차를 연관관계의 주인으로 정하는 것이 불가능 한 것은 아니지만, 자동차를 연관관계의 주인으로 정하면 자동차가 관리하지 않는 바퀴 테이블의 외래 키 값이 업데이트 되므로 관리와 유지보수가 어렵고, 추가적으로 별도의 업데이트 쿼리가 발생하는 성능 문제도 있다. 자세한 내용은 JPA 기본편을 참고하자.

 

 

 

엔티티 클래스 개발

---

Member 엔티티

package jpabook.jpashop.domain;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;
import java.util.*;

@Entity
@Getter
@Setter
public class Member {

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

    private String name;

    @Embedded
    private Address address;		// Address에 Embeddable을 추가하거나 Address사용할 때 Embedded 어노테이션 추가

    @OneToMany(mappedBy = "member")     // 연관관계 주인이 아님을 명시
    private List<Order> orders = new ArrayList<>();
}

 

Address 값 타입

package jpabook.jpashop.domain;

import lombok.Getter;

import javax.persistence.Embeddable;

@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;
    }
}

 

Order 엔티티

package jpabook.jpashop.domain;

import lombok.Getter;
import lombok.Setter;

import java.time.LocalDateTime;
import java.util.*;

import javax.persistence.*;

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

    @ManyToOne
    @JoinColumn(name = "member_id")			// Member에 pk값과 join
    private Member member;

	// 연관관계 주인이 아님을 명시 (OrderItem 엔티티에 order 컬럼명이 연관관계의 주인이다.)
    // cascade는 Order를 저장할 때 orderItems에 저장한 것도 같이 저장된다.
    @OneToMany(mappedBy = "order", cascade = CascadeType.ALL)
    private List<OrderItem> orderItems = new ArrayList<>();

    @OneToOne(fetch = FetchType.LAZY, cascade = CascadeType.ALL)
    @JoinColumn(name = "delivery_id")
    private Delivery delivery;

    private LocalDateTime orderDate;		// java 8이상부터 hibernate에서 지원

    @Enumerated(EnumType.STRING)			// EnumType에는 ORDINAL과 STRING이 있다. (디폴트는 ORDINAL인데, 수정할 때 데이터가 원하는대로 들어가지 않아 힘들어질 수 있다. STRING 사용을 권장)
    private OrderStatus status;         // enum (ORDER, CANCLE) 두 개의 상태를 표시
    
    //==연관관계 편의 메서드==//
    public void changeMember(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);
    }
}

OrderStatus Enum

package jpabook.jpashop.domain;

public enum OrderStatus {
    ORDER, CANCLE
}

 

 

Delivery 엔티티

package jpabook.jpashop.domain;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;

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

    @OneToOne(mappedBy = "delivery")		// 연관관계 주인이 Order 엔티티의 delivery 컬럼명임을 명시
    private Order order;

    @Embedded
    private Address address;

    @Enumerated(EnumType.STRING)
    private DeliveryStatus deliveryStatus;
}

DeliveryStatus Enum

package jpabook.jpashop.domain;

public enum DeliveryStatus {
    READY,COMP
}

 

OrderItem 엔티티

package jpabook.jpashop.domain;

import jpabook.jpashop.domain.Item.Item;
import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;

@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 orderPirce;    // 주문 가격
    private int count;    // 주문 수량
}

 

Item 엔티티

package jpabook.jpashop.domain.Item;

import jpabook.jpashop.domain.Category;
import lombok.Getter;
import lombok.Setter;
import java.util.*;

import javax.persistence.*;

@Entity
@Getter
@Setter
// SINGLE_TABLE, TABLE_PER_CLASS, JOINED 전략이 있다.
// SINGLE_TABLE은 상속받은 엔티티의 테이블을 만드는 것이 아닌 DTYPE을 통해 상속받은 엔티티 중 어떤 엔티티를
// 사용하는지 파악한다.
@Inheritance(strategy = InheritanceType.SINGLE_TABLE)	
@DiscriminatorColumn(name = "dtype")
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 엔티티

package jpabook.jpashop.domain.Item;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

@Entity
@Getter
@Setter
@DiscriminatorValue("A")		// Item 중 Dtype이 'A'인 것은 Alumn 엔티티를 가르킨다.
public class Album extends Item {
    private String artist;
    private String etc;
}

Book 엔티티

package jpabook.jpashop.domain.Item;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

@Entity
@Getter
@Setter
@DiscriminatorValue("B")			// Album 엔티티의 주석과 같은 느낌이다.
public class Book extends Item {
    private String author;
    private String isbn;
}

Movie 엔티티

package jpabook.jpashop.domain.Item;

import lombok.Getter;
import lombok.Setter;

import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

@Entity
@Getter
@Setter
@DiscriminatorValue("M")		// Album 엔티티의 주석과 같은 느낌이다.
public class Movie extends Item {
    private String director;
    private String actor;
}

 

Category 엔티티

package jpabook.jpashop.domain;

import jpabook.jpashop.domain.Item.Item;
import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;
import java.util.*;

@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<>();
    
    //==연관관계 메서드==//
    public void addChildCategory(Category child){
        this.child.add(child);
        child.setParent(this);
    }
}

 

위의 코드를 추가한 뒤 실행하고 H2 콘솔에서 테이블을 확인해보면 위의 설계대로 테이블이 생성된 것을 확인할 수 있습니다.

생성된 테이블

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

하지만, 실무에서 엔티티의 데이터는 조회할 일이 너무 많으므로 Getter의 경우 모두 열어두는 것이 편리합니다. Getter은 아무리 호출해도 어떤 일이 발생하지 않기 때문입니다. 하지만, Setter의 경우는 문제가 다릅니다. Setter를 호출하면 데이터가 변합니다. Setter를 막 열어두면 가까운 미래에 엔티티가 도대체 왜 변경되는지 추적하기 점점 힘들어집니다. 그래서 엔티티를 변경할 때는 Setter 대신에 변경지점이 명확하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 합니다. 그래야 유지보수성이 올라갑니다. 

결론 : Getter 어노테이션은 추가하되, Setter는 지양

 

참고 : 실무에서는 @ManyToMany를 지양 (지양보다는 절대 사용하지 마라.)

@ManyToMany는 편리한 것 같지만, 중간 테이블(CATEGORY_ITEM)에 컬럼을 추가할 수 없고, 세밀하기 쿼리를 실행하기 어렵기 때문에 실무에서 사용하기에는 한계가 있다. 중간 엔티티 (CategoryItem을 만들고 @ManyToOne, @OneToMany로 매핑해서 사용하자)

결론 : 다대다 매핑 사용 X 필요 시  (다대다 => 일대다 + 다대일) 관계로 풀어내자

 

참고 : 위에서 사용한 Address와 같은 값 타입은 변경 불가능하게 설계해야 합니다.

@Setter를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스를 만들자. JPA 스펙상 엔티티나 임베디드 타입(@Embeddable)은 자바 기본 생성자(default constructor)를 pulbic 또는 protected로 설정해야 한다. public 보다는 protected로 설정하는 것이 더 안전하다.
>JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플렉션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.   

결론 : 값 타입의 경우 기본 생성자로만 변경이 가능하도록 설계하자.

 

 

 

엔티티 설계시 주의점

---

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

• Setter가 모두 열려있다면, 변경 포인트가 너무 많아 유지보수가 어렵다.

• 모든 연관관계는 지연로딩으로 설정
  • 즉시로딩은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다. 특히 JPQL을 실행할 때 N+1 문제가 자주 발생한다.
  • 실무에서 모든 연관관계는 지연로딩으로 설정해야 한다.
  • 연관된 엔티티를 함께 DB에서 조회해야 하면, fetch join 또는 엔티티 그래프 기능을 사용한다.
  • @XToOne(OneToOne, ManyToOne) 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 한다.
• 컬렉션은 필드에서 초기화 하자
  • 컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.
  • null 문제에서 안전하다. (바로 초기화 시키기 때문)
  • 하이버네이트는 엔티티를 영속화할 때, 컬렉션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다. 만약 getOrders() 처럼 임의의 메서드에서 컬렉션을 잘못 생성하면 하이버네이트 내부 메커니즘에서 문제가 발생할 수 있다.
  • 따라서, 필드레벨에서 생성하는 것이 안전하고, 코드도 간결하다.

Member member = new Member();
System.out.println(member.getOrders().getClass());
em.persist(member);
System.out.pritnln(member.getOrders().getClass());

// 출력 결과
class java.util.ArrayList
class org.hibernate.collection.internal.PersistentBag

hibernate collection으로 감싸는 이유는 변경 감지(더티체킹)를 위해서 감싸야합니다. 한번 초기화만 해주는 이유는 hibernate에서 감쌋는데, 다시 초기화를 해버리면 hibernate에서 원하는대로 동작할 수 없기 때문입니다.  그렇기 때문에 되도록이면 바꾸지 않는 것을 권장합니다.

• 테이블, 컬럼명 생성 전략 
  • 스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다름
  • https://docs.spring.io/spring-boot/docs/2.1.3.RELEASE/reference/htmlsingle/#howto-%20configure-hibernate-naming-strategy
  • https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/%20Hibernate_User_Guide.html#naming
  • 하이버네이트 기존 구현 : 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용 (SpringphysicalNamingStrategy)
  • 스프링 부트 신규 설정 (엔티티(필드) -> 테이블(컬럼))
    1. 카멜 케이스 -> 언더스코어(memberPoint -> member_point)
    2. .(점) -> _(언더스코어)
    3. 대문자 -> 소문자
  • 바꾸고 싶으면 바꿀 수 있다고 합니다. (필요 시 찾아볼 것)

 

 

 

 

 

출처

실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발 - 인프런 | 강의