도메인 분석 설계 / 애플리케이션 구현 준비 / 회원 도메인 개발

• 요구사항 분석
• 도메인 모델과 테이블 설계
• 엔티티 클래스 개발1
• 엔티티 클래스 개발2
• 엔티티 설계시 주의점

요구사항 분석

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

도메인 모델과 테이블 설계

• 회원, 주문, 상품의 관계: 회원은 여러 상품을 주문할 수 있다. 그리고 한 번 주문할 때 여러 상품을 선택할 수 있으므로 주문과 상품은 다대다 관계다. 하지만 이런 다대다 관계는 관계형 데이터베이스는 물론이고 엔티티에서도 거의 사용하지 않는다. 따라서 그림처럼 주문상품이라는 엔티티를 추가해서 다대다 관계를 일대다, 다대일 관계로 풀어냈다.
• 상품 분류: 상품은 도서, 음반, 영화로 구분되는데 상품이라는 공통 속성을 사용하므로 상속 구조로 표현했다.

 

회원 엔티티 분석

• 회원(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는 사용하지 말자. 여기서는 다대다 관계를 예제로 보여주기 위해 추가했을 뿐이다

 

양방향 관계에서는 연관관계의 주인을 정해야 하는데, 외래 키가 있는 주문을 연관관계의 주인으로 정하는 것이 좋다. → 쉽게 말해서 일대다 중 다 쪽에 연관관계의 주인을 두어라.

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

 

엔티티 클래스 개발

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

 

회원 엔티티

package jpabook.jpashop.domain;

import jakarta.persistence.*;
import lombok.Getter;
import lombok.Setter;

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에 있는 member필드에 의해서 mapped된거임 / 난 매핑된 거울일 뿐이야
    private List<Order> orders = new ArrayList<>(); //그래서 여기에 무언가 값을 넣는다고 해서 Fk값이 변경되지 않음
}					  	    //컬렉션은 필드에서 초기화

 

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

 

주문 엔티티

package jpabook.jpashop.domain;

import jakarta.persistence.*;
import lombok.Getter;

import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;

import static jakarta.persistence.FetchType.LAZY;

@Entity
@Table(name = "orders")
@Getter
public class Order {

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

    @ManyToOne(fetch = LAZY)
    @JoinColumn(name = "member_id")
    private Member member; //위의 회원 엔티티에서 말한 member필드가 이곳임
			   // 여기에서 값을 다시 세팅하게 되면 member_id(Fk)값이 다른 member로 변경이 된다.
    @OneToMany(mappedBy = "order", cascade = CascadeType.ALL)
    private List<OrderItem> orderItems = new ArrayList<>();

    @OneToOne(fetch = LAZY, cascade = CascadeType.ALL)
    @JoinColumn(name = "delivery_id")
    private Delivery delivery;

    private LocalDateTime orderDate; //주문시간

    @Enumerated(EnumType.STRING) //EnumType은 디폴트가 ORDINAL이다. 그렇지만 이건 숫자로 반환되기 때문에 중간에 새로운 값이 생기면 큰일난다. 즉 쓰지말자
    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);
    }
}

• Order와 Delivery는 일대일 관계다. JPA에서는 일대일 관계에서는 FK를 어디에 지정하든 상관없다. 그렇지만 access를 더 많이하는 곳에 지정하는 것이 더 좋다. Delivery를 직접 조회하는 일보단 Order를 조회하면서 Delivery를 조회하는 일이 더 많을 것이기에 Order에 FK를 지정한다. 그러므로 연관관계의 주인도 Order로 잡는다.
• cascade = CascadeType.All
  • 이것을 적지 않으면 예를들어 orderItem에 A, B, C를 persist해주고 Order에 이것들을 persist하려 밑의 코드와 같이 작성해주어야 한다. 즉 다 각각 해주어야 한다.

persist(orderItemA)
persist(orderItemB)
persist(orderItemC)
persist(order)

• 그렇지만 cascade를 해준다면 persist(order)만 작성해주면 된다. 즉 order만 persist해주면 된다.

연관관계 메서드

• 양방향 연관관계를 가지고 있는 것들은 양쪽에 값을 세팅해주기 위해 연관관계 메서드가 필요하다.
• 즉 양쪽 세팅하는 것을 하나의 코드로 세팅하는 것이다.
• 연관관계 메서드는 좀 더 control하는 쪽에 위치시켜주면 된다.

 

