엔티티 매핑

1. Entity

@Entity : @Entity가 붙은 클래스는 JPA가 관리하는 것으로, 엔티티라고 부름.

속성

• name: JPA에서 사용할 엔티티 이름 지정

주의사항

• 기본 생성자는 필수
• final 클래스, enum, interface, inner 클래스에는 사용할 수 없음
• 저장할 필드에 final을 사용하면 안 됨

2. Table

@Table: 엔티티와 매핑할 테이블 지정

속성

• name: 매핑할 테이블 이름, 기본값은 엔티티 이름
• catalog: catalog 기능이 있는 데이터베이스에서 catalog 매핑
• schema: schema 기능이 있는 데이터베이스에서 schema 매핑
• uniqueConstraints: DDL 생성 시에 유니크 제약조건 만듦

3. 데이터베이스 스키마 자동 생성

<property name="hibernate.hbm2ddl.auto" value="create" />

• 이 속성을 추가하면 애플리케이션 실행 시점에 데이터베이스 테이블을 자동으로 생성
• hibernate.hbm2ddl.auto 속성
  • create: 테이블 삭제하고 새로 생성, DROP + CREATE
  • create-drop: create 속성에 추가로 애플리케이션을 종료할 때 생성한 DDL 제거, DROP + CREATE + DROP
  • update: 데이터베이스 테이블과 엔티티 매핑정보를 비교해서 변경 사항만 수정
  • validate: 데이터베이스 테이블과 엔티티 매핑정보를 비교해서 차이가 잇으면 경고를 남기고 애플리케이션을 실행하지 않음. 이 설정은 DDL을 수정하지 않음.
  • none: 자동 생성 기능을 사용하지 않으려면 속성 자체를 삭제하거나 유효하지 않은 옵션 값을 주면 됨.

HBM2DDL 주의사항

• 개발 초기 단계: create or update
• 초기화 상태로 자동화된 테스트를 진행하는 개발자 환경과 CI 서버: create or create-drop
• 테스트 서버: update or validate
• 스테이징과 운영 서버: validate or none

4. 기본 키 매핑

JPA가 제공하는 데이터베이스 기본 키 생성 전략

• 직접 할당: 기본 키를 애플리케이션에서 직접 할당
• 자동 생성: 대리 키 사용 방식
  • IDENTITY: 기본 키 생성을 데이터베이스에 위임
  • SEQUENCE: 데이터베이스 시퀀스를 사용해서 기본 키 할당
  • TABLE: 키 생성 테이블 사용

기본 키 직접 할당 전략

@Id로 매핑

• 적용 가능 자바 타입
  • 자바 기본형
  • 자바 래퍼(Wrapper)형
  • String
  • java.util.Date
  • java.sql.Date
  • java.math.BigDecimal
  • java.math.BigInteger

IDENTITY 전략

• 기본 키 생성을 데이터베이스에 위임하는 전략
• ex) MySQL의 AUTO_INCREMENT
• 엔티티를 데이터베이스에 저장한 후에 식별자를 조회해서 엔티티의 식별자에 할당

SEQUENCE 전략

• 데이터베이스 시퀀스: 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트
• 데이터베이스 시퀀스를 사용해서 식별자 조회 ➡️ 조회한 식별자를 엔티티에 할당한 후에 엔티티를 영속성 컨텍스트에 저장 ➡️ 트랜잭션을 커밋해서 플러시가 일어나면 데이터베이스에 저장

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

• @SequenceGenerator
  • name: 식별자 생성기 이름
  • sequenceName: 데이터베이스에 등록되어 있는 시퀀스 이름
  • initialValue: DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정
  • allocationSize: 시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)
  • catalog, schema: 데이터베이스 catalog, schema 이름

create sequence [sequenceName]
start with [initialValue] increment by [allocationSize]

• SEQUENCE 전략은 데이터베이스와 2번 통신
  1. 식별자를 구하려고 데이터베이스 시퀀스 조회
  2. 조회한 시퀀스를 기본 키 값으로 사용해 데이터베이스에 저장
