[실전! 스프링 부트와 JPA 활용 1 - 웹 애플리케이션 개발] 도메인 분석 설계

[작성일: 2023. 08. 21]

요구사항 분석

기능 목록

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

도메인 모델과 테이블 설계

회원, 주문, 상품의 관계 : 회원은 여러 상품을 주문할 수 있다. 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다. 하지만 이런 다대다 관계는 관계형 데이터베이스에서는 물론이고 엔티티에서도 거의 사용하지 않는다. 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어낸다.
상품 분류 : 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속으로 표현한다.

회원 엔티티 분석

회원(Member) : 이름과 임베디드 타입인 주소(Address), 주문(orders) 리스트를 가진다.
주문(Order) : 한 번 주문 시 여러 상품을 주문할 수 있으므로 주문과 주문상품(OrderItem)은 일대다 관계다. 주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태(status)를 가진다. 주문 상태는 열거형을 사용했으며 주문(ORDER), 취소(CANCEL)를 표현한다. (Order - delivery는 양방향 관계가 맞다.)
주문상품(OrderItem) : 주문한 상품 정보와 주문 금액(orderPrice), 주문 수량(count)정보를 가진다.
상품(Item) : 이름, 가격, 재고수량을 가지고 있다. 상품을 주문하면 재고수량이 줄어든다. 상품의 종류는 도서, 음반, 영화가 있고 각각은 사용하는 속성이 조금씩 다르다.
배송(Delivery) : 주문 시 하나의 배송 정보를 생성하고 주문과 배송은 일대일 관계다.
카테고리(Category) : 상품과 다대다 관계를 가지며 부모, 자식 카테고리를 연결한다.
주소(Address) : 값 타입(임베디드 타입)으로 회원과 배송에서 사용한다.

참고: 회원 엔티티 분석 그림에서 Order와 Delivery가 단방향 관계로 잘못 그려져 있는데 양방향 관계가 맞다.
회원이 주문을 하기 때문에 회원이 주문리스트를 가지는 것은 얼핏 보면 잘 설계한 것처럼 보이지만 실무에서는 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분하다. 여기서는 일대다, 다대일의 양방향 연관관계를 설명하기 위해 추가했다.

회원 테이블 분석

MEMBER : 회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어갔다. DELIVERY도 마찬가지다.
ITEM : 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들고 DTYPE 컬럼으로 타입을 구분한다.

참고: 테이블명이 ORDER가 아니라 ORDERS인 것은 데이터베이스가 order by를 예약어로 잡고 있기 때문에 관례상으로 ORDERS를 많이 사용한다.

연관관계 매핑 분석

회원과 주문 : 일대다, 다대일의 양방향 관계로 연관관계의 주인을 정해야 하는데 외래키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로 Order.member를 ORDERS.MEMBER_ID 외래 키와 매핑한다.
주문상품과 주문 : 다대일 양방향 관계로 외래키가 주문상품에 있으므로 주문상품이 연관관계의 주인이다. 그러므로 OrderItem.order를 ORDER_ITEM.ORDER_ID 외래키와 매핑한다.
주문상품과 상품 : 다대일 단방향 관계로 OrderItem.item을 ORDER_ITEM.ITEM_ID 외래키와 매핑한다.
주문과 배송 : 일대일 양방향 관계로 Order.delivery를 ORDERS.DELIVERY_ID 외래키와 매핑한다.
카테고리와 상품 : @ManyToMany를 사용해서 매핑한다. (실무에서는 사용x)

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

엔티티 클래스 개발

참고: 이론적으로 Getter, Setter를 모두 제공하지 않고 꼭 필요한 별도의 메서드를 제공하는 게 가장 이상적이다. Getter는 아무리 호출해도 호출하는 것만으로는 어떤 일이 발생하지는 않지만 Setter를 호출하면 데이터가 변하고 추적하기 힘들어진다.

회원 엔티티

@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를 사용하고 PK 컬럼명은 member_id를 사용했다. 엔티티 타입이 있으므로 id 필드만으로 쉽게 구분할 수 있다. 테이블은 타입이 없으므로 구분이 어렵다. 그리고 테이블은 관례상 테이블명 + id를 많이 사용한다. 참고로 객체에서 id 대신에 memberId를 사용해도 되지만 중요한 것은 일관성이다.

주문 엔티티

@Entity
@Getter
@Setter
@Table(name = "orders")
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)
    private List<OrderItem> orderItems = new ArrayList<>();

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

    private LocalDateTime orderTime;  // 주문 시간

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

    // 연관관계 메서드
    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
    @JoinColumn(name = "order_id")
    private Order order;

    private int orderPrice;  // 주문 가격

    private int count; // 주문 수량
}

상품 엔티티

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

}

상품 - 도서 엔티티

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

    private String author;
    private String isbn;

}

상품 - 영화 엔티티

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

    private String director;
    private String actor;
}

상품 - 음반 엔티티

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

    private String artist;
    private String etc;
}

배송 엔티티

@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"),
            inverseJoinColumns = @JoinColumn(name = "item_id"))  // 중간 테이블
    private List<Item> items = new ArrayList<>();

    @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를 사용하지 않는다. 편리해 보여도 중간 테이블에 컬럼을 추가할 수 없고 세밀하게 쿼리를 실행하기 어렵기 때문에 실무에서 사용하기에는 한계가 있다. 중간 엔티티(CategoryItem)를 만들고 @ManyToOne, @OneToMany로 매핑해서 사용하는 것이 좋다.(다대다, 다대일 매핑)

주소값 타입

@Getter
@Embeddable
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로 설정해야 한다.
JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플렉션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.

엔티티 설계시 주의점

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

스프링부트 신규 설정

카멜 케이스 ➡️ 언더스코어 (memberPoint ➡️ member_point)
.(점) ➡️ _(언더스코어)
대문자 ➡️ 소문자

실제로 주문시간 필드를 orderTime으로 작성했지만 JPA에 의해 생성된 테이블을 확인하면 order_time으로 생성된 것을 확인할 수 있다.

🐣 출처: 인프런 김영한님 강의

이 글은 인프런의 김영한님 JPA 강의를 보고 작성한 글입니다.

강의를 들으면서 정리한 글이므로 틀린 내용이나 오타가 있을 수 있습니다.

저작자표시 비영리 변경금지

요구사항 분석

기능 목록

도메인 모델과 테이블 설계

회원 엔티티 분석

회원 테이블 분석

연관관계 매핑 분석

엔티티 클래스 개발

엔티티 설계시 주의점

스프링부트 신규 설정

티스토리툴바