[JPA] Entity Mapping : 기본 키(PK) 매핑

기본 키(Primary Key)란?

기본 키(Primary Key)는 데이터베이스에서 테이블의 각 행을 고유하게 식별하는 열(또는 열의 집합)입니다.

 

즉, 기본 키는 중복된 데이터를 허용하지 않고, 각 행을 유일하게 식별할 수 있는 값으로 사용됩니다.

기본 키는 테이블의 모든 레코드에 대해 고유한 값을 가져야 하며, NULL 값을 가질 수 없습니다. - 무결성 제약 조건 중 기본 키 제약조건. 

 

기본 키 매핑

JPA를 사용한 기본 키 매핑 방법에 대해서 알아보겠습니다.

 

기본 키를 매핑하기 위해서는 기본 키를 설정할 클래스(Entity)의 필드에 @Id 어노테이션 붙혀주면 됩니다. 

 

기본 키를 할당하는 방법에는 여러가지 방식이 있습니다. 

 

1. 직접 할당하기

: 기본 키를 애플리케이션에서 직접 할당해주는 방식입니다.

식별자 값 없이 persist하게 되면 예외가 발생합니다.

 

2. 자동 할당하기 

: 대리 키 사용 방식이라고도 불리며 데이터베이스가 생성해주는 값을 사용합니다.

자동 할당 방식, 대리 키 사용방식 또한 여러가지 방법이 있습니다.

 

2-1. IDENTITY : 데이터베이스에서 기본 키 값을 생성해서 자동으로 할당하는 방식

2-2. SEQUENCE : 데이터베이스 시퀀스를 사용해서 기본 키 값을 자동으로 할당하는 방식

2-3. TABLE : 데이터베이스의 키 생성 테이블을 사용하여 기본 키 값을 자동으로 할당하는 방식.

 

하나씩 자세히 알아보겠습니다.

---

IDENTITY 전략

기본 키 값 생성을 데이터베이스에 위임하는 방식입니다. 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용합니다.

 

IDENTITY 전략을 사용하려면

1. 테이블 생성 시에 AUTO_INCREMENT 옵션을 추가해줘야 합니다.

create table Member (
	id int not null AUTO_INCREMENT PRIMARY KEY,
	name varchar(255)
);

 

2. 엔티티에는 PK에 매핑되는 필드에 @GeneratedValue의 strategy 속성 값을  GenerationType.IDENTITY로 지정해주어야 합니다.

@Entity
public class Member(
	
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    private String name;
    
}

IDENTITY 전략은 데이터베이스에 insert함과 동시에 기본키 값이 엔티티에 매핑되기 때문에 insert 한 이후 기본 키 값을 조회할 수 있습니다.
  
IDENTITY 전략에서는 예외적으로 트랜잭션을 커밋하지 않아도 em.persist(entity)를 호출하게 되면 insert SQL이 즉시 데이터베이스에 전달됩니다. (기본 키 값은 insert 하면서 동시에 생성)

즉, IDENTITY 전략에서는 영속성 컨텍스트의 쓰기지연 기능이 동작하지 않습니다.

IDENTITY 전략을 사용했을 때 매핑되는 기본키 값은 기본적으로 insert할 때마다데이터베이스를 조회해서 다음 기본 키 값을 파악하지만, JDBC3에 추가된 Statement.getGeneratedKeys()를 사용하면 데이터베이스에 데이터를 최초로 저장할 때 생성된 기본 키 값을 얻어 옴으로써 insert 할 때마다 데이터베이스와 연결하지 않고 최초 기본 키 값을 생성할 수 있습니다.

---

SEQUENCE 전략

데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트입니다. 

SEQUENCE 전략은 이 데이터베이스 오브젝트를 사용해서 기본 키를 생성합니다.

• 사용 가능 DB : Oracle, PostgreSQL, DB2, H2 

SEQUENCE 전략 사용 방법

1. 데이터베이스에 시퀀스를 생성합니다.

BOARD_SEQ 라는 이름으로 데이터베이스 시퀀스를 생성합니다

 

형식 : create sequence [sequnceName] start with [initialValue] increment by [allocationSize]

create sequence BOARD_SEQ START WITH 1 INCREMENT BY 1;

 

2. 사용할 데이터베이스 시퀀스를 매핑합니다.

@Entity
@SequenceGenerator(
        name = "BOARD_SEQ_GENERATOR",
        sequenceName = "BOARD_SEQ",
        initialValue = 1, allocationSize = 1)
public class Board {

    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE,
    				generator = "BOARD_SEQ_GENERATOR")
    private Long id;
    
    private String data;
    
    public Board() {
    }
}

- 여기서 name은 Sequence 가 아닌 Sequence Generator의 이름입니다. 

- initialValue : DDL 생성 시에만 사용되며, 시퀀스 DDL을 생성할 때 처음 시작하는 수

- allocationSize : 시퀀스 한번 호출에 증가하는 수로 성능 최적화에 사용됩니다 ( default : 50 )

 

- 사용할 기본 키에 @Id와 더불어 @GeneratedValue에 strategy 속성을 GenerationType.SEQUENCE로 지정해주고, generator 속성에 사용할 Sequence Generator의 이름을 반드시 매핑해 주어야합니다.

 

 

TestCode

public class Page_136 {
    public static void main(String[] args) {
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("hello");
        EntityManager em = emf.createEntityManager();
        EntityTransaction tx = em.getTransaction();

        tx.begin();

        Board board = new Board();
        board.setData("testData");
        em.persist(board);
        
        tx.commit();
        System.out.println("board.getId() = " + board.getId());

        em.close();
        emf.close();
    }
}

