[Spring boot & JPA] 02. 도메인 분석 설계

PADO·2021년 1월 28일
1

Spring boot & JPA

목록 보기
3/6
post-thumbnail

🌱 도메인 분석 설계

요구사항 분석

UI

기능 목록

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

 

도메인 모델과 테이블 설계

도메인 모델

  • 회원은 여러 상품을 주문할 수 있다. (1:N)
  • 한 주문에는 여러 상품이, 한 상품은 여러 주문에 담길 수 있다. (N:N)
    → 주문상품이라는 엔티티를 추가해 N:N → 1:N & N:1로 풀어냈다.
  • 주문 시에 배송 정보를 입력할 수 있다. (1:1)
  • 상품은 도서, 음반, 영화 타입으로 구분되어 상속 구조로 표현했다.
  • 한 카테고리에는 여러 상품이, 한 상품은 여러 카테고리에 들어갈 수 있다. (N:N)

회원 엔티티 분석

공통속성인 PK는 generated 되는 Long 타입으로 설계했다.

회원(Member)

이름과 임베디드 타입인 주소( Address ), 그리고 주문( orders ) 리스트를 가진다.

주문(Order)

한 번 주문시 여러 상품을 주문할 수 있으므로 주문과 주문상품( OrderItem )은 일대다 관계다. 주문은 상품을 주문한 회원과 배송 정보, 주문 날짜, 주문 상태( status )를 가지고 있다. 주문 상태는 열
거형을 사용했는데 주문( ORDER ), 취소( CANCEL )을 표현할 수 있다.

주문상품(OrderItem)

주문한 상품 정보와 주문 금액( orderPrice ), 주문 수량( count ) 정보를 가지고 있다. (보통 OrderLine , LineItem 으로 많이 표현한다.)

상품(Item)

이름, 가격, 재고수량( stockQuantity )을 가지고 있다. 상품을 주문하면 재고수량이 줄어든다. 상품의 종류로는 도서, 음반, 영화가 있는데 각각은 사용하는 속성이 조금씩 다르다.

배송(Delivery)

주문시 하나의 배송 정보를 생성한다. 주문과 배송은 일대일 관계다.

카테고리(Category)

상품과 다대다 관계를 맺는다. parent , child 로 부모, 자식 카테고리를 연결한다.

주소(Address)

값 타입(임베디드 타입)이다. 회원과 배송( Delivery )에서 사용한다.

실무에서 운영시에 주의할 점

  • JPA의 다대다(@ManyToMany) 관계는 운영시에 사용하면 안 된다.
    → 1:다 & 다:1로 풀어내야 한다.
  • 가급적이면 양방향 연관관계보단 단방향 연관관계를 사용한다.
    (현재는 Member가 Order를 1:다로, Order도 Member를 가지고 있는 양방향 연관관계)
    → 실무에서는 회원이 주문을 참조하지 않고, 주문이 회원을 참조하는 것으로 충분하다.
    - 회원을 통해 주문이 일어난다 (x)
    - 주문을 생성할 때 회원이 필요하다 (o)
    - 주문 내역이 필요하면 Member를 찾아 List로 Order를 찾아오는 것이 아니라 Order의 필터링 조건에 Member가 들어가는 것.
    (사실 Member의 Order Collection은 필요 없다. 여기서는 일대다, 다대일의 양방향 연관관계를 써보기 위해서 추가했다.)

회원 테이블 분석

MEMBER

회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어갔다. 이것은 DELIVERY 테이블도 마찬가지다.

ITEM

앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었다. DTYPE 컬럼으로 타입을 구분한다. (Single Table 전략)

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

CATEGORY

객체에서는 CategoryItem 을 List로, ItemCategory 를 List로 가지며 다:다 관계를 만들 수 있다. 하지만 관계형 데이터 베이스에서는 중간에 CATEGORY_ITEM 이라는 매핑 테이블을 두어 N:N 관계를 N:1 관계와 1:N 관계로 풀어내야 한다.

연관관계 매핑 분석

회원과 주문

일대다, 다대일의 양방향 관계다. 따라서 연관관계의 주인을 정해야 하는데, 외래 키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로 Order.memberORDERS.MEMBER_ID 외래 키와 매핑한다.
Order.member: 주인. 값 세팅 가능, Member.orders: 조회만 가능

주문상품과 주문

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

주문상품과 상품

다대일 단방향 관계다. OrderItem.itemORDER_ITEM.ITEM_ID 외래 키와 매핑한다.

주문과 배송

일대일 양방향 관계다. Order.deliveryORDERS.DELIVERY_ID 외래 키와 매핑한다.

카테고리와 상품

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

참고) 외래 키가 있는 곳을 연관관계의 주인으로 정해라.

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

 

엔티티 클래스 개발

  • 예제에서는 설명을 쉽게하기 위해 엔티티 클래스에 Getter, Setter를 모두 열고, 최대한 단순하게 설계
  • 실무에서는 가급적 Getter는 열어두고, Setter는 꼭 필요한 경우에만 사용

참고 1) 이론적으로 Getter, Setter 모두 제공하지 않고, 꼭 필요한 별도의 메서드를 제공하는게 가장 이상적이다.
하지만 실무에서 엔티티의 데이터는 조회할 일이 너무 많으므로, Getter의 경우 모두 열어두는 것이 편리하다. Getter는 아무리 호출해도 호출 하는 것 만으로 어떤 일이 발생하지는 않는다. 하지만 Setter는 문제가 다르다. Setter를 호출하면 데이터가 변한다. Setter를 막 열어두면 가까운 미래에 엔티티에가 도대체 왜 변경되는지 추적하기 점점 힘들어진다. 그래서 엔티티를 변경할 때는 Setter 대신에 변경 지점이 명확하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 한다.

