자바 ORM 표준 JPA 프로그래밍

7. 고급 매핑

Featured image

상속 관계 매핑

ORM에서 이야기하는 상속 관계 매핑은 객체의 상속 구조와 데이터베이스의 슈퍼/서브 타입 관계를 매핑하는 것이다.
슈퍼/서브 타입 논리 모델을 실제 물리 모델인 테이블로 구현할 때는 3가지 방법을 선택할 수 있다.

조인 전략(Joined Strategy)

엔티티를 각각 모두 테이블로 만들고 자식 테이블이 부모 테이블의 기본 키를 받아서 기본 키 + 외래 키로 사용하는 전략이다. 조인테이블전략

@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("A")
public class Album extends Item {
    
    private String artist;
    
    ...
}

@Entity
@DiscriminatorValue("M")
public class Movie extends Item {
    
    private String director;    //  감독  
    private String actor;       //  배우
}

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

    private String author;  //  작가
    private String isbn;    //  ISBN
    ...
}
어노테이션 기능 기본 값
@Inheritance(strategy = InheritanceType.JOINED) 상속 매핑은 부모 클래스에 @Inheritance를 사용해야 한다. 그리고 strategy로 매핑 전략을 지정한다. SINGLE_TABLE
@DiscriminatorColumns(name = "DTYPE") 부모 클래스에 구분 컬럼명(DTYPE)을 지정한다. @DiscriminatorColumns로 줄여도 된다. DTYPE
@DiscriminatorValue("M") 엔티티 저장할 때 구분 컬럼에 입력할 값을 지정한다. 영화 엔티티 저장 시 구분 컬럼인 DTYPE값으로 M이 저장된다. 엔티티 이름
@PrimaryKeyJoinColumn(name = "BOOK_ID") 기본 값으로 자식 테이블은 부모 테이블의 ID 컬럼명을 그대로 사용하는데, 자식 테이블의 기본 키 컬럼명을 변경하고 사용한다.

특징

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

장점

단점

단일 테이블 전략

테이블을 하나만 사용하고 구분 컬럼(DTYPE)으로 어떤 자식 데이터가 저장되었는지 구분한다. 조회할 때 조인을 사용하지 않으므로 일반적으로 가장 빠르다.
주의할 점은 자식 엔티티가 매핑할 컬럼은 모두 null을 허용해야 한다. 예를 들어 Book 엔티티를 저장하면 ITEM 테이블의 AUTHOR, ISBN 컬럼만 사용하고 다른 엔티티와 매핑된 ARTIST, DIRECTOR, ACTOR 컬럼은 사용하지 않으므로 null이 입력되기 떄문이다. 싱글테이블전략

@Entity
@Inheritance(strategy = InheritanceType.SINGLE_TABLE)   //  default가 SINGLE_TABLE이므로 strategy 생략 가능
@DiscriminatorColumn(name = "DTYPE")
public abstract class Item {

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

    private String name;    //  이름 
    private int price;      //  가격

    ...
}

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

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

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

특징

구분 컬럼을 꼭 사용해야 한다. 따라서 @DiscriminatorColumn을 꼭 설정해야 한다.
@DiscriminatorValue를 지정하지 않으면 기본으로 엔티티 이름을 사용한다.(ex. Movie, Album, Book)

장점

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

자식 엔티티마다 테이블을 만들고 각각의 자식 테이블마다 필요한 컬럼이 모두 있다. 일반적으로 추천되지 않는 전략이다. 구현클래스마다테이블전략

@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 Album extends Item {...}

@Entity
public class Movie extends Item {...}

@Entity
public class Book extends Item {...}

특징

구분 컬럼이 사용되지 않는다. DBA나 ORM 전문가 모두 추천하지 않는 전략으로 조인이나 단일 테이블 전략을 고려하자.

장점

@MappedSuperclass

@MappedSuperclass는 부모 클래스와 자식 클래스 모두 데이터베이스 테이블과 매핑하는 것이 아닌 부모 클래스는 테이블과 매핑하지 않고 부모 클래스를 상속 받는 자식 클래스에게 매핑 정보만 제공할 때 사용 된다.
추상 클래스와 비슷한 개념으로, @Entity와 달리 실제 테이블과 매핑되지 않는다. 단순히 매핑 정보를 상속할 목적으로만 사용된다. mappedsuperclass id, name 두 공통 속성을 부모 클래스로 모으고 객체 상속 관계로 만든다.

