JPA 고급매핑 (3)

복합키 식별 관계 매핑

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

@IdClass

@Entity
@Data
public class Parent {
  @Id
  @Column(name = "PARENT_ID")
  private String id;

  private String name;

}

@Entity
@Data
@IdClass(ChildId.class)
public class Child {
  @Id
  @ManyToOne
  @JoinColumn(name = "PARENT_ID")
  private Parent parent;

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

  private String name;
}

@Data
public class ChildId implements Serializable {

  private String parent;
  private String childId;
}

@Entity
@Data
@IdClass(GrandChildId.class)
public class CrandChild {
  @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;
}

@Data
public class GrandChildId implements Serializable{
  private ChildId child;
  private String id;
}

식별 관계는 기본 키와 외래 키를 같이 매핑 해야 한다. 따라서 식별자 매핑인 @Id와 연관관계 매핑인 @ManyToOne을 같이 사용하면 된다.

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

Child 엔티티의 Parent 필드를 보면 @Id로 기본 키를 매핑하면서 @ManyToOne과 @JoinColumn으로 외래 키를 같이 매핑한다.

EmbeddedId와 식별 관계

@Entity
@Data
public class Parent {
  @Id
  @Column(name = "PARENT_ID")
  private String id;

  private String name;

}

@Entity
@Data
public class Child {

  @EmbeddedId
  private ChildId id;

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

  private String name;
}

@Data
@Embeddable
public class ChildId implements Serializable {

  private String parentId; //@MapsId("parentId") 로 매핑
  private String childId;
}

@Entity
@Data
public class CrandChild {

  @EmbeddedId
  private GrandChildId id;

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

  private String name;
}

@Data
@Embeddable
public class GrandChildId implements Serializable{
  private ChildId childId; //@MapsId("childId") 로 매핑

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

@EmbeddedId는 식별 관계로 사용할 연관관계의 속성에 @MapsId를 사용하면 된다. Child 엔티티 parent 필드를 보자

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

@IdClass와 다른 점은 @Id 대신에 @MapsId를 사용한 점이다. @MapsId는 외래 키와 매핑한 연관관계를 기본 키에도 매핑하겠다는 뜻이다. @MapsId의 속성 값은 @EmbeddedId를 사용한 식별자 클래스의 기본 키 필드를 지정하면 된다. 여기서는 ChildId의 parentId 필드를 선택했다.

비식별 관계로 구현

@Data
@Entity
public class Parent {
  @Id
  @GeneratedValue
  @Column(name = "PARENT_ID")
  private Long id;

  private String name;
}

@Entity
@Data
public class Child {

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

  private String name;

  @ManyToOne
  @JoinColumn(name = "PARENT_ID")
  private Parent parent;
}

@Data
@Entity
public class GrandChild {

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

  private String name;

  @ManyToOne
  @JoinColumn(name = "CHILD_ID")
  private Child child;
}

식별 관계의 복합 키를 사용한 코드와 비교하면 매핑도 쉽고 코드도 단순하다. 그리고 복합 키가 없으므로 복합 키 클래스를 만들지 않아도 된다.

일대일 식별 관계

일대일 식별관계는 자식 테이블의 기본 키 값으로 부모테이블의 기본 키 값만 사용한다. 그래서 부모 테이블의 기본 키가 복합 키가 아니면 자식 테이블의 기본 키는 복합 키로 구성하지 않아도 된다.

@Entity
@Data
public class Board {

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

  private String title;

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

}

@Entity
@Data
public class BoardDetail {

  @Id
  private Long boardId;

  @MapsId
  @OneToOne
  @JoinColumn(name = "BOARD_ID")
  private Board board;

