[JPA] 엔티티 매핑

본 게시글은 김영한 님의 자바 ORM 표준 JPA 프로그래밍 - 기본편 을 정리한 내용입니다.

객체와 테이블 매핑

@Entity

• @Entity가 붙은 클래스는 JPA가 관리한다
• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 가 필수
  • 기본 생성자 필수
  • final 클래스, enum, interface, inner 클래스 사용X
  • 저장할 필드에 final 사용X

@Entity(name="Member")
public class Memeber{

    @Id
    private Long id;
    private String name;
}

name 속성을 통해 JPA에서 사용할 엔티티 이름을 지정할 수 있다.
같은 이름의 클래스가 있는 것이 아니면 가급적 기본값(클래스 이름 그대로)을 사용한다.

 

@Table

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

속성기능기본값

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

@Entity
@Table(name="MBR")
public class Memeber{

    @Id
    private Long id;
    private String name;
}

 

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

• JPA는 DDL을 애플리케이션 실행 시점에 자동 생성 (애플리케이션 로딩 시점에 DB 테이블 자동생성)
  => 개발 시 테이블 먼저 생성 후 객체로 돌아가야하는 번거로움을 줄여줌
• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
• 생성된 DDL은 개발 장비에서만 사용 (운영서버에서는 사용하지 않거나 적절히 다듬어 사용)

옵션설명

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

hibernate.hbm2ddl.auto

주의사항

• 운영 장비에는 절대 create, create-drop, update 사용하면 안됨
• 개발 초기 단계는 create 또는 update
• 테스트 서버는 update 또는 validate
• 스테이징과 운영 서버는 validate 또는 none

DDL 생성 기능

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

 

필드와 칼럼 매핑

어노테이션	설명
@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

ex)

@Column(precision=19, scale=2)
private BigDecimal age;

 

@Enumerated

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

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

ORDINAL 은 사용X
enum 타입 클래스 수정 시(특히 순서 바뀔 경우) 기존에 들어간 데이터의 값이 바뀌지 않는 문제

 

@Temporal

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

속성	설명
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

• 필드 매핑X
• 데이터베이스에 저장X, 조회X
• 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용

 

 

기본 키 매핑

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

IDENTITY 전략

@Entity
public class Memeber{

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

}

• 기본 키 생성을 데이터베이스에 위임
• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용 (예: MySQL의 AUTO_ INCREMENT)
• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
• AUTO_ INCREMENT는 데이터베이스에 INSERT SQL을 실행 한 이후에 ID 값을 알 수 있음
• IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행 하고 DB에서 식별자를 조회

 

SEQUENCE 전략

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

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(예: 오라클 시퀀스)
• 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용

@SequenceGenerator

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

 

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 이름
uniqueConstraint s(DDL)	유니크 제약 조건을 지정할 수 있다.

 

권장하는 식별자 전략

• 기본 키 제약 조건: null 아님, 유일, 변하면 안된다.
• 미래까지 이 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대체키)를 사용하자.
  => 주민등록번호도 기본 키로 적절하기 않다. (정책상 주민번호 수집이 불가하여 DB에서 지워야 할 경우...)
• 권장: Long형 + 대체키 + 키 생성전략 사용

 

데이터 중심 설계의 문제점

다음과 같은 설계의 문제점은 무엇일까?

도메인 모델

테이블 설계

엔티티 설계와 매핑

• 위의 방식은 객체 설계를 테이블 설계에 맞춘 방식
• 테이블의 외래키를 객체에 그대로 가져옴 (객체지향적이지 않음, 객체 그래프 탐색이 불가능)
• 참조가 없으므로 UML도 잘못됨