• JPA는 시퀀스에 접근하는 횟수를 줄이기 위해 @SequenceGenerator.allocationSize 사용
  ➡️ ex) allocationSize 값이 50이면 시퀀스를 한 번에 50 증가시킨 다음에 1~50까지는 메모리에서 식별자 할당, 51이 되면 시퀀스 값을 100으로 증가시킨 다름 51~100까지 메모리에서 식별자 할당
  ➡️ 시퀀스 값을 선점하므로 여러 JVM이 동시에 동작해도 기본 키 값이 충돌하지 않는 장점
  ➡️ 데이터베이스에 직접 접근해서 데이터를 등록할 때 시퀀스 값이 한 번에 많이 증가
• 이 방법은 hibernate.id.new_generator_mappings 속성을 true로 설정해야 적용 가능

TABLE 전략

• 키 생성 전용 테이블을 하나 만들고 여기에 이름과 값으로 사용할 컬럼을 만들어 데이터베이스 시퀀스를 흉내내는 전략

// TABLE 전략을 사용하려면 키 생성 용도로 사용할 테이블 미리 생성
create table MY_SEQUENCES (
	sequence_name varchar(255) not null,
    next_val bigint,
    primary key (sequence_name)
)

@Entity
@TableGenerator(
	name = "BOARD_SEQ_GENERATOR",
    table = "MY_SEQUENCES",
    pkColumnValue = "BOARD_SEQ", allocationSize = 1)
public class Board {

	@Id
    @GeneratedValue(strategy = GenerationType.TABLE,
    	generator = "BOARD_SEQ_GENERATOR")
    private Long id;
    ...
}

• @TableGenerator

  • name: 식별자 생성기 이름
  • table: 키 생성 테이블명
  • pkColumnName: 시퀀스 컬럼명
  • valueColumnName: 시퀀스 값 컬럼명
  • pkColumnValue: 키로 사용할 값 이름
  • initialValue: 초기 값, 마지막으로 생성된 값이 기준
  • allocationSize: 시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)
  • catalog, schema: 데이터베이스 catalog, schema 이름
  • uniqueConstraints(DDL): 유니크 제약 조건을 지정할 수 있음

• TABLE 전략은 값을 조회하면서 SELECT 쿼리를 사용하고 다음 값으로 증가시키기 위해 UPDATE 쿼리 사용

AUTO 전략

• GenerationType.AUTO는 선택한 데이터베이스 방언에 따라 IDENTITY, SEQUENCE, TABLE 전략 중 하나를 자동으로 선택
• 오라클은 SEQUENCE, MySQL은 IDENTITY
• 데이터베이스를 변경해도 코드를 수정할 필요가 없음

권장하는 식별자 선택 전략

기본키의 조건

• null 값은 허용하지 않음
• 유일해야 함
• 변해선 안 됨

테이블의 기본 키 선택 전략

• 자연 키(natural key)
• 대리 키(surrogate key)
• 자연 키 보다는 대리 키를 권장

5. 필드와 컬럼 매핑: 레퍼런스

1. @Column

객체 필드를 테이블 컬럼에 매핑

속성

• name: 필드와 매핑할 테이블의 컬럼 이름
• nullable: null 값의 허용 여부 설정
  • 자바 기본 타입에는 null 값을 입력할 수 없고, 객체 타입일 때만 null 허용
  • 자바 지본 타입에 @Column을 사용하면 nullable = false로 지정하는 것이 안전

2. @Enumerated

자바의 enum 타입을 매핑할 때 사용

속성

• value
  • EnumType.ORDINAL: enum 순서를 데이터베이스에 저장
  • EnumType.STRING: enum 이름을 데이터베이스에 저장(권장)

3. @Temporal

날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용

속성

• value
  • TemporalType.DATE: 날짜, 데이터베이스 data 타입과 매핑
  • TemporalType.TIME: 시간, 데이터베이스 time 타입과 매핑
  • TemporalType.TIMESTAMP: 날짜와 시간, 데이터베이스 timestamp 타입과 매핑

3. @Lob

데이터베이스 BLOB, CLOB 타입과 매핑

• 매핑하는 필드 타입이 문자면 CLOB으로 매핑하고 나머지는 BLOB으로 매핑

4. @Transient

매핑하지 않음.
데이터베이스에 저장하지 ㅇ낳고 조회하지도 안흠

5. @Access

JPA가 엔티티 데이터에 접근하는 방식 지정

• 필드 접근: AccessType.FIELD, 필드에 직접 접근
• 프로퍼티 접근: AccessType.PROPERTY, 접근자(Getter) 사용