프록시

얼마전에 AOP 관련된 글들을 살펴보다가 프록시를 알게되어서 스프링 AOP에서 프록시가 어떻게 동작하는지에 대해서도 간단히 살펴보았습니다. 하지만 역시 이 프록시라는 녀석은 JPA에서 지연로딩을 할때도 사용하는 아주... 용도가 다양한 녀석이였습니다. 그래서 지연로딩을 공부하면서 다시한번 프록시에 대해서 리뷰해보겠습니다.

JPA에서 프록시는 연관된 객체들을 데이터베이스에서 조회하기 위해서 사용합니다.
프록시를 사용하면 연관된 객체들을 처음부터 데이터베이스에서 조회하는 것이 아니라 실제 사용하는 시점에 데이터베이스에서 조회할 수 있습니다.
하지만 자주 함께 사용되는 객체들은 조인을 사용해서 함께 조회하는 것이 더 효과적입니다. JPA는 즉시로딩과 지연로딩이라는 방법으로 둘을 모두 지원하고 있습니다.

    @Test
    @Transactional
    @Rollback(false)
    public void printUser() throws Exception {

        Team team = new Team();
        team.setId("team1");
        team.setName("팀1");

        teamRepository.save(team);

        Member member = new Member();
        member.setId("member1");
        member.setName("임준영");
        member.setAge(28);

        member.setTeam(team);
        memberRepository.save(member);

     }


     @Test
     @Transactional
     public void printUserAndTeam() throws Exception {

         Member member = memberRepository.findById("member1").get();
         Team team = member.getTeam();

         System.out.println("소속 팀: " + team.getName());
         System.out.println("회원이름: " + member.getName());
      }

즉시로딩(fetch = FetchType.EAGER)

스크린샷 2019-11-21 오전 2 52 39

위의 코드에서 printUserAndTeam() 메소드는 member1 로 회원 엔티티를 찾아서 회원은 물론이고 회원과 연관된 팀의 이름도 출력합니다.

만약 아래와 같은 코드에서 소속팀을 출력하지 않는다고 했을때 회원과 연관된 팀 엔티티까지 데이터베이스에서 함께 조화하는 것은 효율적이지 않아 보입니다.

   @Test
     @Transactional
     public void printUserAndTeam() throws Exception {

         Member member = memberRepository.findById("member1").get();
         System.out.println("회원이름: " + member.getName());
      }

JPA는 이런 문제를 해결하려고 엔티티가 실제 사용될 때까지 데이터베이스 조회를 지연하는 방법을 제공하는데 이것을 지연 로딩이라고 합니다. team.getName()처럼 팀 엔티티의 값을 실제 사용하는 시점에 데이터베이스에서 팀 엔티티에 필요한 데이터를 조회하는 것입니다.

프록시 기초

엔티티를 실제 사용하는 시점까지 데이터베이스 조회를 미루고 싶으면 EntityManager.getReference() 메소드를 사용하면 됩니다.

이 메소드를 호출할 때 JPA는 데이터베이스를 조회하지 않고 실제 엔티티 객체도 생성하지 않습니다. 대신에 데이터베이스 접근을 위임한 프록시 객체를 반환합니다.

스크린샷 2019-11-21 오후 11 13 56

프록시의 특징

아래 그림을 보면 프록시 클래스는 실제 클래스를 상속 받아서 만들어지므로 실제 클래스와 겉 모양이 같습니다. 따라서 사용자 입장에서는 이것이 진짜 객체인지 프록시 객체인지 구분하지 않고 사용하면 됩니다.

스크린샷 2019-11-21 오후 10 47 53

프록시 객체는 실제 객체에 대한 참조(target)를 보관합니다. 그리고 프록시 객체의 메소드를 호출하면 프록시 객체는 실제 객체의 메소드를 호출합니다.

스크린샷 2019-11-21 오후 11 17 41

프록시 객체의 초기화

프록시 객체는 member.getNam()처럼 실제 사용될 때 데이터베이스를 조회해서 실제 엔티티 객체를 생성하는데 이것을 프록시 객체의 초기화라고 합니다.

//프록시 초기화 예제

Member member = em.getReference(Member.class, "id1");
member.getName(); //1. getName();
// 프록시 클래스 예상 코드
class MemberProxy extends Member{

    Object target = null;

    public String getName(){

        if(target == null){

            //2. 초기화 요청
            //3. DB 조회
            //4. 실제 엔티티 생성 및 참조 보관
            this.target = .....;
        }

        return target.getName();
    }
}

실제 프록시가 어떻게 실제 객체의 메소드를 호출하는지는 모르겠습니다...

프록시 초기화 과정

스크린샷 2019-11-21 오후 11 34 05

  1. 프록시 객체에 member.getName() 호출해서 실제 데이터를 조회합니다.
  2. 프록시 객체는 실제 엔티티가 생성되어 있지 않으면 영속성 컨텍스트에서 실제 엔티티 생성을 요청하는데 이것을 초기화라고 합니다.
  3. 영속성 컨텍스트는 데이터베이스를 조회해서 실제 엔티티 객체를 생성합니다.
  4. 프록시 객체는 생성된 실제 엔티티 객체의 참조를 Member target 맴버 변수에 보관합니다.
  5. 프록시 객체는 실제 엔티티 객체의 getName()을 호출해서 결과를 반환합니다.

프록시의 특징

  • 프록시 객체는 처음 사용할 때 한번만 초기화 됩니다.

  • 프록시 객체를 초기화한다고 프록시 객체가 실제 엔티티로 바뀌는 것은 아닙니다. 프록시 객체가 초기화되면 프록시 객체를 통해서 실제 엔티티에 접근할 수 있습니다.

  • 프록시 객체는 원본 엔티티를 상속받은 객체이므로 타입 체크 시에 주의해서 사용해야 합니다.

  • 영속성 컨텍스트에서 찾는 엔티티가 이미 있으면 데이터베이스를 조회할 필요가 없으므로 em.getReference()를 호출해도 프록시가 아닌 실제 엔티티를 반환합니다.

  • 초기화는 영속성 컨텍스트의 도움을 받아야 가능합니다. 따라서 영속성 컨텍스트의 도움을 받을 수 없는 준영속 상태의 프록시를 초기화하면 문제가 발생합니다. 하이버네이트는 org.hibernate.LazyInitializationException 예외를 발생시킵니다.

준영속 상태와 초기화에 관련된 코드는 아래같이 발생 할 수 있습니다.

Member member = em.getReference(Member.class, "id1");

transaction.comit();
// 준영속 상태 초기화 시도
//org.hibernate.LazyInitializationException 예외 발생!
member.getName(); 

em.close() 메소드로 영속성 컨텍스트를 종료해서 member는 준영속 상태입니다. member.getId()을 호출하면 프록시를 초기화해야 하는데 영속성 컨텍스트가 없으므로 실제 엔티티를 조회할 수 없습니다. 따라서 예외가 발생합니다.

프록시와 식별자

엔티티를 프록시로 조회 할 때 식별자(PK) 값을 파라미터로 전달하는데 프록시 객체는 이 식별자 값을 보관합니다.

Team team = em.getReference(Team.class, "team1"); //식별자 보관
team.getId(); // 초기화 되지 않습니다.

프록시 객체는 식별자 값을 가지고 있으므로 식별자 값을 조회하는 team.getId()를 호출해도 프록시를 초기화하지 않습니다. 단 엔티티의 접근 방식을 프로퍼티(@Access(AccessType.PROPERTY))로 설정한 경우에만 초기화되지 않습니다.

엔티티 접근 방식을 필드 (@Access(AccessType.FIELD))로 설정하면 JPA는 getId() 메소드가 id만 조회하는 메소드인지 다른 필드까지 활용해서 어떤일을 하는 메소드인지 알지 못하므로 프록시 객체를 초기화 합니다.

