JPA - 엔티티 매핑 | My Technical Diary

엔티티 매핑

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

객체와 테이블 매핑

@Entity

@Entity가 붙는 클래스는 JPA가 관리하며 엔티티라고 불림
JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 어노테이션이 필수
주의 사항
- 기본 생성자가 필수(파라미터가 없는 public 혹은 protected 생성자)
- final 클래스, enum, interface, inner 클래스에 사용 불가
- 저장할 필드에 final 키워드 사용 불가

@Table

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

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

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

DDL을 어플리케이션 실행 시점에 자동 생성

테이블 중심 -> 객체 중심
데이터베이스 방언을 활용하여 각 데이터베이스 제품별로 맞는 DDL을 생성
생성된 DDL은 반드시 개발 장비에서만 사용
- 생성된 DDL은 운영서버에 사용하지 않거나 적절히 다듬은 후 사용
DDL 생성기능은 DDL을 자동 생성할 떄만 사용되고 JPA의 실행 로직에는 영향을 주지 않음

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

  
<!-- maven -->
<!-- resources/META-INF -->

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

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

데이버베이스 스키마 자동 생성의 주의 사항

운영 장비에는 정대 create, create-dop, update 속성을 사용하면 안됨
- 운영하는 데이터베이스의 데이터가 날라감
개발 초기 단계는 create 또는 update
테스트 서버는 update 또는 validate
스테이징과 운영서버는 validate 또는 none

필드와 컬럼 매핑

  
@Entity
public class Member {
    @Id
    private Long id;

    @Column(name = "name")
    private String username;

    private Integer age;

    @Enumerated(EnumType.STRING)
    private RoleType roleType;

    @Temporal(TemporalType.TIMESTAMP)
    private Date createdDate;

    @Temporal(TemporalType.TIMESTAMP)
    private Date lastModifiedDate;

    @Lob
    private String description;

    ...
}

매핑 어노테이션 정리

어노테이션	설명
@Column	컬럼 매핑
@Temporal	날짜 타입 매핑
@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’	필드의 자바 타입과 방언 정보를 사용
length(DDL)	문자 길이 제약조건. String 타입에만 사용한다.	255
precision, scale(DDL)	BigDecimal 타입에서 사용한다(BigInteger도 사용할 수 있다). precision은 소수점을 포함한 전체 자릿수를, scale은 소수의 자릿수다. 참고로 double, float 타입에는 적용되지 않는다. 아주 큰 숫자나 정밀한 소수를 다루어야 할 때만 사용한다.	precision=19, scale=2

@Enumerated

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

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

ORDINAL의 경우 데이터베이스의 필드에 값이 숫자로 저장되기 떄문에 값을 추론하기 어려움이 있으며 가장 큰 문제는 enum에 값이 추가되었을때 지정되는 숫자가 밀리려서 지정되기 떄문에, 같은 enum의 필드를 저장해도 데이터베이스에 저장되어 있는 값과 다를수가 있음
ORDINAL 보다는 STRING 을 사용하는 것이 좋음

@Temporal

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

최신 하이버네이트 사용시에는 LocalData, LocalDataTime을 사용할 때는 생략 가능

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

@Lob

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

@LOB에는 지정할 수 있는 속석이 없음
매핑하는 필드 타입이 문자면 CLOB, 나머지는 BLOB 매핑
- CLOB : String, char[]. java.sql.CLOB
- BLOB : byte[], java.sql.BLOB

@Transient

필드 매핑을 하지 않음
데이터베이스에 저장 및 조회를 하지 않음
주로 메모리상에만 임시로 어떤 값을 보관하기 위해 사용

기본 키 매핑

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

IDENTITY 전략

기본 키 생성을 데이터베이스에 위임
주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용
- MySQL의 AUTO_INCREMENT
AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있기 때문에 JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행하지만 IDENTITY 전략은 예외적으로 em.persis() 시점에 즉시 INSERT SQL 실행하고 데이터베이스에서 식별자를 조회해 옴

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

SEQUENCE 전략

데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트를 사용
- 예를 들면 오라클 시퀀스가 있음
오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용

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

SEQUENCE - @SequenceGenerator 속성

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

allocationSize 속성을 통한 성능 최적화

allocationSize 속성에 적용된 값만큼 다음 id 값의 증가값이 결정되어짐. 즉, allocationSize 속성의 값이 50 이라면, 처음 엔티티가 저장될떄의 id 가 1 일 때 데이터베이스 내의 다음에 생성되는id는 50이 증가된 51이 됨. 이를 이용하여 미리 여러개의 allocationSize 속성의 값만큼 키를 한번에 받아와서 다음 엔티티를 저장할 떄 굳이 데이터베이스와 통신하지 않도록 함.

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
valueColumnName	시퀀스 값 컬럼명	next_val
pkColumnValue	키로 사용할 값 이름	엔티티 이름
initialValue	초기 값, 마지막으로 생성된 값이 기준이다.	0
allocationSize	시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)	50
catalog, schema	데이터베이스 catalog, schema 이름
uniqueConstraints(DDL)	유니크 제약 조건을 지정할 수 있다.

권장하는 식별자 전략

기본 키 제약 조건
- null 이 아님
- 유일 해야 함
- 변하면 안됨
미래까지 기본 키 제약 조건을 만족하는 자연키는 찾기 어려우니 대리키(댜체키)를 사용하는 것
- 자연키 : 비지니스와 연관된 필드인 키
  - 주민번호, 전화번호 와 같은 값
- 대리키 : 비지니스와 연관되지 않은 시스템에서 생성된 키
권장하는 키 생성은 [Long 형 + 대체키 + 키 생성전략 사용] 방법을 사용 하는 것

참고

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

JPA - 엔티티 매핑