도메인 분석 설계 및 애플리케이션 구현 준비

woom·2023년 4월 26일
Spring boot

Spring Boot

목록 보기
2/6
post-thumbnail

김영한 강사님 [실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발] 강의 참조

🌼 도메인 분석

📕 요구사항 분석

  • 기능 목록

    • 회원 기능 : 회원 등록, 회원 조회

    • 상품 기능 : 상품 등록, 상품 수정, 상품 조회

    • 주문 기능 : 상품 주문, 주문 내역 조회, 주문 취소

    • 기타 요구사항

      • 상품은 재고 관리가 필요하다.
      • 상품의 종류는 도서, 음반, 영화가 있다.
      • 상품을 카테고리로 구분할 수 있다.
      • 상품 주문시 배송 정보를 입력할 수 있다

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

  • 회원은 여러 상품을 주문, 한 번 주문할 때 여러 상품을 선택 가능하므로 주문과 상품은 다대다 관계.

    • 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용X. 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어서 사용

  • 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속 구조로 표현

🐣 회원 엔티티 분석

  • 기본적으로 id를 pk로 갖음

  • Member: 이름, 임베디드 타입인 주소(Address), 주문(orders) 리스트

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

  • OrderItem : 주문한 상품 정보와 orderPrice, 주문 수량(count). (보통 OrderLine, LineItem 으로 많이 표현한다.)

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

  • 배송(Delivery): 주문시 하나의 배송 정보를 생성. 주문과 배송은 일대일 관계.

  • Category : 상품과 다대다 관계. parent, child 로 부모, 자식 카테고리를 연결.

  • 주소(Address): 값 타입(임베디드 타입)이다. 회원과 배송(Delivery)에서 사용.

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

🐣 회원 테이블 분석

  • MEMBER: 회원 엔티티의 Address 임베디드 타입 정보가 회원 테이블에 그대로 들어감. DELIVERY 테이블도 동일.

  • ITEM: 앨범, 도서, 영화 타입을 통합해서 하나의 테이블로 만들었다. DTYPE 컬럼으로 타입을 구분한다.

🐣 연관관계 매핑 분석

  • 회원과 주문: 일대다 , 다대일의 양방향 관계다. 외래 키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. 그러므로 Order.member 를 ORDERS.MEMBER_ID 외래키와 매핑한다.

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

  • 주문상품과 상품: 다대일 단방향 관계다. OrderItem.item 을 ORDER_ITEM.ITEM_ID 외래 키와 매핑한다.

  • 주문과 배송: 일대일 양방향 관계다. Order.delivery 를 ORDERS.DELIVERY_ID 외래 키와 매핑한다.

  • 카테고리와 상품: @ManyToMany 를 사용해서 매핑한다.(실무에서 @ManyToMany는 사용X. 다대다 관계 예시를 위한 것)

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