연관관계 설정시에 데이터베이스의 접근 횟수를 줄일 수 있습니다.

Member member = em.getReference(Member.class, "member1");
Team team = em.getReference(Team.class, "team1"); //식별자 보관
member.setTeam(team);

실제로 회원 엔티티가 팀 엔티티와 연관관계를 설정할때 팀 엔티티를 데이터베이스에서 영속성 컨텍스트로 가져오지 않고 팀 엔티티의 식별자 값만 가지고 있는 프록시를 사용하면 데이터베이스 접근 횟수를 줄일 수 있습니다. 참고로 연관관계를 설정해도 프록시를 초기화하지 않습니다.

프록시 확인

JPA가 제공하는 PersistenceUtil.isLoaded(Object entity) 메소드를 사용하면 프록시 인스턴스의 초기화 여부를 확인 할 수 있습니다. 아직 초기화되지 않는 프록시 인스턴스는 false를 반환합니다. 이미 초기화되었거나 프록시 인스턴스가 아니면 true를 반환합니다.

// member1 식별자 값을 가지고 있는 프록시를 반환합니다.
Member member = entityManager.getReference(Member.class, "member1");

//현재 JPA에서 엔티티 데이터에 접근하는 방식은 필드이기 때문에 프록시가 초기화됩니다. 프로퍼티 방식이면 초기화가 되지 않습니다.
System.out.println("회원이름: " + member.getName());


boolean isLoad = entityManager.getEntityManagerFactory()
                 .getPersistenceUnitUtil().isLoaded(member);

System.out.println("isLoad: " + isLoad);
System.out.println("memberProxy = " + member.getClass().getName());

실행결과

스크린샷 2019-11-22 오전 12 34 47

이것으로 프록시로 조회한 것을 알 수 있었습니다.

참조: 자바 ORM 표준 JPA 프로그래밍

'SpringFramework > JPA' 카테고리의 다른 글

영속성 전이 및 고아객체 제거  (0) 2019.11.23
지연로딩과 즉시로딩  (0) 2019.11.23
고급매핑 - 조인테이블  (0) 2019.10.30
복합 키와 식별관계 매핑  (0) 2019.10.29
고급매핑 - 상속관계 매핑  (0) 2019.10.28

조인 테이블

데이터베이스 테이블의 연관관계를 설계하는 방법은 크게 2가지 입니다.

  • 조인 컬럼 사용(외래 키)
  • 조인 테이블 사용(테이블 사용)

테이블 간에 관계는 주로 조인 컬럼이라 부르는 외래 키 컬럼을 사용해서 관리합니다.

스크린샷 2019-10-30 오전 1 16 48

조인 컬럼 사용

스크린샷 2019-10-30 오전 1 13 19

조인 컬럼 데이터

위의 그림에서 회원과 사물함이 있고 각각 테이블에 데이터를 등록했다가 회원이 원할 때 사물함을 선택할 수 있다고 가정해보겠습니다. 회원이 사물함을 사용하기 전까지 아직 둘 사이에 관계가 없으므로 MEMBER 테이블의 LOCKER_ID 외래 키에 null을 입력해두어야 합니다. 이렇게 외래 키에 null을 허용하는 관계를 선택적 비식별 관계라고 합니다.

선택적 비식별 관계는 외래 키에 null을 허용하므로 회원과 사물함을 조인할 때 외부 조인을 사용해야 합니다. 실수로 내부 조인을 사용하면 사물함과 관계 없는 회원은 조회되지 않습니다. 그리고 회원과 사물함이 아주 가끔 관계를 맺는다면 외래 키 값 대부분이 null로 지정되는 단점이 있습니다.

조인 테이블 사용

아래 그림은 조인 컬럼을 사용하는 대신에 조인 테이블을 사용해서 연관관계를 관리하고 있습니다.

스크린샷 2019-10-30 오전 1 38 42

조인 테이블 사용

스크린샷 2019-10-30 오전 1 44 41

조인 테이블 데이터

이 방법은 조인 테이블이라는 별도의 테이블을 사용해서 연관관계를 관리합니다.
조인 컬럼을 사용하는 방법은 단순히 외래 키 컬럼만 추가해서 연관관계를 맺지만 조인 테이블을 사용하는 방법은 연관관계를 관리하는 조인 테이블을 추가하고 여기서 두 테이블의 외래 키를 가지고 연관관계를 관리합니다. 따라서 MEMBER, LOCKER 테이블에는 연관관계를 관리하기 위한 외래 키 컬럼이 없습니다.

조인 테이블의 가장 큰 단점은 테이블을 하나 추가해야 한다는 점입니다. 따라서 관리해야 하는 테이블이 늘어나고 회원과 사물함 두 테이블을 조인하려면 MEMBER_LOCKER 테이블까지 추가로 조인해야 합니다. 따라서 기본은 조인 컬럼을 사용하고 필요하다고 판단되면 조인 테이블을 사용하면 됩니다.

일대일 조인 테이블

조인 테이블 일대일에서 조인 테이블을 살펴보겠습니다. 일대일 관계를 만들려면 조인 테이블의 외래 키 컬럼 각각에 총 2개의 유니크 제약조건을 걸어야 합니다.

@Setter
@Getter
@Entity
public class Parent {

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

    @OneToOne
    @JoinTable(name = "PARENT_CHILD",
        joinColumns = @JoinColumn(name = "PARENT_ID"),
        inverseJoinColumns = @JoinColumn(name = "CHILD_ID")
    )
    private Child child;
}

@Getter
@Setter
@Entity
public class Child {

    @Id @GeneratedValue
    @Column(name = "CHILD_ID")
    private Long id;
    private String name;
}






@Test
@Transactional
@Rollback(false)
public void 식별자_테스트() throws Exception {

        Parent parent = new Parent();
        parent.setName("임종수");

        Child child = new Child();
        child.setName("임준영");

        parent.setChild(child);
        em.persist(parent);
        em.persist(child);

}

다대일 조인 테이블

@Setter
@Getter
@Entity
public class Parent {

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

    @OneToMany
    private List<Child> child = new ArrayList<Child>();
}


@Getter
@Setter
@Entity
public class Child {

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


    @ManyToOne(optional = false)
    @JoinTable(name = "PARENT_CHILD",
            joinColumns = @JoinColumn(name = "CHILD_ID"),
            inverseJoinColumns = @JoinColumn(name = "PARENT_ID")
    )
    private Parent parent;

}

다대다 조인 테이블

다대다 관계를 만들려면 조인 테이블의 두 컬럼을 합해서 하나의 복합 유니크 제약조건을 걸어야 합니다.

@Setter
@Getter
@Entity
public class Parent {

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

    @ManyToMany
    @JoinTable(name = "PARENT_CHILD",
            joinColumns = @JoinColumn(name = "PARENT_ID"),
            inverseJoinColumns = @JoinColumn(name = "CHILD_ID")
    )
    private List<Child> child = new ArrayList<Child>();
}

@Getter
@Setter
@Entity
public class Child {

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

}

엔티티 하나에 여러 테이블 매핑

잘 사용하지는 않지만 @SecondaryTable을 사용하면 한 엔티티에 여러 테이블을 매핑할 수 있습니다.

스크린샷 2019-10-30 오전 2 39 20

@Entity
@Table(name = "BOARD")
@SecondaryTable(name = "BOARD_DETAIL",
pkJoinColumns = @PrimaryKeyJoinColumn(name = "BOARD_DETAIL_ID"))
public class Board{

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

    private String title;

    @Column(table = "BOARD_DETAIL")
    private String content;

}

위의 코드를 살펴보면 Board 엔티티는 @Table을 사용해서 BOARD 테이블과 매핑했습니다. 그리고 @SecondaryTable을 사용해서 BOARD_DETAIL 테이블을 추가로 매핑했습니다.

