이 글은 김영한 님의 저서 「자바 ORM 표준 JPA 프로그래밍」을 학습한 내용을 정리한 글입니다. 모든 출처는 해당 저서에 있습니다.
객체의 상속 관계를 데이터베이스에 어떻게 매핑할 것인가
엔티티 각각을 모두 테이블로 만들고 자식 테이블이 부모 테이블의 기본 키를 받아서 기본 키 + 외래 키로 사용하는 전략
/**
* 상품
*/
@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; //배우
}
@Inheritance
strategy = InheritanceType.JOINED
→ 매핑 전략으로 조인 전략 사용@DiscriminatorColumn
DTYPE
@DiscriminatorValue
: 엔티티 저장 시 구분 컬럼에 입력할 값 지정@DiscriminatorValue("M")
→ 영화 엔티티 저장 시 구분 컬럼인 DTYPE
에 값 M 저장@PrimaryKeyJoinColumn
→ 자식 테이블의 기본 키 컬럼명 변경@Entity
@DiscriminatorValue("B")
@PrimaryKeyJoinColumn(name = "BOOK_ID") //ID 재정의
public class Book extends Item {
private String author; //작가
private String isbn; //ISBN
...
}
@PrimaryKeyJoinColumn
@DiscriminatorColumn
@DiscriminatorValue
테이블을 하나만 사용하는 전략
null
허용 필수Book
엔티티 저장 시ITEM
테이블의 AUTHOR
, ISBN
컬럼만 사용ARTIST
, DIRECTOR
, ACTOR
컬럼 사용 x → 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("A")
public class Album extends Item { ... }
/**
* 영화
*/
@Entity
@DiscriminatorValue("M")
public class Movie extends Item { ... }
/**
* 책
*/
@Entity
@DiscriminatorValue("B")
public class Book extends Item { ... }
null
허용 필수@DiscriminatorColumn
설정 필수@DiscriminatorValue
지정 x → 엔티티 이름 기본 사용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
@DiscriminatorValue("A")
public class Album extends Item { ... }
/**
* 영화
*/
@Entity
@DiscriminatorValue("M")
public class Movie extends Item { ... }
/**
* 책
*/
@Entity
@DiscriminatorValue("B")
public class Book extends Item { ... }
not null
제약조건 사용 가능@MappedSuperclass
부모 클래스는 테이블과 매핑하지 않고 부모 클래스를 상속받는 자식 클래스에게 매핑 정보만 제공하고 싶을 때 사용하는 어노테이션
@MappedSuperclass
매핑@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;
...
}
BaseEntity
@MappedSuperclass
사용애노테이션 | 설명 |
---|---|
@AttributeOverrides ,@AttributeOverried | 부모로부터 물려받은 매핑 정보 재정의 |
@AssociationOverrides ,@AssociationOverride | 연관관계 재정의 |
@AttributeOverride
@Entity
@AttributeOverride(name = "id", column = @Column(name = "MEMBER_ID"))
public class Member extends BaseEntity { ... }
@AttributeOverrides
@Entity
@AttributeOverrides({
@AttributeOverride(name = "id", column = @Column(name = "MEMBER_ID")),
@AttributeOverride(name = "name", column = @Column(name = "MEMBER_NAME"))
})
public class Member extends BaseEntity { ... }
@MappedSuperclass
로 지정한 클래스는 엔티티가 아님em.find()
나 JPQL
에서 사용 불가능💡 참고
@MappedSuperclass
를 사용하면 등록일자, 수정일자, 등록자, 수정자 같은 여러 엔티티에서 공통으로 사용하는 속성을 효과적으로 관리할 수 있다.
💡 참고
엔티티(
@Entity
)는 엔티티(@Entity
)이거나@MappedSuperclass
로 지정한 클래스만 상속받을 수 있다.
부모 테이블의 기본 키를 내려받아서 자식 테이블의 기본 키 + 외래키로 사용하는 관계
부모 테이블의 기본 키를 받아서 자식 테이블의 외래 키로만 사용하는 관계
외래 키 NULL
허용 여부에 따라 구분 됨
구분 | NULL 허용 여부 | 연관관계 맺기 |
---|---|---|
필수적 비식별 관계 (Mandatory) | 불허 | 필수 |
선택적 비식별 관계 (Optional) | 허용 | 선택 |
💡 참고
- 데이터베이스 테이블 설계 시 식별 관계와 비식별 관계 중 하나를 선택해야 함
- 최근에는 비식별 관계를 주로 사용하고, 꼭 필요한 곳에만 식별 관계를 사용하는 추세임
- JPA는 식별 관계와 비식별 관계 모두 지원함
@IdClass
PARENT
→ 복합 키 사용@Entity
@IdClass(ParentId.class) //ParentId 클래스를 식별자 클래스로 지정
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.id1
와 ParentId.id1
, Parent.id2
와 ParentId.id2
Serializable
인터페이스를 구현해야 함equals
, hashCode
구현해야 함public
이어야 함Parent parent = new Parent();
parent.setId1("myId1"); //식별자
parent.setId2("myId2"); //식별자
parent.setName("parentName");
em.persist(parent);
em.persist()
를 호출하면, 영속성 컨텍스트에 엔티티를 등록하기 직전에 내부에서 Parent.id1
, Parent.id2
값을 사용하여 식별자 클래스인 ParentId
를 생성하고 영속성 컨텍스트의 키로 사용함ParentId parentId = new ParentId("myId1", "myId2");
Parent parent = em.find(Parent.class, parentId);
ParentId
를 사용하여 엔티티 조회@Entity
public class Child {
@Id
private String id;
@ManyToOne
@JoinColumns ({ //외래 키 여러개 매핑
@JoinColumn(name = "PARENT_ID1", referencedColumnName = "PARENT_ID1"),
// ↑ @JoinColumn(name = "PARENT_ID1")과 같음
@JoinColumn(name = "PARENT_ID2", referencedColumnName = "PARENT_ID2")
}) //@JoinColumn으로 각각의 외래 키 매핑
private Parent parent;
}
@JoinColumn
의 name
속성과 referencedColumnName
속성 값이 같을 경우, referencedColumnName
생략 가능@EmbeddedId
@Entity
public class Parent {
@EmbeddedId
private ParentId id;
private String name;
...
}
@Embeddable
public class ParentId implements Serializable {
//식별자 클래스에 기본 키 직접 매핑
@Column(name = "PARENT_ID1")
private String id1;
@Column(name = "PARENT_ID2")
private String id2;
//equals and hashCode 구현
...
}
@EmbeddedId
사용 시 식별자 클래스가 만족해야 하는 조건들@Enbeddable
어노테이션을 붙여주어야 함Serializable
인터페이스를 구현해야 함equals
, hashCode
를 구현해야 함public
이어야 함Parent parent = new Parent();
//식별자 클래스 `ParentId`를 직접 생성하여 사용
ParentId parentId = new ParentId("myId1", "myId2");
parent.setId(parentId);
parent.setName("parentName");
em.persist(parent);
//식별자 클래스 parentId를 직접 사용하여 조회
ParentId parentId = new ParentId("myId1", "myId2");
Parent parent = em.find(Parent.class, parentId);
equals()
, hashCode()
equals()
와 hashCode()
를 필수로 구현해야 함equals()
와 hashCode()
를 사용equals
비교)이 지켜지지 않으면 영속성 컨텍스트가 엔티티를 관리하는 데 심각한 문제가 발생하게 됨equals()
와 hashCode()
를 구현할 때 모든 필드를 사용함@IdClass
vs @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
를 사용할 수 없다.
@IdClass
와 식별 관계@IdClass
로 식별 관계 매핑/*
** 부모
*/
@Entity
public class Parent {
@Id @Column(name = "PARENT_ID")
privte 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 childId; //GrandChild.child 매핑
private String id; //GrandChild.id 매핑
//equals, hashCode
...
}
@Id
와 @ManyToOne
을 사용하여 식별자 및 연관관계 매핑@EmbeddedId
와 식별 관계@EmbeddedId
로 식별 관계 매핑/*
** 부모
*/
@Entity
public class Parent {
@Id @Column(name = "PARENT_ID")
privte String id;
private String name;
...
}
/*
** 자식
*/
@Entity
public class Child {
@EmbeddedId
private ChildId id;
@MapsId("parentID") //ChildId.parentId 매핑
@ManyToOne
@JoinColumn(name = "PARENT_ID")
public Parent parent;
private String name;
...
}
/*
** 자식 ID
*/
@Embeddable
public class ChildId implements Serializable {
private String parentId; //@MapsId("parentId")로 매핑
@Column(name = "CHILD_ID")
private String id;
//equals, hashCode
...
}
/*
** 손자
*/
@Entity
public class GrandChild {
@EmbeddedId
private GrandChild id;
@MapsId("childID") //GrandChildId.childId 매핑
@ManyToOne
@JoinColumns({
@JoinColumn(name = "PARENT_ID"),
@JoinColumn(name = "CHILD_ID")
})
private Child child;
private String name;
}
/*
** 손자 ID
*/
@Embeddable
public class GrandChildId implements Serializable {
private ChildId childId; //@MapsId("childId")로 매핑
@Column(name = "GRANDCHILD_ID")
private String id;
//equals, hashCode
...
}
@MapsId
사용@MapsId
@EmbeddedId
를 사용한 식별자 클래스의 기본 키 필드 지정/*
** 부모
*/
@Entity
public class Parent {
@Id @GeneratedValue
@Column(name = "PARENT_ID")
privte 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")
public Parent parent;
...
}
/*
** 손자
*/
@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
public class Board {
@Id @GeneratedValue
@Column(name = "BOARD_ID")
privte Long id;
private String title;
@OneToOne(mappedBy = "board")
private BoardDetail boardDetail;
...
}
/*
** 자식
*/
@Entity
public class BoardDetail {
@Id
private Long boardId;
@MapsId //BoardDetail.boardId 매핑
@OneToOne
@JoinColumn(name = "Board_ID")
public Board board;
private String content;
...
}
public void save() {
Board board = new Board();
board.setTitle("제목");
em.persist(board);
BoardDetail boardDetail = new BoardDetail();
boardDetail.setContent("내용");
boardDetail.setBoard(board);
em.persist(boardDetail);
}
데이터베이스 설계 관점
객체 관계 매핑 관점
@GeneratedValue
위와 같은 이유들로 식별 관계보다는 비식별 관계를 선호함
CHILD
테이블의 기본 키 인덱스를 PARENT_ID
+ CHILD_ID
로 구성되도록 비식별 관계를 사용하고 기본 키는 Long
타입의 대리 키를 사용하도록 한다.
Long
타입은 데이터의 저장 가능 범위가 매우 크므로 데이터 저장시 문제 발생의 소지가 줄어듦선택적 비식별 관계보다는 필수적 비식별 관계를 사용하도록 한다.
NULL
허용 → 외부 조인NOT NULL
→ 내부 조인MEMBER
테이블의 LOCKER_ID
외래 키에 null
을 입력해두어야 함null
로 저장되는 경우 존재MEMBER_LOCKER
) 추가하여 두 테이블의 외래 키로 연관관계 관리MEMBER
와 LOCKER
에 외래 키 컬럼 존재 xMEMBER_LOCKER
테이블에 값만 추가하면 됨기본은 조인 컬럼을 사용하고, 필요하다고 판단될 경우 조인 테이블 사용하도록 한다.
객체와 테이블 매핑시 사용하는 애노테이션은 다음과 같다.
@JoinColumn
@JoinTable
조인 테이블은 주로 다대다 관계를 일대다, 다대일 관계로 풀어내기 위해 사용하며, 그 외 일대일, 일대다, 다대일 관계에서도 사용한다.
PARENT_ID
는 기본 키이므로 유니크 제약조건이 걸려 있음/*
** 부모
*/
@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;
...
//양방향으로 매핑하고 싶은 경우 다음 코드 추가
@OneToOne(mappedBy = "child")
private Parent parent;
}
CHILD_ID
에 유니크 제약조건 형성CHILD_ID
는 기본키이므로 유니크 제약조건이 걸려있는 상태/*
** 부모
*/
@Entity
public class Parent {
@Id @GeneratedValue
@Column(name = "PARENT_ID")
private Long id;
private String name;
@OneToMany
@JoinTable(
name = "PARENT_CHILD",
joinColumns = @JoinColumn(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>();
...
}
/*
** 자식
*/
@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;
...
}
PARENT_ID
, CHILD_ID
가 복합 기본 키로 유니크 제약 조건이 이미 걸려 있는 상태/*
** 부모
*/
@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>();
...
}
/*
** 자식
*/
@Entity
public class Child {
@Id @GeneratedValue
@Column(name = "CHILD_ID")
private Long id;
private String name;
...
}
💡 참고
조인 테이블에 컬럼을 추가하면
@JoinTable
전략을 사용할 수 없으므로, 새로운 엔티티를 만들어 조인 테이블과 매핑해야 함
@Entity
@Table(name = "BOARD") //BOARD 테이블과 매핑
@SecondaryTable( // BOARD_DETAIL 테이블 추가 매핑
name = "BOARD_DETAIL",
pkJoinColumns = @PrimaryKeyJoinColumn(name = "BOARD_DETAIL_ID")
)
public class Board {
@Id @GeneratedValue
@Column(name = "BOARD_ID")
private Long id;
private String title;
//BOARD_DETAIL 테이블의 컬럼과 매핑
//테이블 미지정 시 기본 테이블인 BOARD에 매핑
@Column(table = "BOARD_DETAIL")
private String content;
...
}
@SecondaryTable
: 테이블 한 개 추가 매핑
속성 | 설명 |
---|---|
name | 매핑할 다른 테이블의 이름 |
pkJoinColumns | 매핑할 다른 테이블의 기본 키 컬럼 속성 |
@SecondaryTables
: 테이블 여러개 추가 매핑
💡 참고
- 엔티티 하나에 여러 테이블을 매핑하는 방법은 항상 두 테이블을 조회하므로 최적화하기 어려움
- 일대일 매핑은 원하는 부분만 조회 가능하며, 필요시 함께 조회하면 됨
∴
@SecondaryTable
을 이용한 매핑보다 일대일 매핑 권장