⭐ JPA 어노테이션 ⭐

  • @Entity : 객체와 테이블 매핑

  • @Id : 데이터베이스 테이블의 기본 키(PK)와 객체의 필드를 매핑시켜주는 어노테이션. 이것만 사용했을경우 기본키를 직접 할당해 줘야함

  • @GeneratedValue : 기본 키를 자동 생성해주는 어노테이션

    • @GeneratedValue의 strategy의 기본값은 AUTO. AUTO를 사용할 때 SEQUENCE나 TABLE 전략이 선택되면, 시퀀스나 키 생성용 테이블을 미리 만들어 두어야 합니다.
    • ★만약 스키마 자동 생성 기능(ddl-auto)을 사용한다면, 하이버네이트가 기본값을 사용해서 적절하게 만들어줌.★

  • @Column(name = "member_id") : 컬럼의 이름 지정(필드와 컬럼 매핑)

  • 임베디드 타입 : 새로운 값 타입을 직접 정의해서 사용

    • @Embeddable : 값 타입을 정의하는 곳에 표시
    • @Embedded : 값 타입을 사용하는 곳에 표시

  • @Table : 엔티티와 매핑할 테이블을 지정

    • Name속성 : 매핑할 테이블 이름 (default. 엔티티 이름 사용)

  • 관계 매핑(실행중인 필드를 기준으로 작성)

    • @ManyToOne : 다대일 관계
    • @OneToMany : 일대다 관계
    • @OneToOne : 일대일 관계
    • @ManyToMany : 다대다 관계

  • @JoinColumn(name = "member_id") : 외래 키를 매핑

    • name 속성에는 매핑할 외래 키 컬럼명(이름)을 지정

  • @OneToMany(mappedBy = "member") : order table에 있는 member필드에 의해서 매핑된거야라는 의미(order table의 member필드에서 @joincolumn사용)

    • 매핑되는 것의 거울로 읽기전용
    • 즉, 쉽게 말해서 멤버테이블에서 수정을 해도 주문테이블에는 영향 없으나 주문 테이블에서 수정하면 member_id변경됨

  • @JoinTable(name="") : 객체는 컬렉션이 있어서 다대다 관계가 가능하지만 관계형 DB는 컬렉션 관계를 양쪽에 가질 수 없기 때문에 일대다 다대일로 풀어내는 중간테이블이 필요

    • 필드 추가가 불가능하기 때문에 실무에서 사용하지 않음
    • joinColums는 다대다관계에서 주인과 연결된 이름, inverseJoincolums는 다대다관계에서 매핑된 필드
    • @JoinTable(name = "category_item",
         joinColumns = @JoinColumn(name = "category_id"),
         inverseJoinColumns = @JoinColumn(name = "item_id"))
  • @Enumerated(EnumType.속성) : 엔티티 매핑에서 ENUM타입 사용
    • EnumType.STRING 속성 : ENUM 이름값을 저장 (권장)
    • EnumType.ORDINAL 속성 : ENUM 순서값을 저장 (중간에 다른 상태가 생길경우 섞이므로 권장하지 않음)

📌 상속관계 매핑

  • 상속관계 전략 지정(부모클래스) : @Inheritance(strategy = InheritanceType.SINGLE_TABLE)

  • InheritanceType

    • JOINED: 정규화된 스타일
    • SINGLE_TABLE: 한테이블에 다 넣는 전략
    • TABLE_PER_CLASS: 상속받는 하위 클래스만 나오는 전략

  • @DiscriminatorColumn(name="DTYPE") : 하위 클래스를 구분하는 용도의 컬럼(부모 클래스에서 선언) 관례는 default = DTYPE

  • @DiscriminatorValue("XXX") : 엔티티를 저장할 때 슈퍼타입의 구분 컬럼에 저장할 값을 지정(하위클래스에서 선언) 기본값: 클래스이름

📌 셀프로 양방향 연관관계

  • 같은 엔티티에 대해서 셀프로 양방향 연관관계를 갖는 방법
    @ManyToOne
    @JoinColumn(name = "parent_id")
    private Category parent; //내 부모니까 나랑 같은 타입

    @OneToMany(mappedBy = "parent")
    private List<Category> child = new ArrayList<>(); //자식은 카테고리 여러개 가질수 있어

📒 엔티티 클래스 개발

  • Item Class
    • 구현체를 가지고 할 것이기 때문에 추상클래스로 작성
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<>();
}
  • orderitem class
package jpabook.jpashop.domain;

import jpabook.jpashop.domain.item.Item;
import lombok.Getter;
import lombok.Setter;

import javax.persistence.*;

@Entity
@Getter @Setter
public class OrderItem {

    @Id @GeneratedValue
    @Column(name = "order_item_id")
    private Long id;

    @ManyToOne
    @JoinColumn(name = "item_id")
    private Item item;

    @ManyToOne
    @JoinColumn(name = "order_id")
    private Order order;

    private int orderPrice; //주문 가격
    private int count; //주문 수량
}
  • item category list중 하나인 book클래스 (item 클래스 상속)
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;

}
  • Category 클래스
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
    @JoinColumn(name = "parent_id")
    private Category parent; //내 부모니까 나랑 같은 타입

    @OneToMany(mappedBy = "parent")
    private List<Category> child = new ArrayList<>(); //자식은 카테고리 여러개 가질수 있어
}