참고 : Domain에 setter, getter를 사용하는 것은 위험합니다. 실제 개발에서는 도메인, 엔티티에 getter, setter를 사용하지 않도록 합시다.

 

실행 후 H2 데이터베이스에서 BOARD_SEQ의 현재 값 / 코드 실행 로그

 

SEQUENCE 전략 최적화

SEQUENCE 전략은 데이터베이스 시퀀스를 통해 식별자를 조회하는 추가 작업이 필요합니다.

 

1. select BOARD_SEQ.NEXTVAL FROM DUAL

: 다음 식별자(기본키 값)을 구하기 위해 데이터베이스 시퀀스 조회

 

2. insert into board ...

: 조회한 시퀀스를 기본 키 값으로 사용해 데이터베이스에 저장 

 

insert 할 때 마다 이렇게 추가 작업이 이루어지면 성능 면에서 좋지 않겠죠?

 

JPA는 데이터베이스 시퀀스에 직접 접근하는 횟수를 줄이기 위해 @SequenceGenerator.allocationSize를 사용합니다. 

AllocationSize를 적절히 설정하여 성능을 최적화할 수 있습니다.

시퀀스를 한번 불러올 때 할당 범위만큼 메모리에 시퀀스 값을 할당하여, DB 시퀀스에 직접적으로 접근하지 않고 메모리에 접근하여 다음 식별자 값을 받아올 수 있습니다.

 

할당 범위를 크게 설정하면 시퀀스 값을 가져오는 빈도를 줄일 수 있지만, 시퀀스 값의 낭비가 발생할 수 있습니다.

할당 범위를 작게 설정하면 시퀀스 값의 낭비를 줄일 수 있지만 시퀀스 값을 가져오는 빈도가 증가하여 성능이 저하될 수 있습니다.

---

TABLE 전략

데이터베이스 시퀀스를 사용하는 방법과 유사합니다. 데이터베이스의 시퀀스 오브젝트처럼 데이터베이스의 테이블에 이름과 값으로 사용할 컬럼을 만들어 시퀀스를 흉내내는 전략입니다. 

 

사용 방법

 

1. 데이터베이스에 TABLE 전략으로 사용할 테이블을 생성합니다.

 

2. TABLE 전략으로 사용할 테이블을 엔티티에 매핑해줍니다.

@Entity
@TableGenerator(
        name = "BOARD_SEQ_GENERATOR",
        table = "my_sequence",
        pkColumnName = "BOARD_SEQ", allocationSize = 1)
public class Board {
    @Id
    @GeneratedValue(strategy = GenerationType.TABLE,
                    generator = "BOARD_SEQ_GENERATOR")
    private Long id;
    private String data;

    public Board() {
    }

    public String getData() {
        return data;
    }

    public void setData(String data) {
        this.data = data;
    }

    public Long getId() {
        return id;
    }
}

- name은 시퀀스 전략과 마찬가지로 table_generator의 이름입니다.

- table에 1에서 생성한 테이블을 매핑해줍니다.

- pkColumnName은 시퀀스 컬럼명으로 "sequence_name"이 default값으로 설정되어 있습니다.

 

• 1에서 테이블을 생성할 때 sequence_name으로 지정했던 컬럼이 BOARD_SEQ으로 바뀐 것을 확인할 수 있습니다.

 

마찬가지로 테스트 코드를 실행해보면 

기본 키 값이 증가된 것을 확인할 수 있습니다.

---

AUTO 전략

데이터베이스 종류에 따라 IDENTITY 전략, SEQUENCE 전략, TABLE 전략 중 자동으로 선택해서 기본 키를 선택하는 전략입니다.

 

사용 방법

@GeneratedType(strategy = GenerationType.Auto)로 설정

 

Auto 전략을 사용하게 되면 시퀀스나 테이블 전략이 선택될 수도 있으므로 시퀀스나 키 생성용 테이블을 미리 만들어 두어야 합니다.

이 귀찮은 일을 하이버네이트가 기본값을 사용해서 적절한 시퀀스나 키 생성용 테이블을 만들어줍니다.

 

키 생성 전략이 확정되지 않은 개발 초기 단계나 프로토타입 개발 시 편리하게 사용 가능!

---

 

<정리>

• 직접 할당 : em.persist()를 호출하기 전에 기본 키를 할당해주는 방식
• sequence 전략 : 데이터베이스 시퀀스 오브젝트에서 식별자 값을 획득하여 영속성 컨텍스트에 저장하는 방식
• table 전략 : 데이터베이스 시퀀스 생성용 테이블에서 식별자 값을 획득해 영속성 컨텍스트에 저장하는 방식
• identity 전략 : 데이터베이스에 엔티티를 저장해서 식별자 값을 획득한 후 영속성 컨텍스트에 저장하는 방식
  • 예외적으로 저장(persist)과 동시에 insert SQL 이 DB에 전달 되므로 쓰기 지연 기능이 동작하지 않습니다

Tip : 기본 키를 설정할 때에는 비즈니스에 의미가 있는 자연 키를 선택하기보다 관련없는 임의의 키를 설정하도록 합시다.

why ? 비즈니스에 의미가 있는 자연 키는 언제든지 변경될 수 있기 때문에.

---

<참고자료>

• 자바 ORM 표준 JPA 프로그래밍, 김영한