-
#Spring boot-6 도메인 분석 설계SPRING-BOOT 2021. 3. 1. 19:35
[출처] 인프런 김영한 강사님 -실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발
도메인 분석 설계
요구사항 분석
실제 동작하는 화면을 먼저 확인한다.
기능 목록
· 회원 기능
· 회원 등록
· 회원 조회
· 상품 기능
· 상품 등록
· 상품 수정
· 상품 조회
· 주문 기능
· 상품 주문
· 주문 내역 조회
· 주문 취소
· 기타 요구사항
· 상품은 재고 관리가 필요하다.
· 상품의 종류는 도서, 음반, 영화가 있다.
· 상품을 카테고리로 구분할 수 있다.
· 상품 주문시 배송 정보를 입력할 수 있다.
도메인 모델과 테이블 설계
회원, 주문, 상품의 관계: 회원은 여러 상품을 주문할 수 있다. 그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다. 하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티 티에서도 거의 사용하지 않는다. 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대 다, 다대일 관계로 풀어냈다.
상품 분류: 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속 구조로 표현했 다. 회원 엔티티 분석
회원 엔티티 분석
회원(Member): 이름과 임베디드 타입인 주소( Address ), 그리고 주문( orders ) 리스트를 가진다.
주문(Order): 한 번 주문시 여러 상품을 주문할 수 있으므로 주문과 주문상품( OrderItem )은 일대다 관계 다. 주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태( status )를 가지고 있다. 주문 상태는 열 거형을 사용했는데 주문( ORDER ), 취소( CANCEL )을 표현할 수 있다.
주문상품(OrderItem): 주문한 상품 정보와 주문 금액( orderPrice ), 주문 수량( count ) 정보를 가지고 있다. (보통 OrderLine , LineItem 으로 많이 표현한다.)
상품(Item): 이름, 가격, 재고수량( stockQuantity )을 가지고 있다. 상품을 주문하면 재고수량이 줄어든 다. 상품의 종류로는 도서, 음반, 영화가 있는데 각각은 사용하는 속성이 조금씩 다르다.
배송(Delivery): 주문시 하나의 배송 정보를 생성한다. 주문과 배송은 일대일 관계다.
카테고리(Category): 상품과 다대다 관계를 맺는다. parent , child 로 부모, 자식 카테고리를 연결한 다.
주소(Address): 값 타입(임베디드 타입)이다. 회원과 배송(Delivery)에서 사용한다.
참고: 회원 엔티티 분석 그림에서 Order와 Delivery가 단방향 관계로 잘못 그려져 있다. 양방향 관계가 맞 다.
참고: 회원이 주문을 하기 때문에, 회원이 주문리스트를 가지는 것은 얼핏 보면 잘 설계한 것 같지만, 객체 세 상은 실제 세계와는 다르다. 실무에서는 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분 하다. 여기서는 일대다, 다대일의 양방향 연관관계를 설명하기 위해서 추가했다.
회원 테이블 분석
MEMBER: 회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어갔다. 이것은 DELIVERY 테이블도 마찬가지다.
ITEM: 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었다. DTYPE 컬럼으로 타입을 구분한다.
참고: 테이블명이 ORDER 가 아니라 ORDERS 인 것은 데이터베이스가 order by 때문에 예약어로 잡고 있 는 경우가 많다. 그래서 관례상 ORDERS 를 많이 사용한다.
참고: 실제 코드에서는 DB에 소문자 + _(언더스코어) 스타일을 사용하겠다.
데이터베이스 테이블명, 컬럼명에 대한 관례는 회사마다 다르다. 보통은 대문자 + _(언더스코어)나 소문자 + _(언더스코어) 방식 중에 하나를 지정해서 일관성 있게 사용한다. 강의에서 설명할 때는 객체와 차이를 나 타내기 위해 데이터베이스 테이블, 컬럼명은 대문자를 사용했지만, 실제 코드에서는 소문자 + _(언더스코 어) 스타일을 사용하겠다.
연관관계 매핑 분석
회원과 주문: 일대다 , 다대일의 양방향 관계다. 따라서 연관관계의 주인을 정해야 하는데, 외래 키가 있는 주 문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로 Order.member 를 ORDERS.MEMBER_ID 외래 키와 매핑한다.
주문상품과 주문: 다대일 양방향 관계다. 외래 키가 주문상품에 있으므로 주문상품이 연관관계의 주인이다. 그러므로 OrderItem.order 를 ORDER_ITEM.ORDER_ID 외래 키와 매핑한다.
주문상품과 상품: 다대일 단방향 관계다. OrderItem.item 을 ORDER_ITEM.ITEM_ID 외래 키와 매핑한다.
주문과 배송: 일대일 양방향 관계다. Order.delivery 를 ORDERS.DELIVERY_ID 외래 키와 매핑한다.
카테고리와 상품: @ManyToMany 를 사용해서 매핑한다.(실무에서 @ManyToMany는 사용하지 말자. 여기 서는 다대다 관계를 예제로 보여주기 위해 추가했을 뿐이다)
참고: 외래 키가 있는 곳을 연관관계의 주인으로 정해라.
연관관계의 주인은 단순히 외래 키를 누가 관리하냐의 문제이지 비즈니스상 우위에 있다고 주인으로 정하면 안된다.. 예를 들어서 자동차와 바퀴가 있으면, 일대다 관계에서 항상 다쪽에 외래 키가 있으므로 외래 키가 있는 바퀴를 연관관계의 주인으로 정하면 된다. 물론 자동차를 연관관계의 주인으로 정하는 것이 불가능 한 것은 아니지만, 자동차를 연관관계의 주인으로 정하면 자동차가 관리하지 않는 바퀴 테이블의 외래 키 값이 업데이트 되므로 관리와 유지보수가 어렵고, 추가적으로 별도의 업데이트 쿼리가 발생하는 성능 문제도 있 다. 자세한 내용은 JPA 기본편을 참고하자.
엔티티 클래스 개발
· 예제에서는 설명을 쉽게하기 위해 엔티티 클래스에 Getter, Setter를 모두 열고, 최대한 단순하게 설계
· 실무에서는 가급적 Getter는 열어두고, Setter는 꼭 필요한 경우에만 사용하는 것을 추천
참고: 이론적으로 Getter, Setter 모두 제공하지 않고, 꼭 필요한 별도의 메서드를 제공하는게 가장 이상적 이다. 하지만 실무에서 엔티티의 데이터는 조회할 일이 너무 많으므로, Getter의 경우 모두 열어두는 것이 편리하다. Getter는 아무리 호출해도 호출 하는 것 만으로 어떤 일이 발생하지는 않는다. 하지만 Setter는 문제가 다르다. Setter를 호출하면 데이터가 변한다. Setter를 막 열어두면 가까운 미래에 엔티티에가 도대 체 왜 변경되는지 추적하기 점점 힘들어진다. 그래서 엔티티를 변경할 때는 Setter 대신에 변경 지점이 명확 하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 한다.
회원 엔티티 jpabook.jpashop.domain.Member.java
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")//order table 에 있는 member field에 의해서 메핑된거야 읽기전용 private List<Order> orders = new ArrayList<>(); }
참고: 엔티티의 식별자는 id 를 사용하고 PK 컬럼명은 member_id 를 사용했다. 엔티티는 타입(여기서는 Member )이 있으므로 id 필드만으로 쉽게 구분할 수 있다. 테이블은 타입이 없으므로 구분이 어렵다.
그리 고 테이블은 관례상 테이블명 + id 를 많이 사용한다. 참고로 객체에서 id 대신에 memberId 를 사용해도 된다. 중요한 것은 일관성이다.
주문 엔티티 jpabook.jpashop.domain.Order.java
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) //em.find 해서 한건 들고올때는 가능 @JoinColumn(name = "member_id")//외래키 이름이 member_id가 된다. private Member member; @OneToMany(mappedBy = "order", cascade = CascadeType.ALL) //casecade orderitems에다가 데이터를 넣어두고 저장하면 order까지 같이 저장된다. private List<OrderItem> orderItems = new ArrayList<>(); /* * persist(orderItemA) * persist(orderItemB) * persist(orderItemC) * persist(order)를해줘야하는데 * * casecade는 * presist(order)만 해줘도된다. * * order를 persist하면 casecade는 전파하여 orderItems안에 있는 A,B,C persist같이해준다 delete할때도 같이 지워버린다. * */ @OneToOne(fetch = FetchType.LAZY, cascade = CascadeType.ALL) //1:1일경우 왜래키를 어디에 두냐? access 를 많이하는곳을 기본으로 둔다. //연관관게의 주인을 order의 delivery로 한다. //order를 저장할떄 delivery도 같이 저장해준다. //모든 엔티티는 persist를 각각해줘야하는데 casecade를 해주면 같이 persist호출된다. @JoinColumn(name = "delivery_id") private Delivery delivery; private LocalDateTime orderDate; //주문시간 //Date를 쓸경우 오노테이션을 따로 매핑해줘야하지만 // localDateTime은 하이버네이트가 지원을 해준다. @Enumerated(EnumType.STRING) private OrderStatus status;//주문상태 [ORDER,CANCEL] //==연관관계 편의 메서드==// //만드는 이유 //양방향 연관관계를 세팅할려고하면 값을 양쪽에 다 넣어줘야한다. //DB에 저장하는건 연관관계 주인에 있으면 되는데 로직을 태울떄 왓다갓다할려면 양쪽에 다 필요하다. //원래대로라고하면 /* * Member member = new Member(); * Order order = new Order(); * * member.getOrders().add(order); * order.setMember(member); 이렇게 되어야 한다. * * 문제는 코드를 작성하다보면 사람들이 깜빡할 수 있기 떄문에 * 두개를 원자적으로 묶는 메서드를 만드는 것이다. * */ //편의 메서드는 어디있으면 좋은가? 실직적으로 컨트롤 하는 곳에 있으면 좋다. 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); } }
주문상태 jpabook.jpashop.domain.OrderStatus.java
package jpabook.jpashop.domain; public enum OrderStatus { ORDER, CANCEL }
주문상품 엔티티 jpabook.jpashop.domain.OrderItem.java
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; //주문 수량 }
상품 엔티티 jpabook.jpashop.domain.item.Item.java
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<Category>(); }
book 엔티티 jpabook.jpashop.domain.item.Book.java
package jpabook.jpashop.domain.item; import lombok.Getter; import lombok.Setter; import javax.persistence.DiscriminatorValue; import javax.persistence.Entity; @Entity @Getter @Setter @DiscriminatorValue("B")//싱글 테이블이라서 저장시 구분을 할수 있어야한다. public class Book extends Item{ private String author; private String isbn; }
album 엔티티 jpabook.jpashop.domain.item.Album.java
package jpabook.jpashop.domain.item; import lombok.Getter; import lombok.Setter; import javax.persistence.DiscriminatorValue; import javax.persistence.Entity; @Entity @Getter @Setter @DiscriminatorValue("A") public class Album extends Item{ private String artist; private String etc; }
Movie엔티티 jpabook.jpashop.domain.item.Movie.java
package jpabook.jpashop.domain.item; import lombok.Getter; import lombok.Setter; import javax.persistence.DiscriminatorValue; import javax.persistence.Entity; @Entity @Getter @Setter @DiscriminatorValue("M") public class Movie extends Item{ private String director; private String actor; }
배송 엔티티 jpabook.jpashop.domain.Delivery.java
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")//1:1일경우 왜래키를 어디에 두냐? access 를 많이하는곳을 기본으로 둔다. private Order order; @Embedded private Address address; //enum 타입은 @Enumerated을꼭 넣어야하고 EnumType String을 꼭해줘야한다. @Enumerated(EnumType.STRING) private DeliveryStatus status; }
배송 상태 jpabook.jpashop.domain.DeliveryStatus.java
package jpabook.jpashop.domain; public enum DeliveryStatus { READY,COMP }
카테고리 엔티티 jpabook.jpashop.domain.Category.java
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")//중간테이블에 있는 카테고리 ID , inverseJoinColumns = @JoinColumn(name="item_id")//이테이블에 아이탬쪽으로 들어가는 컬럼 매핑 ) //다대다는 중간테이블 메핑을 위해 조인 테이블이 필요하다. //객체는 다 컬렉션 켈랙션이 있어서 다대다가 가능한데, //RDB는 컬렉션관계를 양쪽에 가질수 없기때문에 1:N N:1로 풀어내는 중간 테이블이 필요하다. //실전에서 쓰지 못하는 경우는 딱 저그림밖에 안됨. 더이상 추가가 안된다. 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 로 매핑해서 사용하자. 정리하면 대다대 매핑을 일대다, 다대일 매핑으로 풀어 내서 사용하자.
주소값타입 jpabook.jpashop.domain.Address.java
package jpabook.jpashop.domain; import lombok.Getter; import lombok.Setter; import javax.persistence.Column; import javax.persistence.Embeddable; import javax.persistence.GeneratedValue; import javax.persistence.Id; @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; } }
참고: 값 타입은 변경 불가능하게 설계해야 한다.
1. @Setter제거 후 생성자 생성
- @Setter 를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스를 만들자.
- 값이라는것은 enutable하게 설정되야한다 생성할때만 값이 설정되고 setter를 제공안하는 것이다.(변경불가능상태)
만약 만들려면 복사를하거나 똑같은 객체를 만들어서 등록해야한다.
2. 기본 생성자 생성
- JPA 스펙상 엔티 티나 임베디드 타입( @Embeddable )은 자바 기본 생성자(default constructor)를 public
또는 protected 로 설정해야 한다. public 으로 두는 것 보다는 protected 로 설정하는 것이 그나마 더 안전 하다.
portected를 통해 JPA스팩상 만든거구나 손대지말자~ , 함부로 NEW로 생성하면 안되겟다는 것을 안다.
- JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록
지원해야 하기 때문이다.
엔티티 설계시 주의점
엔티티에는 가급적 Setter를 사용하지 말자
Setter가 모두 열려있다. 변경 포인트가 너무 많아서, 유지보수가 어렵다. 나중에 리펙토링으로 Setter 제거
모든 연관관계는 지연로딩으로 설정!★★(LAZY)
· 즉시로딩( EAGER )은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다.
특히 JPQL을 실행할 때 N+1 문제가 자주 발생한다.
· 실무에서 모든 연관관계는 지연로딩( LAZY )으로 설정해야 한다.
· 연관된 엔티티를 함께 DB에서 조회해야 하면, fetch join 또는 엔티티 그래프 기능을 사용한다.
· @XToOne(OneToOne, ManyToOne) 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 한 다.
@ManyToOne(fetch = FetchType.EAGER) //em.find 해서 한건 들고올때는 가능 @JoinColumn(name = "member_id")//외래키 이름이 member_id가 된다. private Member member;
EAGER를 해놓으면 ORDER를 조회할때 MEMBER를 조인해서 쿼리한방에 한번에 들고온다.
em.find로 한건들고올때는 EAGER가 가능하지만
JPQL로 select 0 From order o; 를 할경우 -> EAGER이런거 다무시하고 SQL로 SELECT * FROM ORDER를 한다.
근데 여기서 만약 ORDER가 100개가 있으면 100개를 가져왔는데 보니깐 EAGER로 되있어 그러면
ORDER날리는 쿼리가 100갠데 그 만큼 MEMBER를 들고오기위해서 100번 단건 쿼리가 날라간다.
EAGER의 뜻은 조인해서 한번에 가져오겠다는 것이아니라 ORDER를 조인하는 시점에 MEMBER도 같이 조인해서 들고오겠다는 것이다.
컬렉션은 필드에서 초기화 하자.
@OneToMany(mappedBy = "member") private List<Order> orders = new ArrayList<>();
컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.
· null 문제에서 안전하다.
· 하이버네이트는 엔티티를 영속화 할 때, 컬랙션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다.
만약 getOrders() 처럼 임의의 메서드에서 컬력션을 잘못 생성하면 하이버네이트 내부 메커니즘에 문제가 발생할
수 있다. 따라서 필드레벨에서 생성하는 것이 가장 안전하고, 코드도 간결하다
Member member = new Member(); System.out.println(member.getOrders().getClass()); em.persist(team);//영속한다 -> getOrders() 커넥션을 영속성 컨텍스트에서 관리 System.out.println(member.getOrders().getClass()); //출력 결과 class java.util.ArrayList class org.hibernate.collection.internal.PersistentBag
class 결과가 영속하고난 뒤 바뀌는 이유는 컬렉션을 영속성 컨텍스트에서 관리하기 때문이다.
기존거를 들고 감싸는것이다. 하이버네이트가 이 컬렉션이 변경된 것을 추적해야하기 때문에 추적할 수 있는
본인의 PersistentBag(타입마다 다름)과 같은것으로 바꾸어버린다.
문제점! : 하이버네이트가 기껏 바꿔낫는데 누군가가 여기서 set해서 바꿔버리면? 하이버네이트가 원하는 매커니즘으로 안돌아가는것이다.
해결책!: 컬렉션을 생성하고 컬렉션을 가급적이면 밖으로 꺼내지도 말고 변경하면 안된다.
처음 객체 생성해놓고 컬렉션자체를 바꾸면안된다. 있는거 그냥쓰는게 제일 낫다.
테이블, 컬럼명 생성 전략
스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다름
Spring Boot Reference Guide
This section dives into the details of Spring Boot. Here you can learn about the key features that you may want to use and customize. If you have not already done so, you might want to read the "Part II, “Getting Started”" and "Part III, “Using Spr
docs.spring.io
하이버네이트 기존 구현: 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용
( SpringPhysicalNamingStrategy )
스프링 부트 신규 설정 (엔티티(필드) 테이블(컬럼)) -SpringPhysicalNamingStrategy를 사용하면
1. 카멜 케이스 언더스코어(memberPoint → member_point)
2. .(점) → _(언더스코어)
3. 대문자 → 소문자
적용 2 단계
1. 논리명 생성: 명시적으로 컬럼, 테이블명을 직접 적지 않으면 ImplicitNamingStrategy 사용
spring.jpa.hibernate.naming.implicit-strategy : 테이블이나, 컬럼명을 명시하지 않을 때 논리명 적용,
2. 물리명 적용: spring.jpa.hibernate.naming.physical-strategy : 모든 논리명에 적용됨, 실제 테이블에 적용
(username usernm 등으로 회사 룰로 바꿀 수 있음)
스프링 부트 기본 설정
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
'SPRING-BOOT' 카테고리의 다른 글
#Spring boot-7_1 TEST CASE 작성 중 발생 에러 (0) 2021.03.04 #Spring boot-7 애플리케이션 구현 준비 (0) 2021.03.03 #Spring boot-5 JPA와 DB 설정, 동작확인 (0) 2021.03.01 #Spring boot-4 H2 데이터베이스 설치 (0) 2021.02.26 #Spring boot-3 View 환경설정 (0) 2021.02.26