📗 엔티티 클래스 검증

  1. h2.bat실행(h2 DB)

  2. JpashopApplicationt실행

  3. intelliJ 콘솔에서 확인가능

  4. H2 콘솔에서 확인가능

📌 참고 - 값타입 클래스

  • 값 타입은 변경 불가능하게 설계 : @Setter 를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스 생성(JPA 스펙상 엔티티나 임베디드 타입(@Embeddable)은 자바 기본 생성자를 public 또는 protected 로 설정해야함. public보다는 protected 로 설정하는 것 권장)
package jpabook.jpashop.domain;

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() {
    }//기본생성자(JPA spec상 추가)

    public Address(String city, String street, String zipcode) {
        this.city = city;
        this.street = street;
        this.zipcode = zipcode;
    }
}

📘 엔티티 설계시 주의점

💡 실무에서 모든 연관관계는 지연로딩(LAZY)으로 설정할 것

  • 즉시로딩(EAGER)은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다.
    • 즉시로딩 : member테이블 조회시 연관된 order테이블까지 한번에 조회하는 것
      (하나 로딩하는 시점에 다같이 로딩하겠다)
  • 연관된 엔티티를 함께 DB에서 조회해야 하면, fetch join(문맥에서 필요한 것들 가져올수있음) 또는 엔티티 그래프 기능을 사용한다.
  • @XToOne(OneToOne, ManyToOne) 관계는 기본이 즉시로딩이므로 직접 지연로딩으로 설정해야한다

  • @ManyToOne(fetch = FetchType.LAZY)로 변경필요!!!

💡 컬렉션은 필드에서 초기화 할 것

  • 컬렉션은 필드에서 바로 초기화 하는 것이 (null 문제에서) 안전하고 간결하다.
  • 초기화 후에는 수정하지 말아야 한다.
  • ex. private List\<Order> orders = new ArrayList<>();

💡 테이블, 컬럼명 생성 전략

  • 스프링 부트에서 하이버네이트 기본 매핑 전략을 변경해서 실제 테이블 필드명은 다름
  • 하이버네이트 기존에는 엔티티의 필드명을 그대로 테이블의 컬럼명으로 사용
    ( SpringPhysicalNamingStrategy )
  • 스프링 부트 신규 설정 (엔티티(필드) 테이블(컬럼))
  1. 카멜 케이스 언더스코어(memberPoint member_point)
  2. .(점) _(언더스코어)
  3. 대문자 소문자

💡 cascade 옵션

@OneToMany(mappedBy = "order", cascade = CascadeType.ALL)
  private List<OrderItem> orderItems = new ArrayList<>();
  • CascadeType가 persist를 전파
  • orderItems에 데이터만 넣어두고 order를 저장하면 orderItems도 같이 저장
    • persist(orderItemA)					
 persist(orderItemB)        =>     persist(order)
 persist(orderItemA)
 persist(order)

💡 연관관계 메소드

  • 양방향 연관관계 세팅 시 DB저장에는 연관관계 주인만 있으면 되지만 로직을 처리하려면 양쪽 다 필요
  • 기존 원래대로 order table에서 member저장하려면 이렇게 했지만
    public static void main(String[] args) {
        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);
    }
  • 연관관계메소드는 control하는 쪽에서 작성 (order, category)

🌼 애플리케이션 구현 준비

📕 애플리케이션 아키텍처

  • 계층형 구조 사용
    • controller, web: 웹 계층
    • service: 비즈니스 로직, 트랜잭션 처리
    • repository: JPA를 직접 사용하는 계층, 엔티티 매니저 사용
    • domain: 엔티티가 모여 있는 계층, 모든 계층에서 사용
  • 패키지 구조
    • jpabook.jpashop
    • domain
    • exception
    • repository
    • service
    • web
  • 개발 순서: 서비스, 리포지토리 계층을 개발하고, 테스트 케이스를 작성해서 검증, 마지막에 웹 계층 적용
profile
woom
Study Log 📂
이전 포스트

Spring Boot 프로젝트 환경설정

다음 포스트

회원 도메인 개발

0개의 댓글