엔티티 매핑

해당 시리즈는 김영한님의 JPA 로드맵을 따라 학습하면서 내용을 정리하는 글입니다

엔티티 매핑 소개

• 객체와 테이블 매핑: @Entity, @Table
• 필드와 컬럼 매핑: @Column
• 기본 키 매핑: @Id
• 연관관계 매핑: @ManyToOne, @JoinColumn

객체와 테이블 매핑

@Entity

• @Entity가 붙은 클래스는 JPA가 관리, 엔티티라 합니다
• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 필수입니다

주의할 점

• 기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자)
• final 클래스, enum, interface, inner 클래스 사용 X
• 저장할 필드에 final 사용 X

@Entity 속성 정리

• 속성: name
  • JPA에서 사용할 엔티티 이름을 지정합니다
• 기본값: 클래스 이름을 그대로 사용(예: Member) 같은 클래스 이름이 없으면 가급적 기본값을 사용합니다

@Table

• @Table은 엔티티와 매핑할 테이블을 지정합니다

속성	기능	기본값
name	매핑할 이름	엔티티 이름을 사용
catalog	데이터베이스 catalog 매핑
schema	데이터베이스 schema 매핑
uniqueConstrains(DDL)	DDL 생성 시에 유니크 제약 조건 생성

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

• DDL을 애플리케이션 실행 시점에 자동으로 생성해 줍니다
• 기존에 테이블을 중심으로 엔티티를 만들던 것과는 다르게 객체 중심으로 엔티티를 생성해서 매핑해주면 필요한 테이블을 생성해 줍니다
• 데이터베이스 방언(dialog)을 활용해서 데이터베이스에 맞는 적절한 DDL을 생성합니다
• 이렇게 생성된 DDL은 개발 장비에서만 사용합니다
• 생성된 DDL은 운영서버에서는 사용하지 않거나, 적절히 다듬은 후에 사용합니다

데이터베이스 스키마 자동 생성 - 속성

hibernate.hbm2ddl.auto

옵션	설명
create	기존 테이블 삭제 후 다시 생성(DROP + CREATE)
create-drop	create와 같으나 종료시점에 테이블 DROP
update	변경분만 반영(운영 DB에는 사용하면 안됨)
validate	엔티티와 테이블이 정상 매핑되었는지만 확인
none	사용하지 않음

주의할 점

• 운영 장비에는 절대 create, create-drop, update 사용하면 안됩니다!!
• 개발 초기 단계는 create 또는 update
• 테스트 서버는 update 또는 validate
• 스테이징과 운영 서버는 validate 또는 none
• 하지만 개발 서버, 테스트 서버, 스테이징 운영서버에도 직접 DDL을 작성하는 것을 권장합니다

DDL 생성 기능

• ex) 제약조건 추가: 회원 이름은 필수, 10자 초과 X
  • @Column(nullable = false, length = 10)
• 유니크 제약조건 추가
  • @Table(uniqueConstrains = {@UniqueConstriant(name = "NAME_AGE_UNIQUE", columnNames = {"NAME", "AGE"})})
• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA 실행 로직에는 영향을 주지 않습니다

필드와 컬럼 매핑

어노테이션	설명
@Column	컬럼 매핑
@Temporal	날짜 타입 매핑(DATE, TIME, TIMESTAMP)
@Enumerated	enum 타입 매핑
@Lob	BLOB, CLOB 매핑
@Transient	특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

@Column

속성	설명	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드 이름
insertable, updatable	등록, 변경 가능 여부	TRUE
nullable(DDL)	null값의 허용 여부를 설정합니다. false로 설정하면 DDL 생성 시에 not null 제약조건이 붙습니다
unique(DDL)	@Table의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약조건을 걸 때 사용합니다	필드의 자바 타입과 방언 정보 사용
columnDefinition(DDL)	데이터베이스 컬럼 정보를 직접 줄 수 있습니다 ex) varchar(100) default 'EMPTY'	255
length(DDL)	문자 길이 제약조건, String 타입에만 사용합니다	255
precision, scale(DDL)	BigDecimal 타입에서 사용합니다 (BigInteger도 사용할 수 있습니다) precision은 소수점을 포함한 전체 자릿수를, scale은 소수의 자릿수입니다 참고로 double, float 타입에는 적용되지 않습니다. 아주 큰 숫자나 정밀한 소수를 다뤄야 할 때만 사용합니다	precision = 19, scale = 2

@Enumerated

• 자바 enum 타입을 매핑할 때 사용합니다

🚧 주의!!!!!! ORDINAL 사용하지 맙시다!!!!!!!!!!!!!!!

속성	설명	기본값
value	- EnumType.ORDINAL: enum 순서를 데이터베이스에 저장 - EnumType.STRING: enum 이름을 데이터베이스에 저장	EnumType.ORDINAL

• 예를 들어서 처음 enum에서 새로운 타입을 추가하게 되면 int 값은 가리키는 enum의 타입이 바뀔 가능성이 있기 때문에 무조건 STRING으로 사용하도록 하자!!

@Temporal

• 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용합니다
• 참고: LocalDate, LocalDateTime을 사용할 때는 생략이 가능합니다(최신 하이버네이트 지원)

속성	설명	기본값
value	- TemporalType.DATE: 날짜, 데이터베이스 date 타입과 매핑(ex: 2013-10-11) - TemporalType.TIME: 시간, 데이터베이스 time 타입과 매핑(ex: 11:11:11) - TemporalType.TIMESTAMP: 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (ex: 2013-10-11 11:11:11)

@Lob

