스프링 부트와 JPA 활용 1 - 웹 애플리케이션 개발 수업을 듣고 정리한 내용입니다.
📚 1. 요구사항 분석
실제 동작하는 화면을 먼저 확인한다.
기능 목록
(1) 회원 기능
- 회원 등록
- 회원 조회
(2) 상품 기능
- 상품 등록
- 상품 수정
- 상품 조회
(3) 주문 기능
- 상품 주문
- 주문 내역 조회
- 주문 취소
(4) 기타 요구사항
- 상품은 재고 관리가 필요하다.
- 상품의 종류는 도서, 음반, 영화가 있다.
- 상품을 카테고리로 구분할 수 있다.
- 상품 주문시 배송 정보를 입력할 수 있다.
📚 2. 도메인 모델과 테이블 설계
✔️ 회원, 주문, 상품의 관계
- 회원은 여러 상품을 주문할 수 있다. 그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다.
- 하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용하지 않는다.
- 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어냈다.
✔️ 상품 분류
- 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속 구조로 표현했다.
📖 A. 회원 엔터티 분석
회원(Member)
String name: 이름Address address: 주소 (임베디드 타입)List orders: 주문 리스트
주문(Order)
- 주문과 주문상품(
OrderItem)은 일대다 관계 Member member: 상품을 주문한 회원List orderItems: 주문 상품Delivery delivery: 배송 정보Date orderDate: 주문 날짜OrderStatus status: 주문 상태- 열거형. 주문(
OREDER), 취소(CANCEL) 표현 가능
- 열거형. 주문(
주문상품(OrderItem)
Item item: 상품 정보Order order: 주문 정보orderPrice: 주문 금액count: 주문 수량
상품(Item)
name: 이름price: 가격stockQuantity: 재고수량- 상품을 주문하면 재고수량이 줄어든다.
- 상품 종류로는 음반(
Album), 도서(Book), 영화(Movie)가 있는데, 각각은 속성이 조금씩 다르다.
배송(Delivery)
- 주문시 하나의 배송 정보를 생성한다.
- 주문(
Order)과 배송은 일대일 관계 name: 이름price: 가격stockQuantity: 재고수량- 상품을 주문하면 재고수량이 줄어든다.
- 상품 종류로는 음반(
Album), 도서(Book), 영화(Movie)가 있는데, 각각은 속성이 조금씩 다르다.
카테고리(Category)
- 상품과 다대다 관계를 맺는다.
parent,child로 부모, 자식 카테고리를 연결한
다.
주소(Address)
- 값 타입 (임베디드 타입)이다.
- 회원(
Member)과 배송(Delivery)에서 사용한다.
💡 참고
- 실무에서는 회원이 주문리스트를 가지도록 설계하지 말자!
- 다대다 관계를 사용하면 안된다!
- 가급적이면 양방향 연관관계보다는 당방향 연관관계를 사용하자!
- 실무에서는 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분하다.
- 주문을 생성할 때 회원이 필요하기 때문이다.
- 지금은
Member가orderList를 가지도록 설계되었다.
- 이는 다대다 관계로 설계한 것인데, 다대다 대시
1:다&다:1로 풀어내야 한다.- 여기서는 일대다, 다대일으 양방향 연관관계를 설명하기 위해서 추가한 것으로, 실제로는
Member에orderList는 필요가 없다.
📖 B. 회원 테이블 분석
MEMBER
- 회원 엔티티의
Address임베디드 타입 정보가 회원 테이블에 그대로 들어갔다. 이것은DELIVERY테이블도 마찬가지다.
ITEM
- 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었다.
DTYPE컬럼으로 타입을 구분한다.
💡 참고
- 테이블명이
ORDER가 아니라ORDERS인 것은 데이터베이스가order by때문에 예약어로 잡고 있는 경우가 많다. 그래서 관례상ORDERS를 많이 사용한다.- 실제 코드에서는 DB에
소문자 + _(언더스코어)스타일을 사용하겠다.
- 데이터베이스 테이블명, 컬럼명에 대한 관례는 회사마다 다르다. 보통은
대문자 + _(언더스코어)나소문자 + _(언더스코어)방식 중에 하나를 지정해서 일관성 있게 사용한다.- 강의에서는 객체와 차이를 나타내기 위해 데이터베이스 테이블, 컬럼명은 대문자를 사용했지만, 실제 코드에서는
소문자 + _(언더스코어)스타일을 사용한다.
📖 C. 연관관계 매핑 분석
회원과 주문
- 일대다, 다대일의 양방향 관계다.
- 따라서 연관관계의 주인을 정해야 하는데, 외래 키가 있는 주 문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로
Order.member를ORDERS.MEMBER_ID외래 키와 매핑한다. - 양방향 연관관계에서는 주인 쪽에 외래키를 주고, 반대에서는 외래키와 매핑한다.
주문상품과 주문
- 다대일 양방향 관계다.
- 외래 키가 주문상품에 있으므로 주문상품이 연관관계의 주인이다. 그러므로
OrderItem.order를ORDER_ITEM.ORDER_ID외래 키와 매핑한다.
주문상품과 상품
- 다대일 단방향 관계다.
OrderItem.item을ORDER_ITEM.ITEM_ID외래 키와 매핑한다.
주문과 배송
- 일대일 양방향 관계다.
Order.delivery를ORDERS.DELIVERY_ID외래 키와 매핑한다.- 일대일 관계일 때, 외래키
FK(Foreign Key)가 있는 곳을 연관관계 주인으로 정한다.
카테고리와 상품
@ManyToMany를 사용해서 매핑한다.- 실무에서
@ManyToMany는 사용하지 말자. 여기서는 다대다 관계를 예제로 보여주기 위해 추가했을 뿐이다.
💡 참고
외래 키가 있는 곳을 연관관계의 주인으로 정해라!
- 연관관계의 주인은 단순히 외래 키를 누가 관리하냐의 문제이지 비즈니스상 우위에 있다고 주인으로 정하면 안된다.
- 예를 들어서 자동차와 바퀴가 있으면, 일대다 관계에서 항상 다쪽에 외래 키가 있으므로 외래 키가 있는 바퀴를 연관관계의 주인으로 정하면 된다. 물론 자동차를 연관관계의 주인으로 정하는 것이 불가능한 것은 아니지만, 자동차를 연관관계의 주인으로 정하면 자동차가 관리하지 않는 바퀴 테이블의 외래 키 값이 업데이트 되므로 관리와 유지보수가 어렵고, 추가적으로 별도의 업데이트 쿼리가 발생하는 성능 문제도 있다. 자세한 내용은 JPA 기본편을 참고하자.
📚 3. 엔터티 클래스 개발
✏️ 시작하기에 앞서
- 예제에서는 설명을 쉽게하기 위해 엔티티 클래스에
Getter,Setter를 모두 열고, 최대한 단순하게 설계- 실무에서는 가급적
Getter는 열어두고,Setter는 꼭 필요한 경우에만 사용하는 것을 추천
💡 참고
- 이론적으로
Getter,Setter모두 제공하지 않고, 꼭 필요한 별도의 메서드를 제공하는게 가장 이상적 이다.- 하지만 실무에서 엔티티의 데이터는 조회할 일이 너무 많으므로,
Getter의 경우 모두 열어두는 것이 편리하다.Getter는 아무리 호출해도 호출하는 것만으로 어떤 일이 발생하지는 않는다.- 하지만
Setter는 문제가 다르다.Setter를 호출하면 데이터가 변한다.Setter를 막 열어두면 가까운 미래에 엔티티에가 도대체 왜 변경되는지 추적하기 점점 힘들어진다.- 그래서 엔티티를 변경할 때는
Setter대신에 변경 지점이 명확하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 한다.
회원 엔티티
package jpabook.jpashop.domain;
import lombok.Getter;
import lombok.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를 사용해도 된다. 중요한 것은 일관성이다.
주문 엔티티
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 jpabook.jpashop.domain.Item.Item;
import lombok.Getter;
import lombok.Setter;
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 jpabook.jpashop.domain.Category;
import lombok.Getter;
import lombok.Setter;
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>();
}
상품 - 도서 엔터티
package jpabook.jpashop.domain.Item;
import lombok.Getter;
import lombok.Setter;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
@Setter
@DiscriminatorValue("B")
@Getter
@Entity
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;
@Setter
@DiscriminatorValue("A")
@Getter
@Entity
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;
@Setter
@DiscriminatorValue("M")
@Getter
@Entity
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; // READY(준비), COMP(배송)
}
@Enumerated(EnumType.ORDINAL): default 값, enum에 숫자로 들어간다. (입력 순서대로 번호가 주어진다.)@Enumerated(EnumType.STRING): 문자를 넣어줌으로써 순서가 변경되어도 이전과 동일방식으로 적용된다.
배송 상태
package jpabook.jpashop.domain;
public enum DeliveryStatus {
READY, COMP
}
카테고리 엔티티
package jpabook.jpashop.domain;
import jpabook.jpashop.domain.Item.Item;
import lombok.Getter;
import lombok.Setter;
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);
}
}
inverseJoinColumns: 반대방향 엔티티를 참조하는 외래키joinColumns: 현재 엔티티를 참조하는 외래키
@JoinColumn(name = "parent_id")
private Category parent;
@OneToMany(mappedBy = "parent")
private List<Category> child = new ArrayList<>();- 양방향 연관관계
- 같은 엔티티(클래스) 내에서 연관관계 매핑
💡 참고
실무에서는@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 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.
실행 결과
먼저 도메인 분석을 통해 설계를 한후, Jpa 작성하여 실행하면 로그에
alter table category_item
add constraint FKcq2n0opf5shyh84ex1fhukcbh
foreign key (category_id)
references category;이와 같이 출력되는 것을 보고 하고 실행하여(위 왼쪽 사진과 같이) 테이블 생성된 것을 보고 원하는대로 생성되는지 확인한다. ➡️ 기대한 결과가 나올 수 있도록 대신, (bash에 출력된 테이블들) 생성된 거를 그대로 사용하면 안된다. 참고해서 텍스트에 복사해서 검증하는 과정을 거쳐야 한다. (필요한 것들을 얻도록 검증함, 필요없는 것들은 제거하고 필요한 부분에 기능을 추가하며 완성해 나아가면 된다.)
📚 4. 엔티티 설계시 주의점
✔️ 엔티티에는 가급적 Setter를 사용하지 말자
Setter가 열려있을시 변경 포인트가 너무 많아서, 유지보수가 어렵다!
✔️ 모든 연관관계는 지연로딩으로 설정!
즉시로딩( EAGER )은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다.
-
특히 JPQL을 실행할 때 N+1 문제가 자주 발생한다. (N + 1 문제란 무엇인가?)
-
모든 연관관계는 지연로딩(
LAZY)으로 설정해야 한다. -
연관된 엔터티를 함께 DB에서 조회해야 한다면,
fetch join또는 엔터티 그래프 기능을 사용한다. -
@XToOne(OneToOne, ManyToOne은 기본 값이EAGER(즉시로딩) 이므로LAZY(지연로딩) 로 직접 설정해줘야 한다.
✔️ 컬렉션은 필드에서 초기화 하자!
컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.
null문제에서 안전하다.- 하이버네이트는 엔티티를 영속화 할 때, 컬랙션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다.
- 만약,
getOrders()처럼 임의의 메서드에서 컬력션을 잘못 생성하면 하이버네이트 내부 메커니즘에 문제가 발생할 수 있다. (필드 레벨에서 생성하는 것이 가장 안전, 코드도 간결하다!)
- 만약,
Member member = new Member();
System.out.println(member.getOrders().getClass());
em.persist(team);
System.out.println(member.getOrders().getClass());
//출력 결과
class java.util.ArrayList
class org.hibernate.collection.internal.PersistentBag // 영속성 컨텍스트에 저장하는 순간(persist) 감싸버림
em.persist(team)을 호출하고 나서 클래스를 호출할시class org.hibernate.collection.internal.PersistentBag: 영속성 컨텍스트에 저장하는 순간(persist) 감싸버림
✔️ 테이블, 컬럼명 생성 전략
스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다르다.
- 하이버네이트 기존 구현 : 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용 (
SpringPhysicalNamingStrategy)
🔔 스프링 부트 신규 설정 (엔티티(필드) → 테이블(컬럼))
(1) 카멜 케이스 → 언더스코어(memberPoint→member_point)
(2).(점) →_(언더스코어)
(3) 대문자 → 소문자
🔔 적용 두 개의 단계
(1) 논리명 생성 : 명시적으로 컬럼, 테이블명을 직접 적지 않으면ImplicitNamingStrategy사용
spring.jpa.hibernate.naming.implicit-strategy: 테이블이나, 컬럼명을 명시하지 않을 때 논리명 적용(2) 물리명 적용
spring.jpa.hibernate.naming.physical-strategy: 모든 논리명에 적용됨, 실제 테이블에 적용 (username→usernm등으로 회사 룰로 바꿀 수 있다.)
✔️ cascade = CascadeType.ALL 이란?
public class Order{
@OneToOne(cascade = CascadeType.ALL)
private Delivery delivery;
}Order을 저장할 때(persist)Delivery도 같이 저장된다.(persist)- 원래라면
Order과Delivery둘 다 따로 호출해서 저장해야하지만(따로 persist를 해야하지만), 이를 사용시Order을 영속성 컨텍스트에 저장하면Delivery도 같이 저장된다.
✔️ 연관 관계 편의 메서드
// 현재 Order 클래스 안이다.
class Order{
//==연관 관계 편의 메서드==//
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);
}
}// 원래는 이렇게 양방향을 다 호출해서 값을 넣어야 했다.
Member member = new Member();
Order order = new Order();
member.getOrders().add(order);
order.setMember(member);
// 이를 사용하면 양방향에 값을 넣을 수 있다.(코드 간단)
this.member = member;
member.getOrders().add(this);
- 양방향 연관관계를 맺을 때에는, 양쪽 모두 관계를 맺어주어야한다. 이때 연관 관계 편의 메서드를 사용하면 좋다.
- 연관 관계 편의 메서드 : 연관 관계 양쪽을 편하게 연결 하는 것(코드를 줄인다.)
"야, (오류 만났어?) 너두 (해결) 할 수 있어"