@SecondaryTable 속성은 다음과 같습니다.

@SecondaryTable.name: 매핑할 다른 테이블의 이름, 예제에서는 테이블명을 BOARD_DETAIL로 지정했습니다.

@SecondaryTable.pkJoinColumn: 매핑할 다른 테이블의 기본 키 컬럼 속성, 예제에서는 기본 키 컬럼명을 BOARD_DETAIL_ID로 지정했습니다.

@Column(table = "BOARD_DETAIL")
private String content;

content 필드는 @Column(table = "BOARD_DETAIL")을 사용해서 BOARD_DETAIL 테이블의 컬럼에 매핑했습니다. title 필드처럼 테이블을 지정하지 않으면 기본 테이블인 BOARD에 매핑됩니다.

@SecondaryTables({

    @SecondaryTable(name = "BOARD_DETAIL"),
    @SecondaryTable(name = "BOARD_FILE")

})

더 많은 테이블을 매핑하려면 @SecondaryTables를 사용하면 됩니다.
하지만 이 방법은 항상 두 테이블을 조회하므로 최적화하기가 어렵습니다. 반면에 일대일 매핑은 원하는 부분만 조회 할 수 있고 필요하면 둘다 함께 조회됩니다.

참고: 김영한의 JAVA ORM 표준 JPA 프로그래밍

'SpringFramework > JPA' 카테고리의 다른 글

지연로딩과 즉시로딩  (0) 2019.11.23
프록시와 연관관계 관리  (0) 2019.11.22
복합 키와 식별관계 매핑  (0) 2019.10.29
고급매핑 - 상속관계 매핑  (0) 2019.10.28
스프링 부트 테스트 : @DataJpaTest  (0) 2019.10.09

복합 키과 식별 관계 매핑

복합 키를 매핑하는 방법과 식벽관계, 비식별 관계를 매핑하는 방법을 알아보겠습니다.

식별관계 vs 비식별 관계

데이터베이스 테이블 사이에 관계는 외래 키가 기본 키에 포함되는지 여부에 따라 식별 관계와 비식별 관계로 구분됩니다. 두 관계의 특징을 이해하고 각각을 어떻게 매핑하는지 알아봅시다.

식별관계

식별 관계는 부모 테이블의 기본 키를 내려받아서 자식 테이블의 기본 키 + 외래 키로 사용하는 관계 입니다.

스크린샷 2019-10-28 오후 10 53 41

위의 그림을 보면 PARENT 테이블의 기본 키 PARENT_ID를 받아서 CHILD 테이블의 기본키 (PK) + 외래 키(FK)로 사용합니다.

비식별 관계

비식별 관계는 부모 테이블의 기본 키를 받아서 자식 테이블의 외래 키로만 사용하는 관계입니다.

스크린샷 2019-10-28 오후 10 55 20

PARENT 테이블의 기본 키 PARENT_ID를 받아서 CHILD 테이블의 외래 키(FK)로만 사용한다.
비식별 관계는 외래 키에 NULL을 허용하는지에 따라 필수적 비식별 관게와 선택적 비식별 관계로 나눕니다.

  • 필수적 비식별 관계: 외래키에 NULL을 허용하지 않습니다. 연관관계를 필수적으로 맺어야 합니다.

  • 선택적 식별 관계: 외래키에 NULL을 허용합니다. 연관관계를 맺을지 말지 선택할 수 있습니다.

최근에는 테이블을 설계할 때 식별 관계나 비식별 관계 중 하나를 선택해야 합니다.
최근에는 비식별 관계를 주로 사용하고 꼭 필요한 곳에만 식별 관계를 사용하는 추세입니다.
JPA는 식별 관계와 비식별 관계를 모두 지원합니다.

복합 키: 비식별 관계 매핑

둘 이상의 컬럼으로 구성된 복합 기본 키는 아래 코드처럼 매핑하면 될 것 같지만 막상 해보면 매핑 오류가 발생합니다. JPA에서는 식별자를 둘 이상 사용하려면 별도의 식별자 클래스가 필요하기 때문입니다.

@Entity
public class Hello{

    @Id
    private String id1;
    @Id
    private String id2; // 실행 시점에 매핑 예외발생

}

JPA는 영속성 컨텍스트에 엔티티를 보관할 때 엔티티의 식별자를 키로 사용합니다. 그리고 식별자를 구분하기 위해 equals와 hashCode를 사용해서 동등성 비교를 합니다. 그런데 식별자 필드가 하나일 때는 보통 자바의 기본타입을 사용하므로 문제가 없지만, 식별자 필드가 2개 이상이면 별도의 식별자 클래스를 만들고 그곳에 equals와 hashCode를 구현해야 합니다.

JPA는 복합 키를 지원하기 위해 @IdClass와 @EmbeddedId 2가지 방법을 제공하는데 @IdClass는 관계형 데이터베이스에 가까운 방법이고 @EmbeddedId는 좀 더 객체지향에 가까운 방법입니다. 먼저 @IdClass부터 알아봅시다.

@IdClass

복합 키 테이블은 비식별 관계이고 PARENT는 복합 기본 키를 사용합니다. 참고로 여기서 이야기하는 부모 자식은 객체의 상속과는 무관합니다. 단지 테이블의 키를 내려받는 것을 강조하려고 이름을 이렇게 지었습니다.

스크린샷 2019-10-28 오후 11 12 22

PARENT 테이블을 보면 기본 키를 PARENT_ID1, PARENT_ID2로 묶은 복합 키로 구성했습니다. 따라서 복합 키를 매핑하기 위해서 식별자 클래스를 만들어야 합니다.

@Entity
@IdClass(ParentId.class)
public class Parent{

    @Id
    @Column(name = "PARENT_ID1")
    private String id1;  // ParentId.id1과 연결

    @Id
    @Column(name = "PARENT_ID2")
    private String id2;  // ParentId.id2와 연결

    private String name;

}
public class ParentId implements Serializable{

    private String id1; // Parent.id1 매핑
    private String id2; // Parent.id2 매핑

    public ParentId(){}



    public ParentId(String id1, String id2)}
        this.id1 = id1;
        this.id2 = id2;
    }

    @Override
    public boolean equals(Object obj) { ... }

    @Override
    public int hashCode() {...}

}

@IdClass를 사용할 때 식별자 클래스는 다음 조건을 만족해야 합니다.

  • 식별자 클래스의 속성명과 엔티티에서 사용하는 식별자의 속성명이 같아야 합니다.
    실제로 코드를 보면 Parent.id1과 Parent.id2, 그리고 ParentId.id1, ParentId.id2가 같습니다.

  • Serializable 인터페이스를 구현해야 합니다.

  • equals, hashCode를 구현해야 합니다.

  • 기본 생성자가 있어야 합니다.

  • 식별자 클래스는 public이어야 합니다.

실제 어떻게 사용하는지 코드로 살펴보겠습니다. 먼저 복합 키를 사용하는 엔티티를 저장합니다.


    @Test
    @Transactional
    @Rollback(false)
    public void 식별자_테스트() throws Exception {

        //given
        Parent parent = new Parent();
        parent.setId1("myId1");
        parent.setId2("myId2");
        parent.setName("parentName");

        //when
        em.persist(parent);
        ParentId parentId = new ParentId("myId1", "myId2");

        //복합 키로  조회
        Parent findParent = em.find(Parent.class, parentId);
        //then
        System.out.println(findParent.getId1() + " " + findParent.getId2() + " " + findParent.getName());
     }

저장 코드를 보면 식별자 클래스인 ParentId가 보이지 않는데, em.persist()를 호출하면 영속성 컨텍스트에 엔티티를 등록하기 직전에 내부에서 Parent.id1, Parent.id2 값을 사용해서 식별자 클래스인 ParentId를 생성하고 영속성 컨텍스트의 키로 사용합니다.

