💡 본 게시글은 김영한님의 인프런(Inflearn) 강의 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발에 대해 공부하고, 정리한 내용입니다.
1. 도메인 분석 설계
1) 요구사항 분석
(1) 요구사항 분석 - 01
- 기능 목록
- 회원 기능
- 회원 등록
- 회원 조회
- 상품 기능
- 상품 등록
- 상품 수정
- 상품 조회
- 주문 기능
- 상품 주문
- 주문 내역 조회
- 주문 취소
- 기타 요구사항
- 상품은 재고 관리가 필요하다.
- 상품의 종류는 도서, 음반, 영화가 있다.
- 상품을 카테고리로 구분할 수 있다.
- 상품 주문 시 배송 정보를 입력할 수 있다.
- 회원 기능
2) 도메인 모델과 테이블 설계
(1) 도메인 모델과 테이블 설계 - 01
- 회원, 주문, 상품의 관계
- 회원은 여러 상품을 주문할 수 있습니다. 한 번 주문할 때 여러 상품을 선택할 수 있으므로, 주문과 상품은 다대다(N:M) 관계입니다.
- 다대다 관계는 관계형 데이터베이스와 엔티티에서 잘 사용되지 않습니다. 이를 해결하기 위해
주문상품(OrderItem)이라는 엔티티를 추가하여 다대다 관계를 일대다(N:1), 다대일(1:N) 관계로 풀어냈습니다.
- 상품 분류
- 상품은 도서, 음반, 영화로 구분되며,
상품(Item)이라는 공통 속성을 사용하여 상속 구조로 표현합니다.
- 상품은 도서, 음반, 영화로 구분되며,
3) 회원 엔티티 분석
(1) 도메인 모델과 테이블 설계 - 02
- 회원(Member)
- 이름과 임베디드 타입인 주소(Address), 그리고 주문(orders) 리스트를 가집니다.
- 주문(Order)
- 한 번 주문 시 여러 상품을 주문할 수 있으므로, 주문과 주문상품(OrderItem)은 일대다(N:1) 관계입니다.
- 주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태(status)를 가집니다.
- 주문 상태는 열거형(Enum)을 사용하며, 주문(ORDER)과 취소(CANCEL)을 표현할 수 있습니다.
- 주문상품(OrderItem)
- 주문한 상품 정보와 주문 금액(orderPrice), 주문 수량(count) 정보를 가집니다. 보통
OrderLine,LineItem으로 많이 표현됩니다.
- 주문한 상품 정보와 주문 금액(orderPrice), 주문 수량(count) 정보를 가집니다. 보통
- 상품(Item)
- 이름, 가격, 재고 수량(stockQuantity)을 가집니다. 상품을 주문하면 재고 수량이 줄어듭니다.
- 상품의 종류로는 도서, 음반, 영화가 있으며, 각각의 상품은 고유의 속성을 가집니다.
- 배송(Delivery)
- 주문 시 하나의 배송 정보를 생성하며, 주문과 배송은 일대일(1:1) 관계입니다.
- 카테고리(Category)
- 상품과 다대다(N:M) 관계를 맺습니다.
parent,child필드를 통해 부모, 자식 카테고리를 연결할 수 있습니다.
- 상품과 다대다(N:M) 관계를 맺습니다.
- 주소(Address)
- 값 타입(임베디드 타입)으로, 회원과 배송에서 사용됩니다.
참고: 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분합니다. 여기서는 일대다, 다대일의 양방향 연관관계를 설명하기 위해 회원이 주문 리스트를 가지도록 설계했습니다.
4) 회원 테이블 분석
(1) 도메인 모델과 테이블 설계 - 03
- MEMBER
- 회원 엔티티의
Address임베디드 타입 정보가 회원 테이블에 그대로 들어갔습니다. 이는DELIVERY테이블에서도 동일합니다.
- 회원 엔티티의
- ITEM
- 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었습니다.
DTYPE컬럼을 사용해 타입을 구분합니다.
- 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었습니다.
참고: 테이블명이
ORDER가 아니라ORDERS인 이유는 데이터베이스에서order by가 예약어로 잡혀 있기 때문입니다. 따라서 관례상ORDERS를 많이 사용합니다.
5) 연관관계 매핑 분석
(1) 연관관계 매핑의 개념과 정의
- 회원과 주문
- 일대다(1:N), 다대일(N:1)의 양방향 관계입니다. 연관관계의 주인은 외래 키가 있는 주문(Order)입니다. 따라서
Order.member를ORDERS.MEMBER_ID외래 키와 매핑합니다.
- 일대다(1:N), 다대일(N:1)의 양방향 관계입니다. 연관관계의 주인은 외래 키가 있는 주문(Order)입니다. 따라서
- 주문상품과 주문
- 다대일(N:1) 양방향 관계입니다. 외래 키가
주문상품(OrderItem)에 있으므로,주문상품이 연관관계의 주인입니다. 따라서OrderItem.order를ORDER_ITEM.ORDER_ID외래 키와 매핑합니다.
- 다대일(N:1) 양방향 관계입니다. 외래 키가
- 주문상품과 상품
- 다대일(N:1) 단방향 관계입니다.
OrderItem.item을ORDER_ITEM.ITEM_ID외래 키와 매핑합니다.
- 다대일(N:1) 단방향 관계입니다.
- 주문과 배송
- 일대일(1:1) 양방향 관계입니다.
Order.delivery를ORDERS.DELIVERY_ID외래 키와 매핑합니다.
- 일대일(1:1) 양방향 관계입니다.
- 카테고리와 상품
@ManyToMany를 사용해 매핑합니다. 실무에서는@ManyToMany를 사용하지 않는 것이 좋습니다. 여기서는 다대다 관계를 예제로 보여주기 위해 사용했을 뿐입니다.
참고: 외래 키가 있는 곳을 연관관계의 주인으로 정합니다. 연관관계의 주인은 외래 키를 누가 관리하는가의 문제일 뿐, 비즈니스상 우위에 있다고 주인으로 정하면 안 됩니다.
(2) 연관관계 정의 규칙
- 방향: 단방향, 양방향
- 한 객체가 참조용 필드를 갖고 있어 다른 객체를 참조할 수 있는가?
- 연관 관계의 주인: 양방향일 때, 연관 관계에서의 관리 주체
- 연관 관계의 주인은 두 객체 사이에서 조회, 저장, 수정, 삭제가 가능하지만, 주인이 아니면 조회만 가능
- 다중성: 다대일(N:1), 일대다(1:N), 일대일(1:1), 다대다(N:M)
- 다대다(N:M)는 중간 테이블이 숨겨져 있기 때문에 개발자가 모르는 복잡한 조인 쿼리가 발생할 수 있습니다.
- 중간 테이블에 외래 키 외에 다른 정보를 넣어야 할 경우가 많기 때문에, 다대다 관계를 일대다(N:1), 다대일(1:N)로 풀어서 만들어야 변경 사항에도 유연하게 대응할 수 있습니다.
2. 엔티티 클래스 개발
1) 엔티티 클래스 설계 및 주의점
(1) 엔티티 설계 지침
- 엔티티에는 가급적 Setter를 사용하지 말자
- Setter가 모두 열려있으면 변경 포인트가 너무 많아서 유지보수가 어렵습니다. 나중에 리팩토링으로 Setter를 제거해야 합니다.
- 모든 연관관계는 지연로딩으로 설정
- 즉시로딩(EAGER)은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵습니다. 특히 JPQL을 실행할 때 N+1 문제가 자주 발생합니다.
- 실무에서 모든 연관관계는 지연로딩(LAZY)으로 설정해야 합니다.
- 연관된 엔티티를 함께 DB에서 조회해야 하면, fetch join 또는 엔티티 그래프 기능을 사용합니다.
@XToOne(OneToOne, ManyToOne)관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 합니다.
- 컬렉션은 필드에서 초기화 하자
- 컬렉션은 필드에서 바로 초기화 하는 것이 안전합니다. null 문제에서 안전합니다.
- 하이버네이트는 엔티티를 영속화 할 때, 컬렉션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경합니다. 필드레벨에서 생성하는 것이 가장 안전하고, 코드도 간결합니다.
(2) 엔티티 클래스 예제
- 회원 엔티티
package jpabook.jpashop.domain;
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를 사용합니다. 테이블은 관례상 테이블명 + id를 많이 사용합니다. 객체에서id대신에memberId를 사용해도 됩니다. 중요한 것은 일관성입니다.
- 주문 엔티티
package jpabook.jpashop.domain;
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);
}
}
- 주문 상태
package jpabook.jpashop.domain;
public enum OrderStatus {
ORDER, CANCEL
}
- 주문상품 엔티티
package jpabook.jpashop.domain;
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; // 주문 수량
}
- 상품 엔티티
package jpabook.jpashop.domain.item;
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<>();
}
- 상품 - 도서 엔티티
package jpabook.jpashop.domain.item;
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;
}
- 상품 - 음반 엔티티
package jpabook.jpashop.domain.item;
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;
}
- 상품 - 영화 엔티티
package jpabook.jpashop.domain.item;
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;
}
- 배송 엔티티
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", fetch = FetchType.LAZY)
private Order order;
@Embedded
private Address address;
@Enumerated(EnumType.STRING)
private DeliveryStatus status; // ENUM [READY(준비), COMP(배송)]
}
- 배송 상태
package jpabook.jpashop.domain;
public enum DeliveryStatus {
READY, COMP
}
- 카테고리 엔티티
package jpabook.jpashop.domain;
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);
}
}
참고: 실무에서는
@ManyToMany를 사용하지 않습니다.@ManyToMany는 중간 테이블(CATEGORY_ITEM)에 컬럼을 추가할 수 없고, 세밀하게 쿼리를 실행하기 어렵기 때문에 사용하기에 한계가 있습니다. 중간 엔티티(CategoryItem)를 만들고@ManyToOne,@OneToMany로 매핑해서 사용해야 합니다.
- 주소 값 타입
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;
}
}
참고: 값 타입은 변경 불가능하게 설계해야 합니다.
@Setter를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스를 만듭니다. JPA 스펙상 엔티티나 임베디드 타입(@Embeddable)은 자바 기본 생성자(default constructor)를public또는protected로 설정해야 합니다.public으로 두는 것보다는protected로 설정하는 것이 그나마 더 안전합니다. JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문입니다.
2) 테이블, 컬럼명 생성 전략
(1) 테이블, 컬럼명 생성 전략 정의
- 스프링 부트에서 하이버네이트 기본 매핑 전략을 변경하여 실제 테이블 필드명은 다릅니다.
- 문서: Spring Boot Naming Strategy
- Hibernate Naming Guide: Hibernate User Guide
(2) 스프링 부트 신규 설정
- 엔티티(필드) 테이블(컬럼)
- 카멜 케이스 → 언더스코어 (
memberPoint→member_point) .(점) → _(언더스코어)- 대문자 → 소문자
- 카멜 케이스 → 언더스코어 (
(3) 적용 2단계
- 논리명 생성
- 명시적으로 컬럼, 테이블명을 직접 적지 않으면
ImplicitNamingStrategy가 사용됩니다. spring.jpa.hibernate.naming.implicit-strategy: 테이블이나, 컬럼명을 명시하지 않을 때 논리명
- 명시적으로 컬럼, 테이블명을 직접 적지 않으면
- 물리명 적용
spring.jpa.hibernate.naming.physical-strategy: 모든 논리명에 적용되며, 실제 테이블에 적용됩니다. (예:username→usernm등으로 회사 룰로 바꿀 수 있음)
(4) 스프링 부트 기본 설정
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
3. 총 정리
스프링 부트와 JPA를 사용하여 웹 애플리케이션을 개발하기 위해서는 도메인 분석 설계와 엔티티 설계, 그리고 연관관계 매핑을 명확히 이해해야 합니다. 이번 정리를 통해 다음과 같은 주요 개념들을 깊이 있게 이해하고 적용할 수 있어야 합니다.
- 도메인 분석 및 요구사항 정리의 중요성
- 도메인 분석을 통해 시스템의 기능 요구사항을 명확히 파악하고, 이를 바탕으로 핵심 비즈니스 로직을 정의할 수 있습니다. 요구사항을 바탕으로 회원, 상품, 주문 기능을 분리하고 각 기능의 세부 사항(등록, 조회, 수정, 주문, 취소 등)을 정의하는 것이 중요합니다.
- 도메인 모델과 테이블 설계의 필요성
- 도메인 모델과 테이블 설계는 실제 데이터베이스와 애플리케이션의 데이터 구조를 정의합니다. 엔티티 간의 관계를 통해 비즈니스 로직을 구현할 수 있으며, 다대다(N:M) 관계를 일대다(N:1), 다대일(1:N) 관계로 풀어서 설계하는 방식으로 복잡한 관계형 데이터베이스 모델링을 해결할 수 있습니다.
- 연관관계 매핑의 원리와 적용 방법
- 엔티티 간의 연관관계를 매핑할 때는 방향(단방향, 양방향), 연관 관계의 주인, 다중성 등을 고려해야 합니다. 외래 키가 있는 곳을 연관관계의 주인으로 정하고, 주인이 아닌 쪽은 조회만 가능하게 설정하여 데이터의 일관성과 무결성을 유지합니다.
- 엔티티 클래스 설계 시 고려사항
- 엔티티 클래스 설계 시에는 데이터의 일관성과 변경 가능성을 고려하여
Setter를 지양하고,Getter를 활용하여 데이터를 읽기 전용으로 유지하는 것이 중요합니다. 모든 연관관계는 지연 로딩(LAZY)으로 설정하여 성능 최적화와 데이터 조회 시 불필요한 연관 데이터를 로딩하는 문제를 방지해야 합니다.
- 엔티티 클래스 설계 시에는 데이터의 일관성과 변경 가능성을 고려하여
- JPA의 테이블, 컬럼명 생성 전략 이해
- 스프링 부트와 JPA의 기본 설정을 이해하고, 필요에 따라 논리명과 물리명 설정 전략을 조정할 수 있어야 합니다. 예를 들어, 카멜 케이스를 언더스코어로 변환하거나, 대소문자 변환 등 회사의 규칙에 맞게 전략을 변경하여 적용할 수 있습니다.
- 실제 애플리케이션 개발에 활용할 수 있는 지식
- 이번 학습을 통해 도메인 모델링과 JPA 매핑 전략, 엔티티 설계의 중요성을 이해하고, 이를 실제 프로젝트에 적용하는 방법을 배웠습니다. 엔티티 설계 및 연관관계 매핑을 올바르게 이해하고 적용함으로써, 유지보수성이 높은 애플리케이션을 개발할 수 있게 됩니다.
- 실무 적용 시 주의사항
@ManyToMany매핑은 실무에서는 피해야 하며, 다대다 관계를 해결하기 위해 중간 엔티티를 사용하는 것이 바람직합니다. 또한, 엔티티 클래스의 설계 시에는@Entity에 대한 기본적인 규칙을 준수하고, 지연 로딩(FetchType.LAZY)과 같은 최적화 전략을 적극적으로 활용해야 합니다.
'Spring > 웹 애플리케이션 개발' 카테고리의 다른 글
| 06. 주문 도메인 개발 (0) | 2024.09.08 |
|---|---|
| 05. 상품 도메인 개발 (0) | 2024.09.08 |
| 04. 회원 도메인 개발 (0) | 2024.09.08 |
| 03. 애플리케이션 구현 준비 (2) | 2024.09.08 |
| 01. 프로젝트 환경설정 (0) | 2024.09.08 |