@MappedSuperclass
public abstract class BaseEntity {

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

@Entity
public class Member extends BaseEntity {

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

@Entity
public class Seller extends BaseEntity {

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

복합 키와 식별 관계 매핑

식별 관계 vs 비식별 관계

데이터베이스 테이블 사이에 관계는 외래 키가 기본 키에 포함되는지 여부에 따라 식별 관계와 비식별 관계로 구분한다.

식별 관계

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

비식별 관계

부모 테이블의 기본 키를 받아서 자식 테이블의 외래 키로만 사용하는 관계다. 비식별관계 비식별 관계는 외래 키에 NULL을 허용하는지에 따라 필수적/선택적 비식별 관계로 나뉜다.

복합 키를 활용한 비식별 관계 매핑

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

@IdClass

관계형 데이터베이스에 더 가까운 방법으로 아래와 같이 사용된다. 복합키테이블

@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 o) {...}

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

@IdClass를 사용하기 위한 식별자 클래스는 다음 조건을 만족해야 한다.

Parent parent = new Parent();
parent.setId1("myId1"); //  식별자
parent.setId2("myId2"); //  식별자
parent.setName("parentName");
em.persist(parent);

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

ParentId parentId = new ParentId("myId1", "myId2");
Parent parent = em.find(Parent.class, parentId);

복합 키로 parent 엔티티를 조회해오는 코드다.

@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

객체지향적인 방법으로 아래와 같이 사용된다.

@Entity
public class Parent {
    @EmbeddedId
    private ParentIdPK id;

    private String name;
    ...
}
@Embeddable
public class ParentIdPK implements Serializable {
    
    @Column(name = "PARENT_ID1")
    private String id1;

    @Column(name = "PARENT_ID2")
    private String id2;

    //  equals and hashCode 구현
    ...
}

@EmbeddedId를 적용한 식별자 클래스는 식별자 클래스에 기본 키를 직접 매핑한다.
@EmbeddedId를 적용한 식별자 클래스는 다음 조건을 만족해야 한다.

Parent parent = new Parent();
ParentIdPK parentId = new ParentIdPK("myId1", "myId2");
parent.setId(parentId);
parent.setName("parentName");
em.persist(parent);

위와 같이 저장하는 코드를 보면 식별자 클래스 parentId를 직접 생성해서 사용한다.

ParentIdPK parentId = new ParentIdPK("myId1", "myId2");
Parent parent = em.find(Parent.class, parentId);

조회 코드도 식별자 클래스 parentId를 직접 사용한다.

복합 키와 equals(), hashCode()

복합 키는 equals()와 hashCode()를 필수로 구현해야 한다.

Object 클래스에 구현된 equals()는 기본적으로 인스턴스 참조 값 비교인 == 비교(동일성 비교)를 하기 때문에 오버라이딩을 통해 동등성 비교가 가능하도록 구현이 필요하다.
영속성 컨텍스트는 기본적으로 엔티티의 식별자를 키로 사용해서 엔티티를 관리하고, 식별자를 비교할 때 equals()와 hashCode()를 사용하기 때문에 동등성이 지켜지지 않으면 예상과 다른 엔티티가 조회되거나 엔티티를 찾을 수 없는 등의 문제가 발생한다. 따라서 복합 키는 equals()와 hashCode()를 필수로 구현해야 한다.

@IdClass vs @EmbeddedId

특정 상황에 따라 @EmbeddedId를 사용했을 때 JPQL이 더 길어질 수 있다.

em.createQuery("select p.id.id1, p.id.id2 from Parent p");  //  @EmbeddedId
em.createQuery("select p.id1, p.id2 from Parent p");        //  @IdClass

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

복합 키를 활용한 식별 관계 매핑

식별관계 부모, 자식, 손자까지 계속 기본 키를 전달하는 식별 관계다. 식별 관계에서 자식 테이블은 부모 테이블의 기본 키를 포함해서 복합 키를 구성해야 하므로 @IdClass나 @EmbeddedId를 사용해서 식별자를 매핑해야 한다.

@IdClass를 활용한 식별 관계

//  부모
@Entity
public class Parent {