아래 코드는 자식 클래스를 추가하였습니다.

@Getter
@Setter
@Entity
public class Child {

    @Id
    private String id;

    @ManyToOne
    @JoinColumns({@JoinColumn(name = "PARENT_ID1", referencedColumnName = "PARENT_ID1"),
    @JoinColumn(name = "PARENT_ID2", referencedColumnName = "PARENT_ID2")})
    private Parent parent;

}

부모 테이블의 기본 키 컬럼이 복합 키이므로 자식 테이블의 외래 키도 복합 키입니다. 따라서 외래 키 매핑시 여러 컬럼을 매핑해야 하므로 @JoinColumns 어노테이션을 사용하고 각각의 외래 키 컬럼을 @JoinColumn으로 매핑합니다.

참고로 @JoinColumn의 name 속성과 referencedColumnName 속성의 값이 같으면 referencedColumnName은 생략해도 됩니다.

@EmbeddedId

@IdClass가 데이터베이스에 맞춘 방법이라면 @EnbeddedId는 좀 더 객체지향적인 방법입니다.

@EqualsAndHashCode
@Embeddable
public class ParentId implements Serializable {

    @Column(name = "PARENT_ID1")
    private String id1; // Parent.id1 매핑
    @Column(name = "PARENT_ID2")
    private String id2; // Parent.id2 매핑

    public ParentId(){}


    public ParentId(String id1, String id2){
        this.id1 = id1;
        this.id2 = id2;
    }
}


@Setter
@Getter
@Entity
@IdClass(ParentId.class)
public class Parent {

    @EmbeddedId
    ParentId parentId;

    private String name;

}

@IdClass와는 다르게 EmbeddedId를 적용한 식별자 클래스는 식별자 클래스에 기본키를 직접 매핑합니다.

@EmbeddedId를 적용한 식별자 클래스는 다음 조건을 만족해야 합니다.

  • @Embeddedable 어노테이션을 붙어주어야 합니다.
  • Serializable 인터페이스를 구현해야 합니다.
  • equals, hashCode를 구현해야 합니다.
  • 기본 생성자가 있어야 합니다.
  • 식별자 클래스는 public이어야 합니다.

@EmbeddedId를 사용하는 코드를 보겠습니다.

    @Test
    @Transactional
    @Rollback(false)
    public void 식별자_테스트() throws Exception {

        Parent parent = new Parent();
        ParentId parentId = new ParentId("myId1", "myId2");
        parent.setParentId(parentId);
        parent.setName("parentName");

        em.persist(parent);

        ParentId parentId1 = new ParentId("myId1", "myId2");
        Parent findParent = em.find(Parent.class, parentId1);

        System.out.println(findParent.getName());
     }

위의 코드를 보면 식별자 클래스 parentId를 직접 생성해서 사용합니다.

@IdClass와 @EmbeddedId는 각각 장단점이 있으므로 본인의 취향에 맞는 것을 일관성 있게 사용하면 됩니다.

복합 키에는 @GenerateValue를 사용 할 수 없습니다. 복합 키를 구성하는 여러 컬럼 중 하나에도 사용할 수 없습니다.

김영한의 JAVA ORM 표준 JPA 프로그래밍

'SpringFramework > JPA' 카테고리의 다른 글

프록시와 연관관계 관리  (0) 2019.11.22
고급매핑 - 조인테이블  (0) 2019.10.30
고급매핑 - 상속관계 매핑  (0) 2019.10.28
스프링 부트 테스트 : @DataJpaTest  (0) 2019.10.09
JPA 다양한 연관관계 매핑  (0) 2019.10.04

고급매핑

상속 관계 매핑

  • 상속관계 매핑은 객체의 상속관계를 데이터베이스에 어떻게 매핑하는지 다룹니다.

관계형 데이터베이스에는 객체지향 언어에서 다루는 상속이라는 개념이 없습니다.
대신에 슈퍼타입 서브타입 관계라는 모델링 기법이 객체의 상속 개념과 가장 유사합니다.
ORM에서 이야기하는 상속 관계 매핑은 객체의 상속 구조와 데이터베이스의 슈퍼타입 서브타입 관계를 매핑하는 것 입니다.

객체 상속 모델

스크린샷 2019-10-27 오후 11 10 37

슈퍼타입 서브타입 논리 모델을 실제 물리 모델의 테이블로 구현할 때는 3가지 방법을 선택할 수 있습니다.

  • 각각의 테이블로 변환: 위 그림과 같이 각각을 모두 테이블로 만들고 조회할 때 조인을 사용합니다. JPA에서는 조인 전략이라고 할수 있습니다.

  • 통합 테이블로 변환: 테이블을 하나만 사용해서 통합합니다. JPA에서는 싱글 테이블 전략이라고 합니다.

  • 서브타입 테이블로 변환: 서브 타입마다 하나의 테이블을 만듭니다. JPA에서는 구현 클래스마다 테이블 전략이라 합니다.

위의 전략들을 하나하나씩 살펴보겠습니다.

조인전략은 그림과 같이 엔티티 각각을 모두 테이블로 만들고 자식 테이블이 부모 테이블의 기본 키를 받아서 기본 키 + 외래 키로 사용하는 전략입니다. 따라서 조회할 때 조인을 자주 사용합니다. 이 전략을 사용할 때 주의할 점이 객체는 타입으로 구분할 수 있지만 테이블은 타입 개념이 없습니다. 따라서 타입을 구분하는 컬럼을 추가해야 합니다. 여기서는 DTYPE 컬럼을 구분 컬럼으로 사용했습니다.

조인전략

스크린샷 2019-10-27 오후 11 28 01

조인전략 예제 코드

@Entity
@Inheritance(strategy = InheritanceType.JOINED)
@DiscriminatorColumn(name = "DTYPE")
public abstract class Item {

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

    private String name;
    private int price;

}

@Entity
@DiscriminatorValue("B")
public class Book extends Item {

    private String author;
    private String isbn;
}

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

    private String artist;

}

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

    private String director;

    private String actor;
}

@Inheritance(strategy = InheritanceType.JOINED): 상속 매핑은 부모 클래스에 @Inheritance를 사용합니다. 그리고 매핑 전략을 지정해야 하는데 여기서는 조인 전략을 사용하므로 InheritanceType.JOINED를 사용했습니다.

@DiscriminatorColumn(name = "DTYPE"): 부모 클래스에 구분 컬럼을 지정합니다. 이컬럼으로 저장된 자식 테이블을 구분할 수 있습니다. 기본 값이 DTYPE이므로 @DiscriminatorColumn으로 줄여 사용해도 된다.

@DiscriminatorValue("M"): 엔티티를 저장할 때 구분 컬럼에 입력할 값을 지정한다.
만약 영화 엔티티를 지정하면 구분 컬럼인 DTYPE에 값 M이 저장됩니다.

기본값으로 자식 테이블은 부모 테이블의 ID 컬럼명을 그대로 사용하는데, 만약 자식 테이블의 기본 키 컬럼명을 변경하고 싶으면 아래 코드처럼 사용하시면 됩니다.

@Entity
@DiscriminatorValue("B")
@PrimaryKeyJoinColumn(name = "BOOK_ID") //ID 재정의
public class Book extends Item{

    private String author; //저자
    private String isbn;   // ISBN

}
  • 장점

    - 테이블이 정규화 됩니다.

    - 외래키 참조 무결성 제약조건을 활용할 수 있습니다.

    - 저장공간을 효율적으로 사용합니다.

  • 단점

    - 조회할 때 조인이 많이 사용되므로 성능이 저하될 수 있습니다.

    - 조회쿼리가 복잡합니다.

    - 데이터를 등록할 INSERT SQL을 두 번 실행합니다.

JPA 표준 명세는 구분 컬럼을 사용하도록 하지만 하이버네이트를 포함한 몇몇 구현체는 구분컬럼 없이도 동작합니다.