주문 상태

package jpabook.jpashop.domain;

public enum OrderStatus {
    ORDER, CANCEL
}

 

주문상품 엔티티

package jpabook.jpashop.domain;

import jakarta.persistence.*;
import jpabook.jpashop.domain.item.Item;
import lombok.Getter;
import lombok.Setter;

import static jakarta.persistence.FetchType.LAZY;

@Entity
@Getter @Setter
public class OrderItem {
    @Id @GeneratedValue
    @Column(name = "order_item_id")
    private Long id;

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

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

    private int orderPrice; //주문 가격
    private int cout; //주문 수량
}

 

상품 엔티티

package jpabook.jpashop.domain.item;

import jakarta.persistence.*;
import jpabook.jpashop.domain.Category;
import lombok.Getter;
import lombok.Setter;

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 prive;
    private int stockQuantity;

    @ManyToMany(mappedBy = "items")
    private List<Category> categories = new ArrayList<>();

}

• @Inheritance(strategy =  InheritanceType.SINGLE_TABLE) : Item과 Book, Album, Movie상속관계 매핑이기 때문에 상속관계 전략을 지정해야 하는데 이 전략은 부모클래스에서 지정한다(왜냐하면 우리는 싱글테이블 전략(하나의 테이블에 다 때려박는 전략)을 쓰기 때문).

 

상품 - 도서 엔티티

package jpabook.jpashop.domain.item;

import jakarta.persistence.DiscriminatorValue;
import jakarta.persistence.Entity;
import lombok.Getter;
import lombok.Setter;

@Entity
@DiscriminatorValue("B")
@Getter @Setter
public class Book extends Item {
    private String author;
    private String isbn;
}

 

상품 - 음반 엔티티

package jpabook.jpashop.domain.item;

import jakarta.persistence.DiscriminatorValue;
import jakarta.persistence.Entity;
import lombok.Getter;
import lombok.Setter;

@Entity
@DiscriminatorValue("A")
@Getter @Setter
public class Album extends Item {

    private String artist;
    private String etc;
}

 

상품 - 영화 엔티티

package jpabook.jpashop.domain.item;

import jakarta.persistence.DiscriminatorValue;
import jakarta.persistence.Entity;
import lombok.Getter;
import lombok.Setter;

@Entity
@DiscriminatorValue("M")
@Getter @Setter
public class Movie extends Item {

    private String director;
    private String actor;
}

 

배송 엔티티

package jpabook.jpashop.domain;

import jakarta.persistence.*;
import lombok.Getter;
import lombok.Setter;

@Entity
@Getter @Setter
public class Delivery {

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

    @OneToOne(mappedBy = "delivery")
    private Order order;

    @Embedded
    private Address address;

    @Enumerated(EnumType.STRING)
    private DeliveryStatus status; //READY, COMP
}

 

배송 상태

package jpabook.jpashop.domain;

public enum DeliveryStatus {
    READY, COMP
}

 

카테고리 엔티티 

package jpabook.jpashop.domain;

import jakarta.persistence.*;
import jpabook.jpashop.domain.item.Item;
import lombok.Getter;
import lombok.Setter;

import java.util.ArrayList;
import java.util.List;

import static jakarta.persistence.FetchType.LAZY;

@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"), //중간테이블에 있는 category_id
            inverseJoinColumns = @JoinColumn(name = "item_id")) //category_item에 item쪽으로 들어가는 item_id 매핑
    private List<Item> items = new ArrayList<>();

    @ManyToOne(fetch = 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);
    }

}

• JoinTable 정리
  • 조인테이블은 외래키를 사용 하는 연관 관계와는 다르게 조인테이블(CATEGORY_ITEM)이라는 별도의 테이블을 만들어서 각 테이블의 외래키를 가지고 연관관계를 관리한다.

옵션	설명
name	조인 테이블 명
joinColumns	현재 엔티티를 참조하는 외래키
inverseJoinColumns	반대방향 엔티티를 참조하는 외래

 

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

주소 값 타입

package jpabook.jpashop.domain;

import jakarta.persistence.Embeddable;
import lombok.Getter;

@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 구현 라이브러리가 객체를 생성할 때 리플랙션 같은 기술을 사용할 수 있도록 지원해야 하기 때문이다.

 

엔티티 설계시 주의점

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

