springboot
[springboot] 실전! 스프링 부트와 JPA 활용 - 1. Entity 구현
힝뿌
2023. 11. 12. 20:00
반응형
springboot를 이용해 소수의 프로젝트를 진행해 보면서 제대로 알고 하는 느낌이 들지 않아 복습을 하는 시간이 필요하다고 매번 느꼈다.
복습하면서 모르는 부분들을 알아가 볼 겸 김영한 강사님의 강의 자료를 보며 공부를 해보기로 마음먹었다! 아는 부분의 대한 내용의 기록은 스킵한다.
강의 이름은 "실전! 스프링 부트와 JPA 활용 1 - 웹 애플리케이션 개발", "실전! 스프링 부트와 JPA 활용 2 - API 개발과 성능 최적화"이다.
개발 환경 셋팅을 마치고, 도메인 분석 설계부터 시작한다.
도메인 분석 설계
요구사항 분석
기능 목록
- 회원 기능
- 회원 등록
- 회원 조회
- 상품 기능
- 상품 등록
- 상품 수정
- 상품 조회
- 주문 기능
- 상품 주문
- 주문 내역 조회
- 주문 취소
- 기타 요구사항
- 상품은 재고 관리가 필요하다.
- 상품의 종류는 도서, 음반, 영화가 있다.
- 상품을 카테고리로 구분할 수 있다.
- 상품 주문 시 배송 정보를 입력할 수 있다.
테이블 설계
회원, 주문, 상품의 관계 : 회원은 여러 상품을 주문할 수 있다. 그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다. 하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용하지 않는다. 따라서 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어냈다.
상품 분류 : 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속 구조로 표현했다.
참고사항
외래 키가 있는 곳을 연관관계의 주인으로 정해라.
연관관계의 주인은 단순히 누가 외래 키를 관리하냐의 문제이지 비즈니스상 우위에 있다고 주인으로 정하면 안 된다. 즉, 외래 기가 있는 엔티티를 연관관계의 주인으로 정하는 것이 좋다.
엔티티 클래스 개발
예제에서는 설명을 쉽게 하기 위해 엔티티 클래스에 Getter, Setter를 모두 열고 최대한 단순하게 설계를 했음.
실무에서는 가급적 Getter는 열어두고, Setter는 꼭 필요한 경우에만 사용하는 것을 추천한다.
참고사항
이론적으로, Getter, Setter 모두 제공하지 않고, 꼭 필요한 별도의 메서드를 제공하는 것이 가장 이상적이다. 하지만 실무에서는 엔티티의 데이터는 조회할 일이 너무 많으므로, Getter의 경우 모두 열어두는 것이 편리하다. Getter는 아무리 호출해도 호출하는 것 만으로 어떤 일이 발생하지 않는다.
하지만 Setter는 문제가 다르다. Setter는 호출하면 데이터가 변한다. Setter를 막 열어두면 가까운 미래에 엔티티가 도대체 왜 변경되는지 추적하지 힘들어진다. 그래서 엔티티를 변경할 때는 Setter 대신에 변경 지점이 명확하도록 변경을 위한 비즈니스 메서드를 별도로 제공해야 한다.
회원 엔티티
@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"를 많이 사용한다.
- @Embedded
- JPA에서 엔티티에 다른 엔터티를 포함할 때 사용된다. 이 어노테이션을 사용하면 해당 필드의 값은 임베디드 된 엔터티의 속성으로 매핑되어 저장되거나 조회된다. 즉, 해당 필드가 임베디드된 엔터티의 속성으로 매핑되어야 함을 JPA에게 알리는 것이다.
- mappedBy
- 해당 부분은 양방향 관계를 설정하는 데 사용한다.
- mappedBy = "member"는 Order 엔티티에 있는 member 필드를 나타낸다. 이것은 Order 엔티티의 member 필드에 의해 매핑된다는 것을 의미한다.
- 양방향 관계에서 "Member" 엔티티가 주인이 아닌 측임을 나타낸다. 즉, mappedBy 속성은 주인이 아닌 엔티티의 필드를 지정하며, 이는 해당 필드에 의해 관계가 매핑된다는 것을 나타낸다.
주문 엔티티
@Entity
@Table(name = "orders")
@Getter
@Setter
public class Order {
@Id
@GeneratedValue
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);
}
}- cascade = CascadeType.ALL
- 모든 상태 변경을 전파하는 것을 의미한다. 즉, 부모 엔티티의 상태가 변경되면 연관된 자식 엔티티들도 해당 변경을 따라가게 된다.
- PERSIST, MERGE, REMOVE, REFRESH, DETACH 상태 변경 존재
- PERSIST : 영속성 컨텍스트에 새로운 엔티티가 추가될 때, 해당 변경이 연고나 된 엔티티에도 전파된다. 따라서 부모 엔티티를 저장하면 연관된 자식 엔티티도 함께 저장된다.
- MERGE : 영속성 컨텍스트에서 분리된 엔티티가 다시 병합될 때, 해당 변경이 연관된 엔티티에도 전파된다. 부모 엔티티를 병합하면 연관된 자식 엔티티도 함께 병합된다.
- REMOVE : 엔티티가 삭제될 때, 해당 변경이 연관된 엔티티에도 전파된다. 부모 엔티티를 삭제하면 연관된 자식 엔티티도 함께 삭제된다.
- REFRESH : 엔티티가 리프레시될 때, 해당 변경에 연관된 엔티티에도 전파된다.
- DETACH : 엔티티가 분리될 때, 해당 변경이 연관된 엔티티에도 전파된다.
- 주의해야 할 점은, Cascade를 사용할 때, 부모 엔티티의 상태 변경이 모든 연관된 자식 엔티티에 영향을 미칠 수 있기 때문에, 의도하지 않은 부작용이 발생할 수 있으니 신중하게 사용해야 한다.
- fetch = FetchType.LAZY
- 엔티티 간의 연관관계에서 지연 로딩(Lazy loading)을 나타내는 옵션이다. 이 옵션을 사용하면, 연관된 엔티티의 데이터를 실제로 사용할 때까지 로딩을 지연시킨다. 즉, 연관된 엔티티를 필요로 할 때 비로소 데이터베이스에 해당 엔티티를 로딩하게 된다.
- FetchType.LAZY를 사용하는 이유는 성능과 효율성에 있는데, 만약 모든 연관된 엔티티를 즉시 로딩(EAGER)하는 경우에는 성능 문제가 발생할 수 있다. 특히, 한 번에 많은 양의 데이터를 가져와야 하는 상황에서는 지연 로딩을 사용하여 필요한 시점에만 데이터를 가져오는 것이 효율적이다.
- 예를 들어, 주문 엔티티를 조회할 때, 해당 주문에 속한 회원 정보가 필요한 경우에만 회원 정보를 로딩하게 된다.
- 지연 로등인 기본적으로 효율적인 데이터베이스 액세스를 가능케 하지만, 사용 시 주의가 필요하다. 지연 로딩을 사용할 때는 영속성 컨텍스트가 살아있는 동안에 데이터베이스 연결이 필요하므로, 트랜잭션 범위 내에서 사용되어야 한다. 또한, 지연 로딩을 사용하는 경우 N+1 쿼리 문제에 유의해야 한다. (해당 부분은 학습이 더 필요할 것 같다.)
주문 상태
public enum OrderStatus {
ORDER, CANCEL
}주문 상품 엔티티
@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; // 주문 수티
}
상품 엔티티
@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<>();
}- @Inheritance(strategy = InheritanceType.SINGLE_TABLE)
- 상속 관계 매핑 전략을 설정
- 속성 전략에는 단일 테이블(SINGLE_TABLE)과 조인 테이블(JOIN_TABL)이 있다.
- 단일 테이블(single table) 전략이란?
- 상위 클래스와 하위 클래스의 모든 속성을 하나의 테이블에 저장하며, 구분 컬럼(discriminator column)을 사용하여 어떤 하위 클래스의 레코드인지 식별한다.
- 조인 테이블(join table) 전략이란?
- 각 엔티티가 별도의 테이블에 저장되며, 하위 클래스들의 테이블은 모두 부모 클래스의 기본 키를 외래 키로 사용하여 조인 테이블에 매핑된다.
- 단일 테이블(single table) 전략이란?
- @DiscriminatorColumn(name = "dtype")
- 단일 테이블 전략에서 사용되며, 구분 컬럼을 지정한다.
- name 속성은 구분 컬럼의 이름을 나타내는데, 여기서는 dtype으로 사용했다.
- 구분 컬럼은 상위 테이블에 각 하위 클래스의 타입을 식별하기 위한 컬럼이다.
- 예를 들어, dtype 컬럼의 값이 Book이면 해당 레코드는 Book 클래스에 속한다는 것을 나타낸다.
상품 - 도서 엔티티
@Entity
@DiscriminatorValue("B")
@Getter
@Setter
public class Book extends Item {
private String author;
private String isbn;
}- @DiscriminatorValue("B")
- 상속 관계 매핑을 사용할 때, 엔티티를 식별하는 값을 지정하는 데 사용된다. 특히, 단일 테이블 전략이나 조인 테이블 전략을 사용할 때 하위 클래스를 식별하는 값을 지정한다.
- 즉, "B"는 Book 엔티티를 식별한다. Item 테이블의 구분 컬럼 값이 "B"인 레코드를 조회하면, JPA는 이 레코드가 Book 엔티티에 해당한다는 것을 알고, 이를 통해 Book 클래스의 인스턴스를 생성하고 해당 레코드의 데이터를 매핑한다.
상품 - 음반 엔티티
@Entity
@DiscriminatorValue("A")
@Getter
@Setter
public class Album extends Item {
private String artist;
private String etc;
}상품 - 영화 엔티티
@Entity
@DiscriminatorValue("M")
@Getter
@Setter
public class Movie extends Item {
private String director;
private String actor;
}
배송 엔티티
@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(배송)]
}
배송 상태
public enum DeliveryStatus {
READY, COMP
}카테고리 엔티티
@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);
}
}
- joinColumns = @JoinColumn(name = "category_id")
- joinColumns : 현재 엔티티의 조인 컬럼을 지정한다. 즉, 현재 엔티티에 대한 외래 키를 나타낸다.
- 현재 엔티티인 Category의 조인 컬럼으로, category_id가 외래 키로 사용된다.
- inverseJoinColumns = @JoinColumns(name = "item_id")
- inverseJoinColumns : 연관 엔티티의 조인 컬럼을 지정한다. 이는 연관 엔티티에 대한 외래 키를 나타낸다.
- 연관 엔티티인 Item의 조인 컬럼으로, item_id가 외래 키로 사용된다.
▶️ category_item이라는 조인 테이블을 생성하며, 이 테이블에는 category_id와 item_id라는 두 개의 컬럼이 각각 Category와 Item의 외래 키로 사용된다. 이를 통해 Category와 Item은 다대다 관계를 맞을 수 있다.
참고) 실무에서는 @ManyToMany를 사용하지 말자!
@ManyToMany는 편리한 것 같지만, 중간 테이블( CATEGORY_ITEM)에 컬럼을 추가할 수 없고, 세밀하게 쿼리를 실행하기 어렵기 때문에 실무에서 사용하기에는 한계가 있다. 중간 엔티티(CategoryItem)를 만들고 @ManyToOne, @OneToMany로 매핑해서 사용하자.
정리하면, 다다대 매핑을 일대다, 다대일 매핑으로 풀어내서 사용하자!
주소 값 타입
@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;
}
}
- @Embeddable
- 해당 어노테이션이 붙은 클래스는 다른 엔티티에 내장될 수 있음을 나타낸다. 즉, 해당 클래스의 필드들은 다른 엔티티의 일부로서 투영되어 사용할 수 있다.
- Embeddable은 아래와 같은 장점이 존재한다.
- 코드의 재사용성 : 클래스를 정의하고 나면, 이를 다양한 엔티티에서 재사용할 수 있다. 여러 엔티티가 동일한 주소 정보를 가질 경우 코드 중복을 피할 수 있다.
- 가독성 및 유지보수성 향상 : 주소 관련 필드들이 Address 클래스에 포함되어 있기 때문에, 각 엔티티에 중복되는 주소 필드를 갖는 대신, Address를 필드로 사용함으로써 가독성과 유지보수성이 향상된다.
- 데이터베이스 스키마 개선 : 주소 정보를 하나의 테이블로 통합하여 데이터베이스 스키마를 간소화할 수 있다. Embeddable 클래스의 필드들은 자동으로 포함하는 엔티티의 테이블에 투영된다.
참고) 값 타입은 변경 불가능하게 설계해야 한다.
@Setter를 제거하고, 생성자에서 값을 모두 초기화해서 변경 불가능한 클래스로 구성하자. JPA 스펙상 엔티티나 임베디드 타입(@Embeddable)은 자바 기본 생성자를 public 또는 protected로 설정해야 한다. public으로 두는 것보다는 protected로 설정하는 것이 그나마 더 안전하다.
JPA가 이런 제약을 두는 이유는 JPA 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.
엔티티 설계 시 주의점
엔티티에는 가급적 Setter를 사용하지 말자.
위에서 언급했듯이 Setter가 모두 열려있으면 변경 포인트가 너무 많아서 유지보수가 어렵다. 모두 열려있다면 Setter를 제거하자.
모든 연관관계는 지연로딩으로 설정!
- 즉시로딩(EAGER)은 예측이 어렵고, 어떤 SQL이 실행될지 추적하기 어렵다. 특히 JPQL을 실행할 때 N+1 문제가 자주 발생한다.
- 실무에서 모든 연관관계는 지연로딩(LAZY)으로 설정해야 한다.
- 연관된 엔티티를 함께 DB에서 조회해야 한다면, fetch join 또는 엔티티 그래프 기능을 사용한다.
- @OneToOne, @ManyToOne 관계는 기본이 즉시로딩(EAGER)이므로 직접 지연로딩(LAZY)으로 설정해야 한다.
컬렉션은 필드에서 초기화하자.
컬렉션은 필드에서 바로 초기화하는 것이 안전하다.
- null문제에서 안전하다.
- 하이버네이트는 엔티티를 영속화할 때, 컬랙션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다. 만약 임의의 메서드에서 컬렉션을 잘못 생성하면 하이버네이트 내부 메커니즘에 문제가 발생할 수 있다. 따라서 필드레벨에서 생성하는 것이 가장 안전하고, 코드도 간결하다.
프로젝트를 하면서 실무에서는 어떻게 사용할지에 대해 정말 궁금한 부분들이 많았는데 전부는 아니지만 조금은 알아갈 수 있었다.
Entity 설계 및 개발을 완료했으니 다음번엔 repository에 대해 공부를 해보고 기록을 해야겠다.
반응형