• 데이터베이스 BLOB, CLOB 타입과 매핑됩니다
• @Lob에는 지정할 수 있는 속성이 없습니다
• 매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB이 매핑됩니다
  • CLOB: String, char[], java.sql.CLOB
  • BLOB: byte[], java.sql.BLOB

@Transient

• 필드를 매핑하지 않습니다
• 데이터베이스에 저장 및 조회하지 않습니다
• 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용합니다

  @Transient
  private Integer temp;

기본 키 매핑

• @Id
• @GeneratedValue

@Id @GeneratedValue(strategy = GenerationType.AUTO)
private Long id;

기본 키 매핑 방법

• 직접 할당: @Id만 사용해서 할당합니다
• 자동 생성(@GeneratedValue):
  • IDENTITY: 데이터베이스에 위임합니다,
  • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용합니다,
    • @SequenceGenerator 필요합니다
  • TABLE: 키 생성용 테이블 사용합니다, 모든 DB에서 사용
    • TableGenerator 필요합니다
  • AUTO: 방언에 따라 자동으로 지정합니다, 기본값

IDENTITY 전략 특징

• 기본 키 생성을 데이터베이스에 위임합니다
• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용합니다
  (ex: MySQL의 AUTO_INCREMENT)
• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL을 실행합니다
• 따라서 원래대로라면 AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID값을 알 수 있습니다
• 이를 보완하고자 IDENTITY 전략은 commit()시점이 아닌 persist() 시점에 즉시 INSERT SQL을 실행하고 DB에서 식별자를 조회할 수 있습니다

SEQUENCE 전략 특징

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트입니다
  (ex: 오라클 시퀀스)
• Oracle, PostgreSQL, DB2, H2 데이터베이스에서 사용합니다
• 객체를 DB에 persist()하는 시점에 ID 값을 지정해줘야 하는데 ID 값으로 사용될 시퀀스의 값은 DB에 있습니다
• 때문에 SEQUENCE 전략일 경우에는 persist() 시점에 DB에서 시퀀스 값을 가져오는 작업을 수행합니다

  Hibernate:
  	call next value for MEMBER_SEQ

• 그 다음에 ID 값을 채워넣고, 영속성 컨텍스트에 저장합니다(아직 DB에 INSERT SQL은 날아가지 않은 상태입니다)
• 그 후 commit()하는 시점에 DB에 INSERT SQL이 날아갑니다
• 이런 특징 때문에 allocationSize 옵션을 통해서 최적화를 시도합니다
  • allocationSize = 50을 설정하면 미리 50개의 시퀀스 값을 가져온 후, 메모리에 저장한 후에 사용하다가 개수가 떨어지면 또 가져오는 방식으로 사용하게 됩니다

SEQUENCE 전략 매핑

@Entity
@SequenceGenerator(
	name = "MEMBER_SEQ_GENERATOR",
    sequenceName = "MEMBER_SEQ", // 매핑할 데이터베이스 시퀀스 이름
    initialValue = 1, allocationSize = 1)
public class Member {
	
    @Id
    @GeneratedValue(strategy = GeneraionType.SEQUENCE,
    	generator = "MEMBER_SEQ_GENERATOR")
    private Long id;
}

SEQUENCE - @SequenceGenerator

• 주의: allocationSize 기본값 = 50

속성	설명	기본값
name	식별자 생성기 이름	필수
sequenceName	데이터베이스에 등록되어 있는 시퀀스 이름	hibernate_sequence
initialValue	DDL 생성 시에만 사용됩니다 시퀀스 DDL을 생성할 때 처음 1 시작하는 수를 지정합니다	1
allocationSize	시퀀스 한 번 호출에 증가하는 수 성능 최적화에 사용됩니다 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값을 반드시 1로 설정해야 합니다	50
catalog, schema	데이터베이스 catalog, schema 이름

TABLE 전략

• 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내내는 전략입니다
• 장점: 모든 데이터베이스에 적용이 가능합니다
• 단점: 성능 문제가 있을 수 있습니다

TABLE 전략 매핑

• 키 생성 전용 테이블 생성하기

create table MY_SEQUENCES (
	sequence_name varchar(255) not null,
    next_val bigint,
    primary key ( sequence_name )
)

• 설정해주기

@Entity
@TableGenerator(
	name = "MEMBER_SEQ_GENERATOR",
    table = "MY_SEQUENCES",
    pkColumnValue = "MEMBER_SEQ", allocationSize = 1)
public class Member {

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

@TableGenerator 속성

속성	설명	기본값
name	식별자 생성기 이름	필수
table	키생성 테이블명	hibernate_sequences
pkColumnName	시퀀스 컬럼명	sequence_name
valueColumnNa	시퀀스 값 컬럼명	next_val
pkColumnValue	키로 사용할 값 이름	엔티티 이름
initialValue	초기 값, 마지막으로 생성된 값이 기준이 됩니다	0
allocationSize	시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)	50
catalog, schema	데이터베이스 catalog, schema
uniqueConstraints(DDL)	유니크 제약 조건을 지정할 수 있습니다

권장하는 식별자 전략

• 기본 키 제약 조건: null이면 안되고, 유일해야 하며, 변하면 안된다
• 미래까지 이 조건을 만족하는 자연키는 찾기 어렵습니다. 대리키(대체키: 비지니스와 전혀 상관없는 어떠한 값)를 사용하도록 합니다
• 예를 들어 주민등록번호도 기본 키로 적절하기 않습니다
• 권장: Long형 + 대체키 + 키 생성전략 사용하기
  • Auto-Increment, Sequence, uuid 등