  private String content;
}

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

private static void save(EntityManager entityManager){
  Board board = new Board();
  board.setTitle("제목");
  entityManager.persist(board);

  BoardDetail boardDetail = new BoardDetail();
  boardDetail.setContent("내용");
  boardDetail.setBoard(board);
  entityManager.persist(boardDetail);
}

위의 코드는 일대일 식별 관계를 저장 하는 코드이다.

식별, 비 식별 관계의 장단점

데이터베이스 설계 관점에서 보면 다음과 같은 이유로 식별 관계보다 비식별 관계를 선호한다.
1. 식별 관계는 부모 테이블의 기본 키를 자식 테이블로 전파하면서 자식 테이블의 기본 키 컬럼이 점점 늘어난다. 그러면 조인할 때 SQL이 복잡해지고 기본 키 인덱스가 불필요하게 커질 수 있다.
2. 식별 관계는 2개 이상의 컬럼을 합해서 복합 기본 키를 만들어야 하는 경우가 많다.
3. 식별 관계를 사용할 때 기본 키로 비지니스 의미가 있는 자연 키 컬럼을 조합하는 경우가 많다. 반면에 비식별관계의 기본 키는 비지니스와 전혀 관계없는 대리 키를 주로 사용한다. 언제든지 요구사항은 변한다. 식별 관걔의 자연 키 컬럼들이 자식에 손자까지 전파되면 변경하기 힘들다.
4. 식별 관계는 부모 테이블의 기본 키를 자식 테이블의 기본 키로 사용하므로 비식별 관계보다 테이블 구조가 유연하지 못하다.

이외에도 몇가지가 더 있다. 하지만 무조건 식별관계가 단점만 있는 것은 아니다. 기본 키 인덱스를 활용하기 좋고, 상위 테이블들의 기본 키 컬럼을 자식, 손자 테이블들이 가지고 있으므로 특정 상황에 조인 없이 하위 테이블만으로 검색을 완료 할 수 있다.

이상으로 식별 비식별 관계에 대해 알아봤다. 다음은 고급매핑 마지막으로 조인 테이블에 대해서 알아보자!

출처 : 자바 ORM 표준 JPA 프로그래밍 (김영한)

JPA 고급매핑 (2)

복합 키와 식별 관계 매핑

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

식별 관계

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

비식별 관계

비식별 관계는 부모 테이블의 기본 키를 받아서 자식 테이블의 외래 키로만 사용하는 관계이다.
– 필수적 비식별 관계 : 외래 키에 null을 허용하지 않는다. 연관관계를 필수적으로 맺어야 한다.
– 선택적 비식별 관계 : 외래 키에 null을 허용한다. 연관관계를 맺을지 말지 선택 할 수 있다.

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

@IdClass

복합 키 테이블은 비식별 관계고 PARENT는 복합 기본 키를 사용한다. 참고로 여기서 이야기하는 부모 자식은 객체의 상속과는 무관하다.

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

  @Id
  @Column(name = "PARENT_ID1")
  private String id1;

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

  private String name;
}

@Data
public class ParentId implements Serializable{

  private String id1;

  private String id2;
}

각각의 기본 키 컬럼을 @Id로 매핑했다. 그리고 @IdClass를 사용해서 ParentId 클래스를 식별자 클래스로 지정했다.
@IdClass를 사용할 때 식별자 클래스는 다음 조건을 만족해야 한다.
1. 식별자 클래스의 속성명과 엔티티에서 사용하는 식별자의 속성명이 같아야 한다. Parent.id1과 ParentId.id1, 그리고 Parent.id2과 ParentId.id2 가 같다.
2. Serializable를 구현해야 한다.
3. equals, hashCode를 구현해야 한다.
4. 기본 생성자가 있어야 한다.
5. 식별자 클래스는 public 이어야 한다.

아래 코드를 보자

public static void save(EntityManager entityManager){
  Parent parent = new Parent();
  parent.setId1("id1");
  parent.setId2("id2");
  parent.setName("name");
  entityManager.persist(parent);
}

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

private static void find(EntityManager entityManager) {
  ParentId parentId = new ParentId();
  parentId.setId1("id1");
  parentId.setId2("id2");
  Parent parent = entityManager.find(Parent.class, parentId);
  System.out.println(parent);
}

조회 코드를 보면 식별자 클래스인 ParentId를 사용해서 엔티티를 조회한다. 자식 클래스를 추가해보자

@Entity
@Data
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가 데이터베이스에 맞춘 방법이라면 @EmbeddedId는 좀더 객체지향적인 방법이다.

@Entity
@Data
public class Parent {

  @EmbeddedId
  private ParentId id;

  private String name;

}

@Data
@Embeddable
public class ParentId implements Serializable {

