[JPA] 엔티티 매핑

엔티티 매핑

 JPA를 사용하는 데 가장 중요한 일은 엔티티와 테이블을 정확하게 매핑하는 것이다. 따라서 매핑 어노테이션을 숙지하고 사용해야한다. JPA는 다양한 매핑 어노테이션을 지원하는데 크게 4가지로 분류할 수 있다.

-객체와 테이블 매핑: @Entity, @Table

-기본 키 매핑: @Id

-필드와 컬럼 매핑: @Column

-연관관계 매핑: @ManyToOne, @JoinColumn

 

@Entity

 JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 어노테이션을 필수로 붙여야한다. @Entity가 붙은 클래스는 JPA가 관리하는 것으로 엔티티라 부른다.

속성	기능	기본값
name	JPA에서 사용할 엔티티 이름을 지정한다. 보통 기본값인 클래스 이름을 사용한다. 만약 다른 패키지에 이름이 같은 엔티티 클래스가 있다면 이름을 지정해서 충돌하지 않도록 해야 한다.	설정하지 않으면 클래스 이름을 그대로 사용한다.

 

 @Entity 어노테이션을 적용하면 기본 생성자가 필수로 있어야 한다. 또한 final 클래스, enum, interface, inner 클래스에는 사용할 수 없으며, 저장할 필드에 final을 사용하면 안된다.

 

@Table

 @Table 어노테이션은 엔티티와 매핑할 테이블을 지정한다. 생략하면 매핑한 엔티티 이름을 테이블 이름으로 사용한다.

속성	기능	기본값
name	매핑할 테이블 이름	엔티티 이름을 사용한다.
catalog	catalog 기능이 있는 데이터베이스에서 catalog를 매핑한다.
schema	schema 기능이 있는 데이터베이스에서 schema를 매핑한다.
uniqueConstraints(DDL)	DDL 생성 시에 유니크 제약조건을 만든다. 2개 이상의 복합 유니크 제약조건도 만들 수 있다. 이 기능은 스키마 자동 생성 기능을 사용해서 DDL 을 만들 때만 사용된다.

 

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

 JPA는 데이터베이스 스키마를 자동으로 생성하는 기능을 지원한다. 클래스의 매핑 정보를 보면 어떤 테이블에 어떤 컬럼을 사용하는지 알 수 있다. JPA는 이 매핑정보와 데이터베이스 방언을 사용해서 데이터베이스 스키마를 생성한다. 스키마 자동 생성 기능을 사용하려면 먼저 persistance.xml에 다음 속성을 추가해야한다.

<!-- 이 속성을 추가하면 애플리케이션 실행 시점에 데이터베이스 테이블을 자동으로 생성한다. -->
<property name="hibernate.hbm2ddl.auto" value="create" />

<!-- 콘솔에 실행되는 테이블 생성 DDL을 출력할 수 있다. -->
<property name="hibernate.show_sql" value="true" />

 

 hibernate.hbm2ddl.auto의 속성은 다음과 같다.

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

 여기서 주의할 점은 운영 서버에서 create, create-drop, update처럼 DDL을 수정하는 옵션은 절대 사용하면 안된다. 오직 개발 서버나 개발 단계에서만 사용해야 한다. 이 옵션들은 운영 중인 데이터베이스의 테이블이나 컬럼을 삭제할 수 있다. 따라서 아래의 개발 환경 별 추천 전략을 따르는 것이 좋다.

-개발 초기 단계는 create 또는 validate

-초기화 상태로 자동화된 테스트를 진행하는 개발자 환경과 CI 서버는 create 또는 create-drop

-테스트 서버는 update 또는 validate

-스테이징과 운영 서버는 validate 또는 none

 

 또한 이름 매핑 전략을 변경할 수도 있는데 hibernate.ejb.naming_strategy 속성의 value를 하이버네이트에서 제공하는 org.hibernate.cfg.ImprovedNamingStrategy클래스로 설정해주면 테이블 명이나 컬럼 명이 생략되면 자바의 카멜 표기법을 테이블의 언더스코어 표기법으로 매핑한다.