싱글 테이블 전략

싱글 테이블 전략은 아래 그림과 같이 이름 그대로 테이블 하나만 사용합니다. 그리고 구분 컬럼으로 어떤 자식 데이터가 저장되었는지 구분합니다. 조회할 때 조인을 사용하지 않으므로 일반적으로 가장 빠릅니다.

싱글 테이블 전략

스크린샷 2019-10-27 오후 11 31 27

이 전략을 사용할 때 주의점은 자식 엔티티가 매핑한 컬럼은 모두 null을 허용해야 한다는 점입니다. 예를 들어 Book 엔티티를 저장하면 ITEM 테이블의 AUTHOR, ISBN 컬럼만 사용하고 다른 엔티티와 매핑된 ARTIST, DIRECTOR, ACTOR 컬럼은 사용하지 않으므로 null이 입력되기 때문입니다.

싱글테이블 예제 코드

@Entity
@Inheritance(strategy = InheritanceType.SINGLE_TABLE)
@DiscriminatorColumn(name = "DTYPE")
public abstract class Item {

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

    private String name;
    private int price;

}

@Entity
@DiscriminatorValue("B")
public class Book extends Item {

    private String author;
    private String isbn;
}

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

    private String artist;

}

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

    private String director;

    private String actor;
}

InheritanceType.SINGLE_TABLE로 지정하면 단일 테이블 전략을 사용합니다.
테이블 하나에 모든 것을 통합하므로 구분 컬럼을 필수로 사용해야 합니다. 단일 테이블 전략의 장단점은 하나의 테이블을 사용하는 특징과 관련 있습니다.

  • 장점

    - 조인이 필요 없으므로 일반적으로 조회 성능이 빠릅니다.

    - 조회 쿼리가 단순합니다.

  • 단점

    - 자식 엔티티가 매핑한 컬럼은 모두 null을 허용해야 합니다.

    - 단일 테이블에 모든 것을 저장하므로 테이블이 커질 수 있습니다. 그러므로 상황에 따라 조회 성능이 오히려 느려질 수 있습니다.

싱글 테이블 전략에서는 구분 컬럼 @DiscriminatorColumn을 꼭 설정해야 합니다.
@DiscriminatorValue를 지정하지 않으면 기본으로 엔티티 이름을 사용홥니다.

구현 클래스마다 테이블 전략

구현 클래스마다 테이블 전략은 아래 그림과 같이 자식 엔티티마다 테이블을 만듭니다.
그리고 자식 테이블에 각각에 필요한 컬럼이 모두 있습니다.

구현 클래스마다 테이블 전략

스크린샷 2019-10-27 오후 11 34 31

@Entity
@Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)
public abstract class Item {

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

    private String name;
    private int price;

}

@Entity
public class Book extends Item {

    private String author;
    private String isbn;
}

@Entity
public class Album extends Item {

    private String artist;

}

@Entity
public class Movie extends Item {

    private String director;

    private String actor;
}

InheritanceType.TABLE_PER_CLASS를 선택하면 구현 클래스마다 테이블 전략을 사용합니다. 이 전략은 자식 엔티티마다 테이블을 만듭니다. 일반적으로 추천하지 않는 전략입니다.

  • 장점

    - 서브 타입을 구분해서 처리할 때 효과적입니다.

    - not null 제약조건을 사용할 수 없습니다.

  • 단점

    - 여러 자식 테이블을 함꼐 조회할 때 성능이 느립니다.

    - 자식 테이블을 통합해서 쿼리하기 어렵습니다.

이 전략은 데이터베이스 설계자와 ORM 전문가 둘 다 추천하지 않는 전략입니다.
조인이나 싱글 테이블 전략을 고려합시다.

@MappedSuperclass

이전 포스팅에서 상속 관계 매핑은 부모 클래스와 자식 클래스를 모두 데이터베이스 테이블과 매핑하였습니다. 부모 클래스는 테이블과 매핑하지 않고 부모 클래스를 상속 받는 자식 클래스에게 매핑 정보만 제공하고 싶으면 @MappedSuperclass를 사용하면 됩니다.

@MappedSuperclass는 비유를 하자면 추상 클래스와 비슷한데 @Entity는 실제 테이블과 매핑되지만 @MappedSuperclass는 실제 테이블과는 매핑되지 않습니다.
이것은 단순히 매핑 정보를 상속할 목적으로만 사용합니다.

@MappedSuperclass
public abstract class BaseEntity {

    @Id @GeneratedValue
    private Long id;
    private String name;


}

@Entity
@Setter
@Getter
public class Member extends BaseEntity{

    // ID 상속
    // NAME 상속
    private String email;    
    ...
}

public class Seller extends BaseEntity{

    // ID 상속
    // NAME 상속
    private String shopName;
}

BaseEntity는 객체들이 주로 사용하는 공통 매핑 정보를 정의했습니다. 그리고 자식 엔티티들은 상속을 통해 BaseEntity의 매핑 정보를 물려받았습니다. 여기서 BaseEntity는 테이블과 매핑할 필요가 없고 자식 엔티티에게 공통으로 사용되는 매핑 정보만 제공하면 됩니다. 따라서 @MappeedSuperclass를 사용했습니다.

@Entity
@AttributeOverride(name = "id", column = @Column(name = "MEMBER_ID"))
public class Member extends BaseEntity{

}

위의 코드는 부모에게 물려받은 id 속성의 컬럼명을 MEMBER_ID로 재정의 하였습니다.
매핑 정보를 재정의하려면 AttributeOverrides 나 AttributeOverride를 사용하고, 연관관계를 재정의하려면 @AssociationOverrides나 @AssociationOverride를 사용합니다.

@MappedSuperclass의 특징

  • 테이블과 매핑되지 않고 자식 클래스에 엔티티의 매핑 정보를 상속하기 위해 사용합니다.

  • @MappedSuperclass로 지정한 클래스는 엔티티가 아니므로 em.find()나 JPQL에서 사용 할 수 없습니다.

  • 이 클래스를 직접 생성해서 사용할 일은 거의 없으므로 추상 클래스로 만드는 것을 권장합니다.

결론은 @MapperdSuperclass는 테이블과는 관계가 없고 단순히 엔티티가 공통으로 사용하는 매핑 정보를 모아주는 역할을 할 뿐입니다. ORM에서 이야기 하는 진정한 상속 매핑은 이전에 학습한 객체 상속을 데이터베이스 슈퍼타입 서브타입 관계와 매핑하는 것입니다.

@MapperdSuperclass를 사용하면 등록일자, 수정일자, 등록자, 수정자 같은 여러 엔티티에서 공통으로 사용하는 속성을 효과적으로 관리할 수 있습니다.

참조: 김영한님의 JAVA ORM 표준 JPA 프로그래밍

'SpringFramework > JPA' 카테고리의 다른 글

고급매핑 - 조인테이블  (0) 2019.10.30
복합 키와 식별관계 매핑  (0) 2019.10.29
스프링 부트 테스트 : @DataJpaTest  (0) 2019.10.09
JPA 다양한 연관관계 매핑  (0) 2019.10.04
JPA 연관관계 매핑기초  (0) 2019.10.04

@DataJpaTest

@DataJpaTest 어노테이션은 JPA 관련 테스트 설정만 로드합니다. DataSource의 설정이 정상적인지, JPA를 사용하여 데이터를 제대로 생성, 수정, 삭제하는지 등의 테스트가 가능합니다. 그리고 가장 좋은점은.. 무려 내장형 데이터베이스를 사용하여 실제 데이터베이스를 사용하지 않고 테스트 데이터베이스로 테스트할 수 있는.. 개꿀같은 장점이 있습니다.