  @Column(name = "PARENT_ID1")
  private String id1;

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

Parent 엔티티에서 식별자 클래스를 직접 사용하고 @EmbeddedId 어노테이션을 적어주면 된다. IdClass와는 다르게 @EmbeddedId를 적용한 식별자 클래스는 식별자 클래스에 기본 키를 직접 매핑한다.
@EmbeddedId를 적용한 식별자 클래스는 다음 조건을 만족해야 한다.
1. @Embeddable 어노테이션을 붙여주어야 한다.
2. Serializable를 구현해야 한다.
3. equals, hashCode를 구현해야 한다.
4. 기본 생성자가 있어야 한다.
5. 식별자 클래스는 public 이어야 한다.

public static void save(EntityManager entityManager) {
  Parent parent = new Parent();
  ParentId parentId = new ParentId();
  parentId.setId1("id1");
  parentId.setId2("id2");
  parent.setId(parentId);
  parent.setName("wonwoo");
  entityManager.persist(parent);
}

저장하는 코드를 보면 식별자 클래스 ParentId를 직접 생성해서 사용한다. 엔티티를 조회해보자.

private static void find(EntityManager entityManager) {
  ParentId parentId = new ParentId();
  parentId.setId1("id1");
  parentId.setId2("id2");
  Parent parent = entityManager.find(Parent.class, parentId);
  System.out.println(parent);
}

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

@IdClass vs @EmbeddedId

@IdClass 와 @EmbeddedId는 각각 장담점이 있으므로 본인의 취향에 맞는 것을 일관성 있게 사용하면 된다. @EmbeddedId가 @IdClass와 비교해서 더 객체지향적이고 중복도 없어서 좋아보이긴 하지만 특정 상황에 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를 사용 할 수 없다. 복합 키를 구성하는 여러 컬럼 중 하나에도 사용 할 수 없다.

출처 : 자바 ORM 표준 JPA 프로그래밍 (김영한)

JPA 고급매핑 (1)

상속 관계 매핑

관계형 데이터베이스에는 객체지향 언어에서 다루는 상속이라는 개념이 없다. 대신 슈퍼타입 서브타입 관계라는 모델링 기법이 객체의 상속 개념과 가장 유사하다.
슈퍼타입 서브타입 논리 모델을 실제 물리 모델인 테이블로 구현할 때는 3가지 방법을 선택할 수 있다.
1. 각각의 테이블로 변환 : 각각을 테이블로 만들고 조회 할 때 조인을 사용한다. JPA에서는 조인 전략이라 한다.
2. 통합 테이블로 변환 : 테이블을 하나만 사용해서 통합한다. JPA에서는 단일 테이블 전략이라 한다.
3. 서브타입 테이블로 변환 : 서브타입마다 하나의 테이블을 만든다. JPA에서는 구현 클래스마다 테이블 전략이라 한다.

조인 전략

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

  @Id
  @GeneratedValue
  private Long id;

  private String name;

  private int price;

}

@Entity
@DiscriminatorValue("A")
@Data
public class Album extends Item {
  private String artist;
}

@Entity
@Data
@DiscriminatorValue("B")
@PrimaryKeyJoinColumn(name = "BOOK_ID")
public class Book extends Item {

  private String author;
  private String isbn;
}

@Entity
@DiscriminatorValue("M")
@Data
public class Movie extends Item {
  private String director;

  private String actor;

}

@Inheritance(strategy = InheritanceType.JOINED) : 상속 매핑은 부모 클래스에 Inheritance를 사용해야 한다. 매핑 전략은 조인전략을 사용하므로 InheritanceType.JOINED 을 사용하였다.
@DiscriminatorColumn(name = “DTYPE”) : 부모 클래스에 구분 컬림이다. 이 컬럼으로 저장된 자식 테이블을 구분 할 수 있다. 기본값은 DTYPE이다.
@DiscriminatorValue(“A”) : 엔티티를 저장할 때 구분컬럼에 입력할 값을 지정한다.
@PrimaryKeyJoinColumn(name = “BOOK_ID”) : 자식 테이블은 부모 테이블 ID 컬럼명을 그대로 사용하는데 만약 자식 테이블의 기본키를 변경하고 싶을 때 사용하면 된다.

  • 장점
    테이블이 정규화된다.
    외래 키 참조 무결성 제약조건을 활용 할 수 있다.
    저장 공간을 효율적으로 사용한다.
  • 단점
    조회 할 때 조인이 많이 사용되므로 성능이 저하 될 수 있다.
    조회쿼리가 복잡하다.
    데이터들 등록할 때 insert 쿼리는 두번 날려야한다.

단일 테이블 전략

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

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

  private String name;

  private int price;

}

@Entity
@DiscriminatorValue("A")
@Data
public class Album extends Item {
  private String artist;
}

@Entity
@Data
@DiscriminatorValue("B")
@PrimaryKeyJoinColumn(name = "BOOK_ID")
public class Book extends Item {

  private String author;
  private String isbn;
}

@Entity
@DiscriminatorValue("M")
@Data
public class Movie extends Item {
  private String director;

  private String actor;

}