<!--테이블 명이나 컬럼 명이 생략됐을 때 [userType -> user_type] 같이 매핑 -->
<property name="hibernate.ejb.naming_strategy" value="org.hibernate.cfg.ImproveNamingStrategy" />

 

DDL 생성 기능

@Column의 속성 nullable을 false로 지정하면 생성된 DDL에 not null 제약조건이 붙으며, length 속성을 사용하면 자동 생성되는 DDL에 문자의 크기를 지정할 수 있다. 또한 @Table의 uniqueConstraints 속성을 사용하면 DDL을 생성했을 때 유니크 제약조건이 추가된다. 이러한 기능들은 단지 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않는다. 따라서 스키마 자동 생성 기능을 사용하지 않고 직접 DDL을 만든다면 사용할 이유가 없다.

// Table의 uniqueConstraints 속성 사용 예시
@Entity(name="Member")
@Table(name="MEMBER", uniqueConstraints = {@UniqueConstraint(
    name = "NAME_AGE_UNIQUE",
    columnNames = {"NAME", "AGE"} )})

 

기본 키 매핑

 JPA가 제공하는 데이터베이스 기본 키 생성 전략은 다음과 같다.

-직접 할당: 기본 키를 애플리케이션 직접 할당한다.

-자동 생성: 대리 키 사용 방식

    -IDENTITY: 기본 키 생성을 데이터베이스에 위임한다.

    -SEQUENCE: 데이터베이스 시퀀스를 사용해서 기본 키를 할당한다.

    -TABLE: 키 생성 테이블을 사용한다.

 

자동 생성 전략이 이렇게 다양한 이유는 데이터베이스 벤더마다 지원하는 방식이 다르기 때문이다. 기본 키를 직접 할당하려면 @Id만 사용하면 되고, 자동 생성 전략을 사용하려면 @Id @GeneratedValue를 추가하고 원하는 키 생성 전략을 선택하면 된다. 키 생성 전략을 사용하려면 persistence.xml에 hibernate.id.new_generator_mapping=true 속성을 반드시 추가해야한다.

<!-- 키 생성 전략 사용을 위한 속성 추가 -->
<property name="hibernate.id.new_generator_mappings" value="true" />

 

기본 키 직접 할당 전략

우선 기본 키를 직접 할당하려면 @Id로 매핑하면 된다. 기본 키 직접 할당 전략은 persist()로 엔티티를 저장하기 전에 애플리케이션에서 기본 키를 직접 할당하는 방법이다. 기본 키 직접 할당 전략에서 식별자 값 없이 저장하면 예외가 발생한다.

//  기본 키를 직접 할당하기 위해 @Id로 매핑
@Id
@Column(name = "id")
private String id;

//	기본 키를 직접 할당하고 엔티티 저장
Board board = new Board();
board.setId("id1");
em.persist(board);

 

IDENTITY 전략

 IDENTITY는 기본 키 생성을 데이터베이스에 위임하는 전략이다. 주로 MySQL, PostgreSQL, SQL Server 등에서 사용한다. IDENTITY 전략은 데이터베이스에 값을 저장하고 나서야 기본 키 값을 구할 수 있을 때 사용한다. IDENTITY 전략을 사용하려면 @GeneratedValue의 strategy 속성 값을 GenerationType.IDENTITY로 지정하면 된다. IDENTITY 전략은 데이터를 INSERT한 후에 기본 키 값을 조회할 수 있기 때문에 엔티티에 식별자 값을 할당하려면 JPA는 추가로 데이터베이스를 조회해야 한다. Statement.getGeneratedKeys()를 사용하면 데이터를 저장하면서 동시에 생성된 기본 키 값도 얻어 올 수 있기 때문에 데이터베이스와 한 번만 통신하게 된다