@DataJpaTest는 기본적으로 @Entity 어노테이션이 적용된 클래스를 스캔하여 스프링 데이터 JPA 저장소를 구성합니다. 만약 최적화한 별도의 데이터소스를 사용하여 테스트하고 싶다면 기본 설정된 데이터소스를 사용하지 않도록 아래와 같이 설정해도 됩니다.

RunWith(SpringRunner.class)
@DataJpaTest
@ActiveProfiles("...")
@AutoConfigureTestDatabase(replace = 
@AutoConfigureTestDatabase.Replace.NONE)
public class JpaTest {

}

@AutoConfigureTestDatabase 어노테이션의 기본 설정값인 Replace.Any를 사용하면 기본적으로 내장된 임베디드 데이터베이스를 사용합니다. 위의 코드에서 Replace.NONE로 설정하면 @ActiveProfiles에 설정한 프로파일 환경값에 따라 데이터 소스가 적용됩니다. yml 파일에서 프로퍼티 설정을 spring.test.database.replace: NONE으로 변경하면 됩니다.

@DataJpaTest는 기본적으로 @Transactional 어노테이션을 포함하고 있습니다. 그래서 테스트가 완료되면 자동으로 롤백하기 때문에 직접 선언적 트렌젝션 어노테이션을 달아줄 필요가 없습니다.

만약에 @Transactional 기능이 필요하지 않다면 아래와 같이 줄 수 있습니다.

@RunWith(SpringRunner.class)
@DataJpaTest
@Transactional(propagation = Propagation.NOT_SUPPORTED)
public class JpaTest {
    ...
}

그리고 어떤 테스트 데이터베이스를 사용할 것인지도 선택 할 수 있습니다. spring.test.database.connection: H2와 같이 프로퍼티를 설정하는 방법과 @AutoConfigureTestDatabase(connection = H2) 어노테이션으로 설정하는 방법이 있습니다.

@DataJpaTest에서 EntityManager의 대체제로 만들어진 테스트용 TestEntityManager를 사용하면 persist, flush, find 등과 같은 기본적인 JPA테스트가 가능합니다. 아래 간단하게 도메인 객체에 대한 JPA 테스트를 수행할 수 있게 Book 클래스에 JPA 관련 어노테이션을 추가하고 BookRepository 인터페이스를 생성하였습니다.

Entity

package com.jun.jpacommunity.domain;

import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import java.time.LocalDateTime;

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Book {

    @Id
    @GeneratedValue
    private Integer idx;

    private String title;

    private LocalDateTime publishedAt;

    @Builder
    public Book(String title, LocalDateTime publishedAt) {
        this.title = title;
        this.publishedAt = publishedAt;
    }
}

Repository

package com.jun.jpacommunity.repository;

import com.jun.jpacommunity.domain.Book;
import org.springframework.data.jpa.repository.JpaRepository;

public interface BookRepository extends JpaRepository<Book, Integer> {

}

Test 코드

package com.jun.jpacommunity.repository;


import com.jun.jpacommunity.domain.Board;
import com.jun.jpacommunity.domain.Book;
import com.jun.jpacommunity.domain.Member;
import org.hamcrest.collection.IsEmptyCollection;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManager;
import org.springframework.test.context.junit4.SpringRunner;

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

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;

@RunWith(SpringRunner.class)
@DataJpaTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.ANY)
public class JpaTest {

    private final static String BOOT_TEST_TITLE = "Spring Boot Test Book";

    @Autowired
    private TestEntityManager testEntityManager;

    @Autowired
    private BookRepository bookRepository;

    @Test
    public void Book_저장하기_테스트() throws Exception {
        //given
        Book book1 = Book.builder()
                .title("타짜")
                .publishedAt(LocalDateTime.now())
                .build();

        //when
        testEntityManager.persist(book1);

        //then
        assertEquals(book1, testEntityManager.find(Book.class, book1.getIdx()));

     }

     @Test
     public void BookList_저장하고_검색_테스트() throws Exception {

         //given
         Book book1 = Book.builder()
                 .title(BOOT_TEST_TITLE +"1")
                 .publishedAt(LocalDateTime.now())
                 .build();

         testEntityManager.persist(book1);

         Book book2 = Book.builder()
                 .title(BOOT_TEST_TITLE +"2")
                 .publishedAt(LocalDateTime.now())
                 .build();

         testEntityManager.persist(book2);

         Book book3 = Book.builder()
                 .title(BOOT_TEST_TITLE +"3")
                 .publishedAt(LocalDateTime.now())
                 .build();

         testEntityManager.persist(book3);


         //when
         List<Book> bookList = bookRepository.findAll();

         //then
         assertEquals(bookList.size(), 3);
         assertEquals(book1, bookList.get(0));
      }


    @Test
    public void BookList_저장하고_삭제_테스트() throws Exception {

        //given
        Book book1 = Book.builder().title(BOOT_TEST_TITLE + "1").
                publishedAt(LocalDateTime.now()).build();

        testEntityManager.persist(book1);

        Book book2 = Book.builder().title(BOOT_TEST_TITLE + "2").
                publishedAt(LocalDateTime.now()).build();

        testEntityManager.persist(book2);

        //when
        bookRepository.deleteAll();
        //then
        assertThat(bookRepository.findAll(), IsEmptyCollection.empty());
    }
}

요즘에 TDD 방식으로 테스트 하는 습관을 기르기 위해서 인텔리제이에서 제공해주는 라이브 템플릿으로 간단하게 give, when, then으로 테스트 영역을 구분하여 테스트를 수행하였습니다.

  • Book_저장하기_테스트(): testEntityManager로 persist() 기능이 정상 동작되는지 테스트를 수행하였습니다.

  • BookList_저장하고_검색_테스트(): Book 3개를 저장한 후 저장된 Book의 개수가 3개가 맞는지, bookList에 0번째 인덱스에 저장된 book1 객체가 포함 되어있는지 테스트를 수행하였습니다.

  • BookList_저장하고_삭제_테스트(): 저장된 Book 중에서 2개가 제대로 삭제되었는지 테스트를 하였습니다.

참조: https://hyper-cube.io/2017/08/10/spring-boot-test-2/, 처음배우는 스프링 부트2

'SpringFramework > JPA' 카테고리의 다른 글

복합 키와 식별관계 매핑  (0) 2019.10.29
고급매핑 - 상속관계 매핑  (0) 2019.10.28
JPA 다양한 연관관계 매핑  (0) 2019.10.04
JPA 연관관계 매핑기초  (0) 2019.10.04
JPA가 지원하는 엔티티 매핑  (0) 2019.10.04

다양한 연관관계 매핑

지난번 포스팅에 이어서 다양한 연관관계 매핑 방법에 대해서 포스팅 하겠습니다.
엔티티의 연관관계를 매핑할 때는 다음 3가지를 고려해야 합니다.

  • 다중성
  • 단방향, 양방향
  • 연관관계의 주인

먼저 연관관게가 있는 두 엔티티가 일대일 관계인지 일대다 관계인지 다중성을 고려해야 합니다. 두 엔티티 중 한쪽만 참조하는 단방향 관계인지 서로 참조하는 양방향 관계인지도 생각을 해봐야 하고, 마지막으로 양방향 관계이면 누가 연관관계의 주인인지도 정해야 합니다. 생각보다 간단해 보이지만… JPA를 사용할때 고려해야 할점이 한두가지가 아닌거 같습니다.

단방향, 양방향

테이블은 객체와는 다르게 외래 키 하나로 조인을 사용해서 양방향으로 쿼리가 가능하므로 사실상 방향이라는 개념이 없습니다. 반면에 객체는 참조용 필드를 가지고 있는 객체만 연관된 객체를 조회할 수 있습니다. 객체 관계에서 한쪽만 참조하는 것을 단방향 관계라고 하고, 양쪽이 서로 참조하는 것을 양방향 관계라고 합니다.

연관관계의 주인