딱히 소스를 수정할 필요는 없고 @Inheritance(strategy = InheritanceType.SINGLE_TABLE) 어노테이션의 값만 바꾸면 된다. 그러면 테이블이 한개만 생긴다.
주의할 점은 자식 엔티티가 매핑한 컬럼은 모두 null을 허용 해야 한다는 점이다.

  • 장점
    조인이 필요 없으므로 일반적으로 조회 성능이 빠르다.
    조회 쿼리가 단순하다.
  • 단점
    자식 엔티티가 매핑한 컬럼은 모두 null을 허용해야 한다.
    단일 테이블에 모든 것이 저장 하므로 테이블이 커질 수 있다. 그러므로 상황에 따라서는 조회 성능이 오히려 느려질 수 있다.
  • 특징
    구분 컬럼을 꼭 사용해야 한다. 따라서 @DiscriminatorColumn을 꼭 설정해야 한다.
    @DiscriminatorValue를 지정하지 않으면 기본으로 엔티티 이름을 사용한다. 예) Movie, Album, Book

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

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

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

  private String name;

  private int price;

}

@Entity
@Data
public class Album extends Item {
  private String artist;
}

@Entity
@Data
public class Book extends Item {

  private String author;
  private String isbn;
}

@Entity
@Data
public class Movie extends Item {
  private String director;

  private String actor;

}

이 전략 또한 어노테이션의 값만 바꾸면 된다. 이 전략은 구현 클래스마다 테이블 전략을 사용한다. 자식 엔티티마다 테이블을 만든다. 일반적으로는 추천하지 않는다.

  • 장점
    서브 타입을 구분해서 처리할 때 효과적이다.
    not null 제약 조건을 사용할 수 있다.
  • 단점
    여러 자식 테이블을 함께 조회할 때 성능이 느리다(SQL에 UNION을 사용해야 한다.).
    자식 테이블을 통합해서 쿼리하기 어렵다.
  • 특징
    구분 컬럼을 사용하지 않는다.

@MappedSuperclass

상속 관계 매핑은 부모 클래스와 자식 클래스를 모두 데이터베이스 테이블과 매핑했다. 부모 클래스는 테이블과 매핑하지 않고 부모 클래스를 상속받는 자식 클래스에게 매핑 정보만 제공하고 싶으면 @MappedSuperclass를 사용하면 된다.
@MappedSuperclass는 비유를 하자면 추상 클래스와 비슷한데 @Entity는 실제 테이블과 매핑되지만 @MappedSuperclass는 실제 테이블과 매핑 되지 않는다. 단순한 상속 목적으로 사용한다.

@MappedSuperclass
@Data
public abstract class BaseEntity {
  @Id
  @GeneratedValue
  private Long id;
  private String name;
}

@Entity
@Data
public class Member extends BaseEntity {

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

@Entity
@Data
public class Seller extends BaseEntity {

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

BaseEntity에는 객체들이 주로 사용하는 공통 매핑 정보를 정의했다. 그리고 자식 엔티티들은 상속을 통해 BaseEntity의 매핑 정보를 물려받았다. 여기서 BaseEntity는 테이블과 매핑할 필요가 없고 자식 엔티티에게 공통으로 사용되는 매핑 정보만 제공하면 된다.
만약 부모로 부터 물려 받은 매핑 정보를 재정의 하려면 @AttributeOverrides나 @AttributeOverride를 사용하고 연관관계를 재정의하려면 @AssociationOverrides나 @AssociationOverride를 사용하면 된다.

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

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

물려받은 id 속성을 MEMBER_ID로 재정의 했다.

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

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

만약 둘이상을 재정의하려면 @AttributeOverrides 사용하면 된다.

  • 특징
    테이블과 매핑되지 않고 자식 클래스에 엔티티의 매핑 정보를 상속하기 위해 사용한다.
    @MappedSuperclass로 지정한 클래스는 엔티티가 아니므로 find()나 JPQL에서 사용 할 수 없다.
    이 클래스를 직접 생성해서 사용할 일은 거의 없으므로 추상 클래스로 만드는 것을 권장한다.

마지막으로 정리를 하자만 @MappedSuperclass는 테이블과는 관계가 없고 단순히 엔티티가 공통으로 사용하는 매핑 정보를 모아주는 역할을 할 뿐이다. ORM에서 이야기하는 진정한 상속 매핑은 이전에 학습한 객체 상속을 데이터베이스의 슈퍼타입 서브타입 관계와 매핑 하는 것이다.
@MappedSuperclass를 사용하면 등록일자, 수정일자, 등록자, 수정자 같은 여러 엔티티에서 공통으로 사용하는 속성을 효과적으로 관리 할 수 있다.

엔티티(@Entity)는 엔티티(@Entity) 이거나 @MappedSuperclass 지정한 클래스만 상속 받을 수 있다.

이것으로 상속관계 매핑에 대해서 알아 봤다.

출처 : 자바 ORM 표준 JPA 프로그래밍 (김영한)