[ JPA ] E-commerce 프로젝트 - 도메인 분석 설계

[ ORM ]/JPA

[ JPA ] E-commerce 프로젝트 - 도메인 분석 설계

환이s 2024. 12. 23. 17:34

728x90

Intro

안녕하세요. 환이s입니다👋

이전 포스팅에서 JPA와 DB 설정 방법에 대해 알아보았습니다.
오늘부터 간단한 상품 주문과 회원 관리 기능을 갖춘 웹 프로젝트를 만들어 보려고 하는데, 먼저 요구사항에 맞춰서 도메인 분석과 설계를 통해 실제 코드에 엔티티 연관관계 매핑까지 진행해 보겠습니다.

블로그 내용은 강의를 들으며 작성한 수강 일지로, 코드에 사용되는 어노테이션이나 연관 관계 매핑에 대한 구체적인 설명은 이전에 다룬 내용을 바탕으로 생략하겠습니다.

도메인 분석 설계 - 요구사항 분석

먼저 메인 화면을 보고 진행하겠습니다.

메인 화면을 보면 기능은 크게 회원 기능/ 상품 기능/ 주문 기능 총 3개의 기능 요구사항으로 나뉘어 볼 수 있는데, 각 기능별 목록을 정리해 보겠습니다.

회원 기능
- 회원 등록
- 회원 조회
상품 기능
1. 상품 등록
2. 상품 수정
3. 상품 조회
주문 기능
1. 상품 주문
2. 주문 내역 조회
3. 주문 취소

위 메인 화면을 보면 이와 같은 기능 목록을 추출할 수 있지만, 추가적으로 기타 요구사항을 추가해 보겠습니다.

기타 요구사항
1. 상품은 재고 관리가 필요합니다.
2. 상품의 종류는 도서, 음반, 영화가 있습니다.
3. 상품을 카테고리로 구분할 수 있습니다.
4. 상품 주문 시 배송 정보를 입력할 수 있습니다.

도메인 분석 설계 - 도메인 모델과 테이블 설계

다음으로 해당 기능들을 생각해 봤을 때,

도메인 모델과 테이블 설계는 어떻게 진행되는지 바로 알아보겠습니다.

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

위 다이어그램을 풀어보겠습니다.

회원, 주문, 상품의 관계를 보면

회원은 여러 상품을 주문할 수 있습니다. 그렇다면 일대다 관계가 되겠네요.

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

다만, 카테고리와 상품은 경험을 위해 다대다로 두었습니다.

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

이어서 회원 엔티티 분석을 먼저 설명하고 회원 테이블 분석 다이어그램을 풀어보겠습니다.

✅ 회원 엔티티 분석

회원 엔티티 분석 다이어그램을 간단하게 정리하면 다음과 같습니다.

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

TIP)

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

2. 회원이 주문을 하기 때문에, 회원 이 주문리스트를 가지는 것은 얼핏 보면 잘 설계한 것 같지만, 객체 세상은 실제 세계와는 다르다. 실무에서는 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분하다. 여기서는 일대다, 다대일의 양방향 연관관계를 설명하기 위해서 추가한 것이다.

✅ 회원 테이블 분석

회원 테이블 분석 다이어그램을 간단하게 정리하면 다음과 같습니다.

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

TIP)

1. 테이블명이 ORDER가 아니라 ORDERS인 것은 데이터베이스가 order by 때문에 예약어로 잡고 있는 경우가 많다. 그래서 관례상 ORDERS를 많이 사용한다.

2. 실제 코드에서는 DB에 소문자+_(언더스코어) 스타일을 사용하겠다.
데이터베이스 테이블명, 칼럼명에 대한 관례는 회사마다 다르다.
보통은 대문자+_(언더스코어)/소문자+_(언더스코어) 방식 중에 하나를 지정해서 일관성 있게 사용한다.
글에서 표현할 때는 객체와 차이를 나타내기 위해 데이터베이스 테이블, 컬럼명은 대문자를 사용하겠지만, 실제 코드에서는 소문자+_(언더스코어) 스타일을 사용하겠다.

✅ 연관관계 매핑 분석

위 다이어그램 기반으로 연관관계 매핑을 분석해서 정리하면 다음과 같습니다.

회원과 주문 : 1:N ,N:1

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

주문상품과 주문 : N:1

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

주문상품과 상품 : N:1

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

주문과 배송 : 1:1

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

카테고리와 상품 : N:N

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

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

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

도메인 분석 설계 - 엔티티 클래스 개발

위 다이어그램 기반으로 엔티티 클래스를 개발하려고 합니다.

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

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

TIP)

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

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