데이터베이스는 외래 키 하나로 두 테이블이 연관관계를 맺습니다. 따라서 테이블의 연관관계를 관리하는 포인트는 외래키 하나입니다. 반면에 엔티티를 양방향으로 매핑하면 A -> B, B -> A 2곳에서 서로를 참조합니다. 따라서 객체의 연관관계를 관리하는 포인트는 2곳 입니다.
JPA에서는 두 객체 연관관계 중 하나를 정해서 데이터베이스 외래 키를 관리하는데 이것을 연관관계의 주인이라고 합니다. 따라서 A -> B 또는 B -> A 둘 중 하나를 정해서 외래 키를 관리해야 합니다. 외래 키를 가진 테이블과 매핑한 엔티티가 외래키를 관리하는게 효율적이므로 보통 이곳을 연관관계의 주인으로 선택합니다. 주인이 아닌 방향은 외래 키를 변경할 수 없고 읽기만 가능합니다.
즉, 객체 그래프 탐색만 가능하다는 거죠. 연관관계의 주인은 mappedBy 속성을 사용하지 않습니다.

다대일

대다일 관계의 반대 방향은 항상 일대다 관계고 일대다 관계의 반대 방향은 항상 다대일 관계입니다. 데이터베이스 테이블의 일(1), 다(N)관계에서 외래 키는 항상 다쪽에 있습니다. 따라서 객체 양방향 관계에서 연관관계의 주인은 항상 다쪽입니다.

다대일 단방향[N:1]

아래 코드를 통해서 회원 엔티티와 팀 엔티티의 다대일 단방향 연관관계를 간단하게 살펴보겠습니다.

@Entity
@NoArgsConstructor
@ToString(exclude = "team")
@Getter @Setter
public class Member {

    @Id
    @Column(name = "MEMBER_ID")
    private String id;

    private String username;

    @ManyToOne
    @JoinColumn(name = "TEAM_ID")
    private Team team; //팀의 참조를 보관
}
@Entity
@NoArgsConstructor
@Getter @Setter
public class Team {

    @Id
    @Column(name = "TEAM_ID")
    private String id;

    private String name;
}

회원은 Member.team으로 팀 엔티티를 참조할 수 있지만 반대로 팀에는 회원을 참조하는 필드가 없습니다. 따라서 회원과 팀은 다대일 단방향 연관관계를 가집니다.

@ManyToOne
@JoinColumn(name = "TEAM_ID") // TEAM_ID 외래 키와 매핑
private Team team;

Member.team 필드로 회원 테이블의 TEAM_ID 외래 키를 관리합니다.

다대일 양방향[N:1, 1:N]

이번엔 위의 예제를 다대일 양방향 관계로 살펴보겠습니다.

@Entity
@NoArgsConstructor
@Getter
public class Member {

    @Id
    @Column(name = "MEMBER_ID")
    private String id;

    private String username;

    @ManyToOne
    @JoinColumn(name = "TEAM_ID")
    private Team team; 

    public void setTeam(Team team){

        this.team = team;
        //무한루프에 빠지지 않도록 체크합니다.
        if(!team.getMembers().contains(this)){
            team.getMembers().add(this);
        }
    }
}
@Entity
@NoArgsConstructor
@Getter @Setter
public class Team {

    @Id
    @Column(name = "TEAM_ID")
    private String id;

    private String name;

    //컬렉션은 필드에서 바로 초기화 하는것이 안전합니다.
    //nul 문제에서 안전합니다. 하이버네이트는 엔티티를 영속화 할때, 컬렉션을 감싸서 하이버네이트가 제공하는 내장컬렉션으로 변경합니다. 
    @OneToMany(mappedBy = "team")
    private List<Member> members = new ArrayList<>();

    public addMember(Member member){
        this.members.add(member);
        if(member.getTeam() != this){ // 무한루프에 빠지지 않도록 체크함
            member.setTeam(this);
        }
    }
}
  • 양방향은 외래 키가 있는 쪽이 연관관계의 주인입니다.
    일대다와 다대일 연관관계는 항상 다(N)에 외래 키가 있습니다. 여기서는 다쪽인 MEMBER 테이블이 외래 키를 가지고 있으므로 Member.team이 연관관계의 주인입니다. JPA는 외래 키를 관리할 때 연관관계의 주인만 사용합니다. 주인이 아닌 Team.members는 조 회를 위한 JPQL이내 객체 그래프를 탐색할 때 사용합니다.

  • 양뱡향 연관관계는 항상 서로를 참조해야 합니다.
    어느 한 쪽만 참조하면 양방향 연관관계가 성립하지 않습니다. 항상 서로 참조하게 하려면 연관관계 편의 메소드를 작성하는게 좋은데 회 원의 setTeam() , addMember() 메소드가 이런 편의 메소드들입니다. 편의 메소드는 한 곳에만 작성하거나 양쪽 다 작성할 수 있는 데, 양쪽에 다 작성하면 무한루프에 빠지므로 주의해야 합니다. 위의 코드에서는 편의 메소드를 양쪽에다 작성해서 둘 중 하나만 호출하면 됩니다.

일대다

일대다 관계는 다대일의 관계의 반대 방향입니다. 일대다 관계는 엔티티를 하나 이상 참조할 수 있으므로 자바 컬렉션인 Collection, List, Set, Map 중에 하나를 사용해야 합니다.

일대다 단방향 1:N

@Entity
@Getter @Setter
public class Team {

    @Id @GeneratedValue
    @Column(name = "TEAM_ID")
    private String id;

    private String name;

    @OneToMany
    @JoinColumn(name = "TEAM_ID") //MEMBER 테이블의 TEAM_ID (FK)
    private List<Member> members = new ArrayList<>();
}
@Entity
@Setter
@Getter
public class Member {

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private String id;

    private String username;
}

코드를 보면 일대다 단방향 관계는 약간 특이합니다. 팀 엔티티의 Team.members로 회원 테이블의 TEAM_ID 외래 키를 관리합니다. 보통 자신이 매핑한 테이블의 외래 키를 관리하는데, 이 매핑은 반대쪽 테이블에 있는 외래 키를 관리합니다. 그럴 수밖에 없는 것이 일대다 관계에서 외래 키는 항상 다쪽 테이블에 있습니다. 하지만 다 쪽인 Member 엔티티에는 외래 키를 매핑할 수 있는 참조 필드가 없습니다. 대신에 반대쪽인 Team 엔티티에만 참조 필드인 members가 있습니다. 따라서 반대편 테이블의 외래 키를 관리하는 특이한 모습입니다.

일대다 단방향 관계를 매핑할 때는 @JoinColumn을 명시해야 합니다. 그렇지 않으면 JPA는 연결 테이블을 중간에 두고 연관관계를 관리하는 조인 테이블 전략을 기본으로 사용해서 매핑합니다.

일대다 단방향 매핑의 단점은 매핑한 객체가 관리하는 외래 키가 다른 테이블에 있다는 점입니다. 본인 테이블에 외래 키가 있으면 엔티티 의 저장과 연관관계 처리가를 INSERT SQL 한 번으로 끝낼 수 있지만, 다른 테이블에 외래 키가 있으면 연관관계 처리를 위한 UPDATE SQL을 추가로 실행해야 합니다.

Member 엔티티는 Team 엔티티를 모릅니다. 그리고 연관관계에 대한 정보는 Team 엔티티의 members가 관리합니다. 따라서 Member 엔티티를 저장할 때는 MEMBER 테이블의 TEAM_ID 외래 키에 아무 값도 저장되지 않습니다. 대신 Team 엔티티를 저장할 때 Team.members의 참조 값을 확인해서 회원 테이블에 있는 TEAM_ID 외래 키를 업데이트 합니다.

이것만 보면… 굳이 이렇게 일대다 단방향 매핑보다는 다대일 양방향 매핑을 하는게 훨씬 편하고 간편하니… 다대일 양방향 매핑을 사용합시다.