    @Id @Column(name = "PARENT_ID")
    private String id;
    private String name;
    ...
}

//  자식
@Entity
@IdClass(ChildId.class)
public class Child {

    @Id
    @ManyToOne
    @JoinColumn(name = "PARENT_ID")
    public Parent parent;

    @Id @Column(name = "CHILD_ID")
    private String childId;

    private String name;
    ...
}

//  자식 ID
public class ChildId implements Serializable {

    private String parent;  //  Child.parent 매핑
    private String childId; //  Child.childId 매핑

    //  equals, hashCode 구현
    ...
}

@Entity
@IdClass(GrandChildId.class)
public class GrandChild {
    
    @Id
    @ManyToOne
    @JoinColumns({
        @JoinColumn(name = "PARENT_ID"),
        @JoinColumn(name = "CHILD_ID")
    })
    private Child child;

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

    private String name;
    ...
}

//  손자 ID
public class GrandChildId implements Serializable {
    
    private ChildId child;  //  GrandChild.child 매핑 
    private String id;      //  GrandChild.id 매핑

    //  equals, hashCode
    ...
}

식별 관계는 기본 키 + 외래 키 여야 하므로 @Id@ManyToOne을 같이 사용하여 매핑한다.

@EmbeddedId를 활용한 식별 관계

@EmbeddedId를 활용하여 식별 관계를 구성할 때는 @MapsId를 사용해야 한다.

//  부모
@Entity
public class Parent {

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

    private String name;
    ...
}

//  자식
@Entity
public class Child {

    @EmbeddedId
    private ChildIdPK id;

    @MapsId("parentId") //  ChildIdPK.parentId 매핑
    @ManyToOne
    @JoinColumn(name = "PARENT_ID")
    public Parent parent;

    private String name;
    ...
}

//  자식 ID
@Embeddable
public class ChildIdPK implements Serailizable {
    
    private String parentId;    //  @MapsId("parentId")로 매핑

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

    //  equals, hashCode 구현
    ...
}

@Entity
public class GrandChild {

    @EmbeddedId
    private GrandChildId id;

    @MapsId("childId")  //  GrandChildIdPK.childId 매핑
    @ManyToOne
    @JoinColumns({
        @JoinColumn(name = "PARENT_ID"),
        @JoinColumn(name = "CHILD_ID")
    })
    private Child child;

    private String name;
    
    ...
}

// 손자 ID
@Embeddable
public class GrandChildPK implements Serializable {
    
    private ChildId chlidId;    //  @MapsId("childId")로 매핑

    @Column(name = "GRANDCHILD_ID")
    private String id;

    //  equals, hashCode 구현
    ...
}

@IdClass와 달리 @Id가 아닌 @MapsId로 외래 키와 기본 키를 매핑하였다. @MapsId의 속성 값은 @EmbeddedId를 사용한 식별자 클래스의 기본 키 필드를 지정한다.

비식별 관계로 구현

비식별관계

//  부모
@Entity
public class Parent {

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

    private String name;

    ... 
}

//  자식
@Entity
public class Child {

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

    private String name;

    @ManyToOne
    @JoinColumn(name = "PARENT_ID") //  생략하게 되면 parent_PARENT_ID 로 컬럼명 생성
    private Parent parent;
    
    ...
}

//  손자
@Entity
public class GrandChild {
    
    @Id @GeneratedValue
    @Column(name = "GRANDCHILD_ID")
    private Long id;

    private String name;

    @ManyToOne
    @JoinColumn(name = "CHILD_ID") //   생략하게 되면 child_CHILD_ID 로 컬럼명 생성
    private Child child;

    ...
}

식별 관계와 비교하면 복합 키가 없으므로 복합 키 클래스를 생성하지 않아도 돼서 매핑도 쉽고 코드도 단순하다.

일대일 식별 관계

일대일식별관계

//  부모
@Entity
public class Board {
    
    @Id @GeneratedValue
    @Column(name = "BOARD_ID")
    private Long id;

    private String title;

    @OneToOne(mappedBy = "board")
    private BoardDetail boardDetail;

    ...
}

//  자식
@Entity
public class BoardDetail {

    @Id
    private Long boardId;

    @MapsId //  BoardDetail.boardId 매핑
    @OneToOne
    @Column(name = "BOARD_ID")
    private Board board;

    private String content;