하지만 Setter는 문제가 다르다.
Setter를 호출하면 데이터가 변한다. Setter를 막 열어두면 가까운 미래에 엔티티가 도대체 왜 변경되는지 추적하기 점점 힘들어진다.

그래서 엔티티를 변경할 때는 Setter 대신에 변경 지점이 명확하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 한다.

⚙️ 회원 엔티티

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

@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를 사용했습니다.

엔티티는 타입(여기서는 Member)이 있으므로 id 필드만으로 쉽게 구분할 수 있습니다. 반대로 테이블은 타입이 없으므로 구분이 어렵습니다.

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

참고로 객체에서 id 대신에 memberId를 사용해도 됩니다. 중요한 것은 일관성입니다.

⚙️ 주문 엔티티

import lombok.Getter;
import lombok.Setter;
import javax.persistence.*;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;

@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)
     private List<OrderItem> orderItems = new ArrayList<>();
     
     @OneToOne(cascade = CascadeType.ALL, fetch = FetchType.LAZY)
     @JoinColumn(name = "delivery_id")
     private Delivery delivery; //배송정보
     
     private LocalDateTime orderDate; //주문시간
     
     @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
}

⚙️ 주문상품 엔티티

import lombok.Getter;
import lombok.Setter;
import jpabook.jpashop.domain.item.Item;
import javax.persistence.*;

@Entity
@Table(name = "order_item")
@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; //주문 수량
}

⚙️ 상품 엔티티

import lombok.Getter;
import lombok.Setter;
import jpabook.jpashop.domain.Category;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@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<Category>();
     
}

⚙️ 상품-도서 엔티티

import lombok.Getter;
import lombok.Setter;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

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

     private String author;
     private String isbn;
     
}

⚙️ 상품-음반 엔티티

import lombok.Getter;
import lombok.Setter;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

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

     private String artist;
     private String etc;
}

⚙️ 상품-영화 엔티티

import lombok.Getter;
import lombok.Setter;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;

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

     private String director;
     private String actor;
}

⚙️ 배송 엔티티

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", fetch = FetchType.LAZY)
     private Order order;
     
     @Embedded
     private Address address;
     
     @Enumerated(EnumType.STRING)
     private DeliveryStatus status; //ENUM [READY(준비), COMP(배송)]
}

⚙️ 배송 상태

public enum DeliveryStatus {
 	READY, COMP
}

⚙️ 카테고리 엔티티

import lombok.Getter;
import lombok.Setter;
import jpabook.jpashop.domain.item.Item;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

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

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

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

중간 엔티티(CategoryItem)를 만들고 @ManyToMany, @OneToMany로 매핑해서 사용하자.
정리하면 다대다 매핑을 일대다, 다대일 매핑으로 풀어내서 사용하자.

⚙️ 주소 임베디드 타입

import lombok.Getter;
import lombok.Setter;
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;
     }
}

값 타입은 변경 불가능하게 설계해야 합니다.

@Setter를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스를 만들어봅니다.

JPA 스펙상 엔티티나 임베디드 타입(@Embeddable)은 자바 기본 생성자(default constructor)를 public 또는 protected로 설정해야 합니다.

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

JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문입니다.

마치며

오늘은 프로젝트 초기 단계인 도메인 분석 설계를 해보았는데요.

예제처럼 간단한 연관관계 매핑 구조라면 어려움이 없겠지만

테이블이 늘어날수록.. 설계하는 게 쉽지 않습니다..😂

다이어그램 보면서 꾸준히 연습하고 있지만 헷갈리는 건 어쩔 수 없나 봅니다..💦

다음 포스팅에서 뵙겠습니다.

위 포스팅 글은 김영한님의 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발을 참고했습니다.

728x90

저작자표시

'[ ORM ] > JPA' 카테고리의 다른 글

[ JPA ] E-commerce 프로젝트 - 상품 도메인 개발 (1)	2025.01.06
[ JPA ] E-commerce 프로젝트 - 회원 도메인 개발 (3)	2024.12.27
[ JPA ] JPA와 DB 설정, 동작확인 (1)	2024.12.19
[ JPA ] Java Persistence Query Language(JPQL , 객체 지향 쿼리 언어)(2) (2)	2024.04.11
[ JPA ] Java Persistence Query Language(JPQL , 객체 지향 쿼리 언어)(1) (46)	2024.04.03

현재글[ JPA ] E-commerce 프로젝트 - 도메인 분석 설계

환이의 개발일지

JAVA 개발자로 일을 하면서 해당 내용들을 공유해 드리려고 합니다! 개발을 처음 접하시는 분들에게 업계 선배 혹은 길잡이가 되어드리고 싶습니다! :)

Today :
Yesterday :

환이의 개발일지