엔티티가 영속상태가 되려면 식별자가 반드시 필요한데 IDENTITY 전략을 사용하므로 persist()를 호출하는 즉시 INSERT SQL이 전달된다. 따라서 이 전략은 트랜잭션을 지원하는 쓰기 지연이 동작하지 않는다.

@Entity
public class Board {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)	//	IDENTITY 전략 사용
    private Long id;
    ...
}

 

SEQUENCE 전략

데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트이다. SEQUENCE 전략은 이 시퀀스를 사용해서 기본 키를 생성한다. 이 전략은 시퀀스를 지원하는 오라클, PostgreSQL, H2 등에서 사용할 수 있다. 시퀀스를 사용하기 위해서는 먼저 데이터베이스에서 DDL을 사용해서 시퀀스를 생성해야 한다.

CREATE TABLE BOARD (
    ID BIGINT NOT NULL PRIMARY KEY,
    DATA VARCHAR(255)
)

--//	시퀀스 생성
CREATE SEQUENCE BOARD_SEQ START WITH 1 INCREMENT BY 1;

 

그리고 @SequenceGenerator를 사용해서 시퀀스 생성기를 등록해야한다. 마지막으로 키 생성 전략을

GenerationType.SEQUENCE로 설정하고 generator 값에 생성한 시퀀스 생성기를 선택한다. 시퀀스 사용 코드는 IDENTITY 전략과 같지만 SEQUENCE 전략은 persist()를 호출할 때 먼저 데이터베이스 시퀀스를 사용해서 식별자를 조회하고 엔티티에 할당해서 저장하며 그 후 플러시가 일어날 때 엔티티를 데이터베이스에 저장한다.

@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	데이터베이스에 등록되어 있는 시퀀스 이름	hibernate_sequence
initialValue	DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정한다.	1
allocationSize	시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)	50
catalog, schema	데이터베이스 catalog, schema 이름

JPA는 시퀀스에 접근하는 횟수를 줄이기위해 @SequenceGenrator.allocationSize를 사용한다. allicationSize의 기본값이 1이 아니라 50인 이유는 JVM이 동시에 동작해도 기본 키 값이 충돌하지 않게 하기 위해서이다. INSERT 성능이 중요하지 않다면 값을 1로 설정해도 된다.

 

TABLE 전략

 TABLE 전략은 키 생성 전용 테이블을 하나 만들고 여기에 이름과 값으로 사용할 컬럼을 만들어 데이터베이스 시퀀스를 흉내내는 전략이다. 이 전략은 테이블을 사용하므로 모든 데이터베이스에 적용할 수 있다. TABLE 전략을 사용하려면 키 생성 용도로 사용할 테이블을 만들어야 한다. 테이블 전략을 사용하려면 키 생성 용도로 사용할 테이블을 만들어야 한다.

--//	sequence_name 컬럼을 시퀀스 이름으로 사용하고 next_val 컬럼을 시퀀스 값으로 사용한다.
create table MY_SEQUENCES (
    sequence_name varchar(255) not null,
    next_val bigint,
    primary key (sequence_name)
)

 

 그 후 @TableGenerator를 사용해서 테이블 키 생성기를 등록한다. 다음으로 키 생성 전략을 GenerationType.TABLE으로 설정하고 generator 값에 생성한 테이블 키 생성기를 지정한다. Table 전략은 시퀀스 대신 테이블을 사용한다는 것만 제외하면 SEQUENCE 전략과 내부 동작이 같다. 

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

 

AUTO 전략

 generationType.AUTO는 선택한 데이터베이스 방언에 따라 IDENTITY, SEQUENCE, TABLE 전략 중 하나를 자동으로 선택한다. GeneratedValue.strategy의 기본값은 AUTO이기 때문에 strategy 속성을 따로 정해줄 필요가 없다. AUTO 전략의 장점은 데이터베이스를 변경해도 코드를 수정할 필요가 없다는 것이다. 특히 키 생성 전략이 아직 확정되지 않은 개발 초기 단계나 프로토 타입 개발시 편리하게 사용할 수 있다.

 

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