• Setter가 모두 열려있다. 변경 포인트가 너무 많아서, 유지보수가 어렵다. 나중에 리펙토링으로 Setter 제거
• 리팩토링이란 : 결과의 변경 없이 코드의 구조를 재조정함을 뜻한다. 주로 가독성을 높이고 유지보수를 편하게 한다. 버그를 없애거나 새로운 기능을 추가하는 행위는 아니다. 사용자가 보는 외부 화면은 그대로 두면서 내부 논리나 구조를 바꾸고 개선하는 유지보수 행위이다.

 

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

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

 

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

• 컬렉션은 필드에서 바로 초기화 하는 것이 안전하다.
• null 문제에서 안전하다.
• 하이버네이트는 엔티티를 영속화 할 때, 컬랙션을 감싸서 하이버네이트가 제공하는 내장 컬렉션으로 변경한다. 만약 getOrders() 처럼 임의의 메서드에서 컬력션을 잘못 생성하면 하이버네이트 내부 메커니즘에 문제가 발생할 수 있다. 따라서 필드레벨에서 생성하는 것이 가장 안전하고, 코드도 간결하다.

Member member = new Member(); //멤버 객체 생성
System.out.println(member.getOrders().getClass()); //출력해보면ArrayList로 잘 나옴
em.persist(member); //영속하면(DB에 저장하면)
System.out.println(member.getOrders().getClass()); //출력해보면 hibernate가 컬렉션이 변경된걸
						   //추적해야되기 때문에 자신이 추적할 수 있게끔 바꾸어버림
//출력 결과
class java.util.ArrayList
class org.hibernate.collection.internal.PersistentBag

• 문제가 뭐냐면 hibernate가 기껏 PersistentBag으로 바꾸어놨는데 누군가 다시 set해서 컬렉션을 바꿔버리면 hibernate가 원하는 매커니즘으로 돌아가지 않는 것이다.
• 그래서 private List<Order> orders = new ArrayList<>(); 와 같은 컬렉션을 절대로 변경하지 마라
• 꺼내는 경우에는 수정만 안하면 괜찮다.

 

테이블, 컬럼명 생성 전략

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

 

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

1. 카멜 케이스 → 언더스코어(memberPoint member_point)

2. .(점) → _(언더스코어)

3. 대문자 → 소문자

예를 들어 orderDate → order_date로 바꾸어 실제 테이블 필드명에 적용시킨다.

 

 

애플리케이션 구현 준비

구현 요구사항

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

 

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

 

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

 

 

예제를 단순화 하기 위해 다음 기능은 구현X

• 로그인과 권한 관리X
• 파라미터 검증과 예외 처리X
• 상품은 도서만 사용
• 카테고리는 사용X
• 배송 정보는 사용X

 

애플리케이션 아키텍처

계층형 구조 사용

• controller, web: 웹 계층
• service: 비즈니스 로직, 트랜잭션 처리
• repository: JPA를 직접 사용하는 계층, 엔티티 매니저 사용
• domain: 엔티티가 모여 있는 계층, 모든 계층에서 사용

 

패키지 구조

• jpabook.jpashop
  • domain
  • exception
  • repository
  • service
  • web

* 개발 순서: 서비스, 리포지토리 계층을 개발하고, 테스트 케이스를 작성해서 검증, 마지막에 웹 계층 적용

 

회원 도메인 개발

구현 기능

• 회원 등록
• 회원 목록 조회 

 

순서

• 회원 리포지토리 개발
• 회원 서비스 개발
• 회원 기능 테스트

 

회원 리포지토리 

package jpabook.jpashop.repository;
import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import jpabook.jpashop.domain.Member;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import java.util.List;
@Repository
@RequiredArgsConstructor
public class MemberRepository {

    @PersistenceContext
    private EntityManager em;

    public void save(Member member) {
        em.persist(member); //JPA에 저장
    }
    public Member findOne(Long id) {
        return em.find(Member.class, id);
    }
    public List<Member> findAll() {
        return em.createQuery("select m from Member m", Member.class)
                .getResultList();
    }
    public List<Member> findByName(String name) {
        return em.createQuery("select m from Member m where m.name = :name",
                        Member.class)
                .setParameter("name", name) //파라미터 바인딩(메모리에 값을 할당)
                .getResultList();
    }
}