참고 2) 엔티티의 식별자는 id 를 사용하고 PK 컬럼명은 member_id 를 사용했다.
엔티티는 타입(여기서는 Member )이 있으므로 id 필드만으로 쉽게 구분할 수 있다. 테이블은 타입이 없으므로 구분이 어렵다. 그리 고 테이블은 관례상 테이블명 + id 를 많이 사용한다. 참고로 객체에서 id 대신에 memberId 를 사용해도 된다. 중요한 것은 일관성이다.

참고 3) 실무에서는 @ManyToMany 를 사용하지 말자
@ManyToMany 는 편리한 것 같지만, 중간 테이블( CATEGORY_ITEM )에 컬럼을 추가할 수 없고, 세밀하게 쿼리를 실행하기 어렵기 때문에 실무에서 사용하기에는 한계가 있다. 중간 엔티티( CategoryItem 를 만들고
@ManyToOne , @OneToMany 로 매핑해서 사용하자. 정리하면 대다대 매핑을 일대다, 다대일 매핑으로 풀어내서 사용하자.

참고 4) '값 타입'은 변경 불가능하게 설계해야 한다.
@Setter 를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스를 만들자. JPA 스펙상 엔티티나 임베디드 타입( @Embeddable )은 자바 기본 생성자(default constructor)를 public 또는 protected 로 설정해야 한다. public 으로 두는 것 보다는 protected 로 설정하는 것이 그나마 더 안전하다.
JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.

 

엔티티 설계시 주의점

엔티티에는 가급적 Setter를 사용하지 말자

Setter가 모두 열려있다면 변경 포인트가 너무 많아서, 유지보수가 어렵다. → 나중에 리펙토링으로 Setter 제거 후 비즈니스 메서드로 개발.

모든 연관관계는 지연로딩( LAZY )으로 설정!

  • 즉시로딩( EAGER )은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다. 특히 JPQL을 실행할 때 N+1 문제가 발생한다.
  • 실무에서 모든 연관관계는 지연로딩( LAZY )으로 설정해야 한다.
  • 연관된 엔티티를 함께 DB에서 조회해야 하면, fetch join 또는 엔티티 그래프 기능을 사용한다.
  • @XToOne(OneToOne, ManyToOne) 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야 한다.

Cascade = ALL 옵션을 활용 하자

  1. 완전 개인 소유인 경우 사용할 수 있다.
  2. DDD의 Aggregate Root와 어울린다.
  3. 애매하면 사용하지 않는다.

모든 엔티티는 값을 저장할 때 기본적으로 persist 를 각각 해줘야 하는데, CascadeTypeALL 로 설정했다면 연관된 엔티티까지 함께 저장된다.

통상적으로 권장하는 cascade 범위는, 완전히 개인 소유하는 엔티티일 때, 예를 들어서 게시판과 첨부파일이 있을 때 첨부파일은 게시판 엔티티만 참조하므로, 개인 소유다. 이런 경우에는 사용해도 된다. 그럼 반대로 개인 소유하지 않는 엔티티는? 예를 들어서, 회원, 상품 등등이 있다.

이 예제에서 Order → OrderItem을 개인소유 하기 때문에 cascade를 사용했다. 그런데 Order 입장에서 Delivery는 좀 애매하다. 여기서는 프로젝트 규모가 작기 때문에 매우 단순하게 표현했지만, 실무에서 프로젝트 규모가 커지면, Delivery는 여러곳에서 참조될 수 있다. 그러면 사용하면 안 된다.

양방향 연관관계 사용시 편의 메서드를 활용 하자

양방향 연관관계 사용 시 양쪽에 값을 세팅해야 한다.

member.getOrders().add(order);
order.setMember(member);

아래와 같이 연관관계 편의 메서드를 사용하면 위의 코드 작성시 발생할 수 있는 실수를 없앨 수 있다.

//==연관관계 편의 메서드==//
public void setMember(Member member) {
		this.member = member;
		member.getOrders().add(this);
}

위와 같은 메서드를 사용하면 orders.setMember(member)만 호출하면 돼서 양방향으로 값을 세팅할 필요가 없어진다.

컬렉션은 필드에서 초기화 하자

컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.

  • 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

테이블, 컬럼명 생성 전략

스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다르다.

Spring Boot Reference Guide

Index of /hibernate/orm/5.4/userguide/html_single

하이버네이트 기존 구현: 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용 ( SpringPhysicalNamingStrategy )

스프링 부트 신규 설정 ( 엔티티(필드) → 테이블(컬럼) )

  1. 카멜 케이스 → 언더스코어 ( memberPointmember_point )
  2. . (점) → _ (언더스코어)
  3. 대문자 → 소문자

적용 2 단계

  1. 논리명 생성: 명시적으로 컬럼, 테이블명을 직접 적지 않으면 ImplicitNamingStrategy 사용 spring.jpa.hibernate.naming.implicit-strategy : 테이블이나, 컬럼명을 명시하지 않을 때 논리명 적용,
  2. 물리명 적용:
    spring.jpa.hibernate.naming.physical-strategy : 모든 논리명에 적용됨, 실제 테이블에 적용 (usernameusernm 등으로 회사 룰로 바꿀 수 있음)

스프링 부트 기본 설정

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

0개의 댓글