분류	매핑 어노테이션	설명
필드와 컬럼 매핑	@Column	컬럼을 매핑한다.
	@Enumerated	자바의 enum 타입을 매핑한다
	@Temporal	날짜 타입을 매핑한다.
	@Lob	BLOB, CLOB 타입을 매핑한다.
	@Transient	특정 필드를 데이터베이스에 매핑하지 않는다.
기타	@Access	JPA가 엔티티에 접근하는 방식을 지정한다.

 

@Column

 @Column은 객체 필드를 테이블 컬럼에 매핑한다. 속성 중에 name, nullable만 주로 사용된다.

속성	기능	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드 이름
insertable(거의 사용하지 않음)	엔티티 저장 시 이 필드도 같이 저장한다. false로 설정하면 이 필드는 데이터베이스에 저장하지 않는다. false 옵션은 읽기 전용일 때 사용한다.	true
updatable(거의 사용하지 않음)	엔티티 수정 시 이 필드도 같이 수정한다. false로 설정하면 데이터베이스에 수정하지 않는다. false 옵션은 읽기 전용일 때 사용한다.	true
table(거의 사용하지 않음)	하나의 엔티티를 두 개 이상의 테이블에 매핑할 때 사용한다. 지정한 필드를 다른 테이블에 매핑할 수 있다.	현재 클래스가 매핑된 테이블
nullable(DDL)	null 값의 허용 여부를 설정한다. false로 설정하면 DDL  생성 시에 not null 제약조건이 붙는다.	true
unique(DDL)	@Table의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약조건을 걸 때 사용한다. 만약 두 컬럼 이상을 사용해서 유니크 제약조건을 사용하려면 @Table.uniqueConstraints를 사용해야 한다.
columnDefinition(DDL)	데이터베이스 컬럼 정보를 직접 줄 수 있다.	필드와 자바 타입과 방언 정보를 사용해서 적절한 컬럼 타입을 생성한다.
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에 하나가 추가되면 문제가 발생할 수 있으므로 EnumType.STRING을 권장한다.

 

@Temporal

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

속성	기능	기본값
value	-TemporalType.DATE: 날짜, 데이터베이스 date 타입과 매핑(예: 2020-09-06) -TemporalType.TIME: 시간, 데이터베이스 time 타입과 매핑(예: 11:11:11) -TemporalType.TIMESTAMP: 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (예: 2020-09-06 11:11:11)	TemporalType은 필수로 지정해야 한다.

 

@Lob

 데이터베이스 BLOB, CLOB 타입과 매핑한다. @Lob에는 지정할 수 있는 속성이 없고, 매핑하는 필드 타입이 문자면 CLOB으로 매핑하고 나머지는 BLOB으로 매핑한다.

 

@Transient

 이 필드는 매핑하지 않는다. 따라서 데이터베이스에 저장하지 않고 조회하지도 않는다. 객체에 임시로 어떤 값을 보관하고 싶을 때 사용한다.

 

@Access

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

-필드 접근: AccessType.FIELD로 지정한다. 필드에 직접 접근한다. 필드 접근 권한이 private이어도 접근할 수 있다.

-프로퍼티 접근: AccessType.PROPERTY로 지정한다. 접근자(Getter)를 사용한다.

@Access를 설정하지 않으면 @ID 어노테이션의 위치를 기준으로 접근 방식이 설정된다. 

@Entity
public class Member {
    //	@id가 필드에 있으므로 기본은 필드 접근 방식 사용
    @Id
    private String id;
    
    @Transient
    private String firstName;
    
    @Transient
    private String lastName;
    
    //	이 함수만 프로퍼티 접근 방식 사용. 회원 테이블에 FULLNAME 컬럼에 저장
    @Access(AccessType.PROPERTY)
    public String get_FullName() {
    	return firstName + lastName;
    }
    ...
}