일대다 양방향 1:N, N:1

일대다 양방향 매핑은 존재하지 않습니다. 대신 다대일 양방향 매핑을 사용해야 합니다. 더 정확히 말하자면 양방향 매핑에서 @OneToMany는 연관관계의 주인이 될 수 없습니다.
관계형 데이터베이스 특성상 일대다. 다대일 관계는 항상 다 쪽에 외래 키가 있습니다. 이런 이유로 @ManyToOne에는 mappedBy 속성이 없습니다.

일대일

일대일 관계는 양쪽이 서로 하나의 관계만 가집니다. 예를 들어 회원은 하나의 사물함만 사용하고 사물함도 하나의 회원에 의해서만 사용됩니다.

일대일 관계의 특징

  • 일대일 관계는 그 반대도 일대일 관계입니다.
  • 테이블 관계에서 일대다, 다대일은 항상 다(N)쪽이 외래 키를 가집니다. 반면에 일대일 관계는 주 테이블이나 대상 테이블 둘 중 어느곳 이나 외래 키를 가질 수 있습니다.
  1. 주테이블의 외래 키
    주 객체가 대상 객체를 참조하는 것처럼 주 테이블에 외래 키를 두고 대상 테이블을 참조합니다. 외래 키를 객체 참조와 비슷하게 사용 할 수 있어서 객체지향 개발자들이 선호합니다. 이 방법의 장점은 주 테이블이 외래 키를 가지고 있으므로 주 테이블만 확인해도 대상 테이블과 연관관계가 있는지 알 수 있습니다.

  2. 대상 테이블에 외래 키
    전통적인 데이터베이스 개발자들은 보통 대상 테이블에서 외래 키를 두는 것을 선호합니다. 이 방법의 장점은 테이블의 관계를 일대일에 서 일대다로 변경할 때 테이블 구조를 그대로 유지할 수 있습니다.

일대일 단방향 1:1

// 일대일 주 테이블에 외래 키, 단방향 매핑 코드
@Entity
@Getter
@Setter
public class User {

    @Id @GeneratedValue
    @Column(name = "user_id")
    private String id;

    private String username;

    @OneToOne
    @JoinColumn(name = "locker_id")
    private Locker locker;   
}
@Entity
@Getter @Setter
public class Locker {

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

    private String name;

}

일대일 관계이므로 객체 매핑에 @OneToOne을 사용했습니다. 참고로 이 관계는 다대일 단방향과 거의 비슷합니다.

일대일 양방향 1:1

// 일대일 주 테이블에 외래 키, 양방향 매핑 코드
@Entity
@Getter
@Setter
public class User {

    @Id @GeneratedValue
    @Column(name = "user_id")
    private String id;

    private String username;

    @OneToOne
    @JoinColumn(name = "locker_id")
    private Locker locker;   
}
@@Entity
@Getter @Setter
public class Locker {

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

    private String name;

    @OneToOne(mappedBy = "locker") // 연관관계의 주인이 아님을 선언
    private Member member;
}

양방향이므로 연관관계의 주인을 정해야 합니다.

다대다

관계형 데이터베이스는 정규화된 테이블 2개로 다대다 관계를 표현할 수 없습니다. 그래서 보통 다대다 관계를 일대다, 다대일 관계로 풀어내는 연결 테이블을 사용합니다.
예를 들어 회원들은 상품을 주문합니다. 반대로 상품들은 회원들에 의해 주문됩니다. 둘은 다대다 관계입니다.

스크린샷 2019-10-04 오전 2 42 15

필자가 아이패드로(깨알자랑) 다대다 관계를 그려봤습니다… 악필이라… 이해해주세요.

그래서 아래 그림처럼 중간에 연결 테이블을 추가해야 합니다. Member_Product 연결 테이블을 추가했습니다. 이 테이블은 사용해서 다대다 관계를 일대다, 다대일 관계로 풀어 낼 수 있습니다. 이 연결 테이블은 회원이 주문한 상품을 나타냅니다.

스크린샷 2019-10-04 오전 2 42 23

그런데 객체는 테이블과 다르게 객체 2개로 다대다 관계를 만들 수 있습니다. 예를들어 회원 객체는 컬렉션을 사용해서 상품들을 참조하면 되고 반대로 상품들도 컬렉션을 사용해서 회원들을 참조하면 됩니다.
@ManyToMany를 사용하면 다대다 관계를 편리하게 매핑할 수 있습니다.

다대다 단방향 N:N

마찬가지로 예제로 한번 보겠습니다.

@Entity
@Getter
@Setter
public class User {

    @Id @GeneratedValue
    @Column(name = "user_id")
    private String id;

    private String username;

    @ManyToMany
    @JoinTable(name = "MEMBER_PRODUCT", joinColumns = @JoinColumn(name = "user_id"), inverseJoinColumns =     @JoinColumn(name = "product_id"))
    List<Product> products = new ArrayList<Product>();
}
@Entity
@Getter
@Setter
public class Product {

    @Id
    @JoinColumn(name = "product_id")
    private String id;

    private String name;
}

위의 코드에서 회원 엔티티와 상품 엔티티를 @ManyToMany로 매핑했습니다. 여기서 중요한 점은 @ManyToMany와 @JoinTable을 사용해서 연결 테이블로 바로 매핑한 것입니다. 따라서 회원과 상품을 연결하는 회원_상품 엔티티 없이 매핑을 완료할 수 있습니다.

  • @JoinTable.name: 연결 테이블을 지정합니다. 여기서는 MEMBER_PRODUCT 테이블을 선택했습니다.

  • @JoinTable.joinColumns: 현재 방향인 회원과 매핑할 조인 컬럼 정보를 지정합니다. MEMBER_ID로 지정했음

  • @JoinTable.inverseJoinColumns:반대 방향인 상품과 매핑할 조인 컬럼 정보를 지정합니다. PRODUCT_ID로 지정했음

MEMBER_PRODUCT 테이블은 다대다 관계를 일대다, 다대일 관계로 풀어내기 위해 필요한 연결 테이블 뿐입니다. @ManyToMany로 매핑한 덕분에 다대다 관계를 사용할 때는 이 연결 테이블에 신경을 쓰지 않아도 됩니다.

@Test
// 각 메소드 마다 트랜잭션을 걸어준다.
// 시작점에 transaction.begin(), 끝점에 transaction.commit()이 달린다고 생각하자.
@Transactional
@Rollback(false)
public void manyToManyTest() {

    Product product = new Product();
    product.setId("productA");
    product.setName("상품A");
    em.persist(product);

    User user = new User();
    user.setId("member1");
    user.setUsername("회원1");
    user.getProducts().add(product);
    em.persist(user);
}

결과 값:

스크린샷 2019-10-04 오전 2 42 35

// 탐색
    @Test
    @Transactional
    @Rollback(false)
    public void find() {
        User user = em.find(User.class,"member1" );
        List<Product> products = user.getProducts();
        for (Product product : products) {
            System.out.println("Product.name = " +product.getName());
        }
 }

다대다 양방향 N:N

다대다 양방향은 역방향에도 @ManyToMany를 사용합니다. 그리고 양쪽 중 원하는 곳에 mappedBy로 연관관계의 주인을 지정합니다.

@Entity
public class Product{

    @Id
    private String id;

    @ManyToMany(mappedBy = "products") // 역방향 추가
    private List<Member> members;

}

다대다 양방향 연관관계는 다음처럼 설정하면 됩니다.
member.getProducts().add(product);
product.getMembers().add(member);

또한 연관관계 편의 메소드를 추가해서 관리하는 것이 편리합니다.

public void addProduct(Product product){

    products.add(product);
    product.getMembers().add(this);
}
출저: 자바 ORM 표준 JPA 프로그래밍

+ Recent posts