• @Repository : 스프링 빈으로 등록, JPA 예외를 스프링 기반 예외로 예외 변환
  • DB 관리(연결, 해제, 자원 관리)
  • DB에 CRUD의 명령을 실행하게 만드는 인터페이스
  • '저장소'라는 뜻을 가진 단어로 JPA에서 Repository 인터페이스를 생성 후, JpaRepository<Entity, 기본키 타입>을 상속받으면(extends하면) 기본적인 Create, Read, Update, Delete가 자동으로 생성됨
• @PersistenceContext : 엔티티 매니저(EntityManager)를 주입
  • EntityManager : JPA는 스레드가 하나 생성될 때마다 EntityManagerFactory에서 EntityManager를 생성한다.
  • EntityManager는 내부적으로 DB 커넥션 풀을 사용하여 DB와 연결된다.
• @PsersistenceUnit : 엔티티 매니저 팩토리(EntityManagerFactory) 주입
• save() : em.persist()는 영속성 컨텍스트를 통해서 엔티티를 영속화 한다.
• @RequiredArgsConstructor : 생성자주입의 단점은 위의 Constructor(생성자) 코드처럼 생성자를 만들기 번거롭다는 것이다. 하지만 이를 보완하기위해 롬복을 사용하여 간단한 방법으로 생성자 주입 방식의 코딩을 할 수 있다. @RequiredArgsConstructor은 final이 붙거나 @NotNull 이 붙은 필드의 생성자를 자동 생성해주는 롬복 어노테이션

* 생성자 주입 방식을 권장 변경 불가능한 안전한 객체 생성 가능 생성자가 하나면, @Autowired 를 생략할 수 있다. final 키워드를 추가하면 컴파일 시점에 memberRepository 를 설정하지 않는 오류를 체크할 수 있다. (보통 기본 생성자를 추가할 때 발견)

 

회원 서비스

package jpabook.jpashop.service;
import jpabook.jpashop.domain.Member;
import jpabook.jpashop.repository.MemberRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.util.List;
@Service
@Transactional(readOnly = true)
@RequiredArgsConstructor
public class MemberService {

    private final MemberRepository memberRepository;
    /**
     * 회원가입
     */
    @Transactional //변경
    public Long join(Member member) {
        validateDuplicateMember(member); //중복 회원 검증
        memberRepository.save(member);
        return member.getId();
    }
    private void validateDuplicateMember(Member member) {
        List<Member> findMembers =
                memberRepository.findByName(member.getName());
        if (!findMembers.isEmpty()) {
            throw new IllegalStateException("이미 존재하는 회원입니다.");
        }
    }
    /**
     * 전체 회원 조회
     */
    public List<Member> findMembers() {
        return memberRepository.findAll();
    }
    public Member findOne(Long memberId) {
        return memberRepository.findOne(memberId);
    }
}

@Service : 컨트롤러와 리포지토리 사이의 미들웨어

• Controller에서 전달받은 사용자의 요청사항에 알맞게 데이터를 가공해서 데이터베이스로 전달하거나, 데이터베이스에서 데이터를 전달받아 가공하여 유저에게 전달하는 역할

@Transactional : 데이터베이스를 다룰 때 트랜잭션을 적용하면 데이터 추가, 갱신, 삭제 등으로 이루어진 작업을 처리하던 중 오류가 발생했을 때 모든 작업들을 원상태로 되돌릴 수 있다. 

• 트랜잭션, 영속성 컨텍스트
• readOnly=true : 데이터의 변경이 없는 읽기 전용 메서드에 사용, 영속성 컨텍스트를 플러시 하지 않으므로 약간의 성능 향상(읽기 전용에는 다 적용)
• 데이터베이스 드라이버가 지원하면 DB에서 성능 향상
• @Autowired 생성자 Injection 많이 사용, 생성자가 하나면 생략 가능

 

참고: 실무에서는 검증 로직이 있어도 멀티 쓰레드 상황을 고려해서 회원 테이블의 회원명 컬럼에 유니크 제약 조건을 추가하는 것이 안전하다.

 

회원 기능 테스트

테스트 요구사항

• 회원가입을 성공해야 한다.
• 회원가입 할 때 같은 이름이 있으면 예외가 발생해야 한다.

 

회원가입 테스트

package jpabook.jpashop.service;

import jakarta.persistence.EntityManager;
import jpabook.jpashop.domain.Member;
import jpabook.jpashop.repository.MemberRepository;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.transaction.annotation.Transactional;

import static org.junit.Assert.*;