    ...
}

BoardDetail처럼 식별자가 단순히 컬럼 하나면 @MapsId를 사용하고 속성 값은 비워두면 @MapsId는 @Id를 사용해서 식별자로 지정한 BoardDetail.boardId와 매핑된다.

식별 vs 비식별 관계

데이터베이스 설계 관점에서 비식별 관계를 선호하는 이유

비식별 관계를 주로 사용하고 기본 키는 Long 타입의 대리 키를 사용하는 것이 좋다. 대리 키는 비즈니스와 연관이 없기 때문에 비즈니스가 변경되어도 유연한 대처가 가능하기 때문이다.

선택적 비식별 관계는 NULL을 허용되어 연관관계를 맺을지 선택할 수 있기 때문에 조인할 때 반드시 외부 조인을 사용해야 하는 반면, 필수적 비식별 관계는 NOT NULL로 항상 연관 관계가 있다는 것을 보장하므로 내부 조인만 사용해도 된다.

조인 테이블

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

기본으로는 조인 컬럼을 사용하고, 필요할 때 조인 테이블을 적용하는 것이 좋다.

일대일 조인 테이블

일대일 관계를 만드려면 조인 테이블의 외래 키 컬럼 각각에 총 2개의 유니크 제약조건을 걸어야 한다. 일대일조인테이블

//  부모
@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;
    ...
}

//  자식
@Entity
public class Child {

    @Id @GeneratedValue
    @Column(name = "CHILD_ID")
    private Long id;
    private String name;
    ...
}
속성 기능 기본 값
name 매핑할 조인 테이블 이름
joinColumns 현재 엔티티를 참조하는 외래 키
inverseJoinColumns 반대방향 엔티티를 참조하는 외래 키

양방향 매핑은 아래를 추가해야 한다.

public class Child {
    ...
    @OneToOne(mappedBy = "child")
    private Parent parent;
}

일대다 조인 테이블

일대다 관계를 만드려면 조인 테이블의 컬럼 중 다(N)와 관련된 컬럼인 CHILD_ID에 유니크 제약조건을 걸어야 한다. 일대다조인테이블 일대다 단방향 매핑 예시 코드이다.

//  부모
@Entity
public class Parent {
   
    @Id @GeneratedValue
    @Column(name = "PARENT_ID")
    private Long id;
    private String name;

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

//  자식
@Entity
public class Child {
    
    @Id @GeneratedValue
    @Column(name = "CHILD_ID")
    private Long id;
    private String name;
    ...
}

다대일 조인 테이블

다대일 양방향 매핑 예시 코드이다.

//  부모
@Entity
public class Parent {
   
    @Id @GeneratedValue
    @Column(name = "PARENT_ID")
    private Long id;
    private String name;

    @OneToMany(mappedBy = "parent")
    private List<Child> child = new ArrayList<Child>();
    ...
}

//  자식
public class Child {
    
    @Id @GeneratedValue
    @Column(name = "CHILD_ID")
    private Long id;
    private String name;

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

다대다 조인 테이블

다대다 관계를 만드려면 조인 테이블의 두 컬럼을 합해서 하나의 복합 유니크 제약조건을 걸어야 한다.(PARENT_ID, CHILD_ID는 복합 기본 키이므로 유니크 제약조건이 걸려있다.) 다대다조인테이블

//  부모
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<>();
    ...
}

//  자식
@Entity
public class Child {

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

조인 테이블에 컬럼을 추가하면 @JoinTable 전략을 사용할 수 없다. 대신에 새로운 엔티티를 만들어서 조인 테이블과 매핑해야 한다.

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

@SecondaryTable을 사용하면 한 엔티티에 여러 테이블을 매핑할 수 있다.

@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 테이블을 추가 매핑하였다. content 필드는 @Column(table = “BOARD_DETAIL”)을 사용해서 BOARD_DETAIL 테이블의 컬럼에 매핑하였다. title 필드처럼 테이블을 지정하지 않으면 기본 테이블인 BOARD에 매핑된다.

속성 기능 기본 값
name 매핑할 다른 테이블 이름
pkJoinColumns 매핑할 다른 테이블의 기본 키 컬럼 속성

더 많은 테이블을 매핑하려면 @SecondaryTables를 사용한다.

참조

https://cyr9210.github.io/2019/11/18/JPA/ORM-JPA07/