@RunWith(SpringRunner.class) //junit실행할 때 스프링과 같이 실행할래
@SpringBootTest //스프링부트를 띄운 상태로 테스트할거임. 이게 없으면 @Autowired 다 실패
@Transactional //테스트 끝나고 다 롤백시킴(테스트 케이스에서만)
public class MemberServiceTest {

    @Autowired
    MemberService memberService;
    @Autowired
    MemberRepository memberRepository;
    @Autowired
    EntityManager em;

    @Test
    public void 회원가입() throws Exception {
        //given 이렇게 주어졌을 때
        Member member = new Member();
        member.setName("kim");

        //when 이걸 실행하면
        Long saveId = memberService.join(member);

        //then 이게 나와야 해
        assertEquals(member, memberRepository.findOne(saveId));
    }

    @Test(expected = IllegalStateException.class) //이게 없으면 try-catch문 작성해야 함
    public void 중복_회원_예외() throws Exception {
        //given
        Member member1 = new Member();
        member1.setName("kim");

        Member member2 = new Member();
        member2.setName("kim");

        //when
        memberService.join(member1);
        memberService.join(member2); //예외가 발생해야 한다!!!

        //then
        fail("예외가 발생해야 한다."); //이게 출력되면 오류다. 테스트 케이스를 잘못 작성한 것
    }
}

• @RunWith(SpringRunner.class) : 스프링과 테스트 통합
• @SpringBootTest : 스프링 부트 띄우고 테스트(이게 없으면 @Autowired 다 실패)
• @Transactional : 반복 가능한 테스트 지원, 각각의 테스트를 실행할 때마다 트랜잭션을 시작하고 테스트가 끝나면 트랜잭션을 강제로 롤백 (이 어노테이션이 테스트 케이스에서 사용될 때만 롤백), 테스트는 재사용 해야 하기 때문에 롤백을 시켜준다.
• 실행시켜보면 insert 쿼리가 안보인다. 이유는 실제로 DB에 커밋됐을때만 insert 쿼리가 보이기 때문이다. 위의 코드는 @Transactional 이 롤백을 해주기 때문에 커밋이 안된다. 그래서 insert 쿼리를 실제로 눈으로 한 번 확인해보고 싶다 하면 @Test 밑에 @Rollback(false)를 작성해주고 실행하면 insert 쿼리 보이는 걸 확인할 수 있다.

 

테스트 케이스를 위한 설정

• 테스트는 케이스 격리된 환경에서 실행하고, 끝나면 데이터를 초기화하는 것이 좋다. 그런 면에서 메모리 DB를 사용하는 것이 가장 이상적이다. 추가로 테스트 케이스를 위한 스프링 환경과, 일반적으로 애플리케이션을 실행하는 환경은 보통 다르므로 설정 파일을 다르게 사용하자. 다음과 같이 간단하게 테스트용 설정 파일을 추가하면 된다.
• 그니까 쉽게 말해서 테스트케이스를 위한 스프링 환경과, 일반적으로 애플리케이션을 실행하는 환경을 분리 시키고 싶다는 것이다. 그리고 테스트를 돌리는데 DB연결 시키는것도 귀찮다. 그래서 따로 설정을 해두면 DB연결을 안시켜도(H2를 꺼도) 잘 실행된다.

 

test/resources/application.yml

spring:
  datasource:
    url: jdbc:h2:mem:test
    username: sa
    password:
    driver-class-name: org.h2.Driver

  jpa:
    hibernate:
      ddl-auto: create-drop
    properties:
      hibernate:
        #show_sql: true
        format_sql: true

logging.level:
    org.hibernate.SQL: debug
    org.hibernate.type: trace

* logging.level: 만 켜져있어도 가능하다.

logging.level:
 org.hibernate.SQL: debug

• 이제 테스트에서 스프링을 실행하면 이 위치에 있는 설정 파일을 읽는다. (만약 이 위치에 없으면 src/resources/application.yml 을 읽는다.)
• 스프링 부트는 datasource 설정이 없으면, 기본적을 메모리 DB를 사용하고, driver-class도 현재 등록된 라이브러를 보고 찾아준다. 추가로 ddl-auto 도 create-drop 모드로 동작한다. 따라서 데이터소스나, JPA 관련된 별도의 추가 설정을 하지 않아도 된다.

 

출처 : 인프런 - 실전! 스프링 부트와 JPA 활용1 - 웹 애플리케이션 개발(김영한 강사님)