[JPA-04] 엔티티 매핑

이가희·2024년 11월 24일

JPA Table entity 엔티티 매핑

JPA

목록 보기

4/16

JPA를 사용할 때 가장 기본이 되는 것이자, 중요한 엔티티와 테이블을 매핑하는 것을 자세히 살펴 보겠다.

알아볼 기능들을 표로 정리하자면 다음과 같다.

@entity

속성	기능	기본값
name	JPA에서 사용할 엔티티 이름을 지정. 보통 클래스의 이름을 사용	설정하지 않으면 클래스 이름을 그대로 사용 (ex Member)

@table

속성	기능	기본값
name	매핑 할 테이블 이름	엔티티 이름을 사용
catalog	catalog 기능이 있는 DB에서 catalog를 매핑
schema	scheama 기능이 있는 DB에서 schema를 매핑
uniqueConstraints	DDL 생성 시에 유니크 제약조건을 만듦

hibernate.hbm2ddl.auto 속성

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

필드와 컬럼 매핑

매핑 어노테이션	설명
@Column	컬럼을 매핑
@Enumerated	자바의 enum 타입을 매핑
@Temporal	날짜 타입을 매핑
@Lob	BlOB, CLOB 타입을 매핑
@Transient	특정 필드를 데이터베이스에 매핑하지 않음

@Column

속성	기능	기본값
name	매핑 할 테이블 컬럼 이름	객체의 필드 이름
nullable(DDL)	null 값의 허용 여부를 설정	true
unique(DDL)	한 컬럼에 간단히 유니크 제약조건을 걸 때 사용
columnDefinition(DDL)	DB 컬럼 정보를 직접 줄 수 있다	필드의 자바 타입과 방언 정보를 사용해 적절한 컬럼 타입을 생성
length(DDL)	문자 길이 제약 조건. String 타입에서만 사용	255
precision,scale(DDL)	BigDecimal, BigInteger 타입에서만 사용. precision은 소수점을 포함한 전체 자릿수를 scale은 소수의 자릿수를 표현	precision19, scale= 2

@SequenceGenerator

속성	기능	기본값
name	식별자 생성기 이름	필수
sequenceName	DB에 등록되어 있는 시퀀스 이름	hibernate_sequence
initialValue	DDL 생성 시에만 사용. 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정	50
catalog, schema	DB catalog, schema 이름

@TableGenerator

속성	기능	기본값
name	식별자 생성기 이름	필수
table	키 생성 테이블 명	hibernate_sequences
pkColumnName	시퀀스 컬럼명	sequence_name
valueColumnName	시퀀스 값 컬럼명	next_val
pkColumnValue	키로 사용할 값 이름	엔티티 이름
initalValue	초기 값. 마지막으로 생성된 값이 기준	0
allocationSize	시퀀스 한 번 호출에 증가하는 수	50
uniqueConstrains(DDL)	유니크 제약 조건을 지정할 수 있음

Chapter

@Entity
데이터베이스 스키마 자동 생성
DDL 생성 기능
기본키 매핑
필드와 컬럼 매핑

@Entity

@Entity가 붙은 클래스는 JPA가 관리하는 것으로, 엔티티라 부르게 된다.
@Entity 사용 시 주의사항은 다음과 같다.

기본 생성사는 필수 (엔티티 객체를 생성할 때 기본 생성자를 사용함)
final class, enum, interface, inner class에는 사용할 수 없음.
저장할 필드에 final을 사용하면 안됨.

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

스키마 자동 생성을 사용하려면 persistence.xml에
< property name="hibernate.hbm2ddl.auto" value="create"/>
를 추가해야한다.
이 설정을 추가하면 애플리케이션 실행 시점에 데이터베이스 테이블을 자동으로 생성하게 된다.
자동생성되는 DDL은 지정한 데이터베이스 방언에 따라 달라지게 된다.
hibernate.hbm2ddl.auto 속성은 아래처럼 있다.

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

더 알아보기
create, create-drop, update 처럼 DDL을 수정하는 옵션은 개발 단계에서만 사용하는 것이 좋다.
테스트 서버는 update 또는 validate, 스테이징과 운영 서버는 validate 또는 none이 권장된다.

DDL 생성 기능

만약 회원 이름이 필수여야 하고, 10자를 초과하면 안 된다는 제약조건과 name과 age 컬럼에 대해 유니크 제약조건이 추가되면 스키마 자동 생성을 통해 만들어지는 DDL에 이 제약조건들을 추가하면 된다.

@Entity(name="Member")
@Table(name="Member", uniqueConstraints = {@UniqueConstraint(
name = "NAME_AGE_UNIQUE",
columnNames = {"NAME","AGE"})})

public class member{
@ID
@Column(name = "id")
private String id;

@Column(name ="NAME", nallable = false, length = 10)
private String userName;

private Integer age;

}

기본 키 매핑

단순 @ID 를 통해 애플리케이션에서 직접 기본 키를 할당하였는데, 데이터베이스가 생성해주는 값을 사용할 수도 있다.
자동 생성 (=대리 키 사용 방식) 을 통하면 되는데,

IDENTITY : 기본 키 생성을 데이터베이스에 위임
SEQUENCE : DB 시퀀스를 사용해서 기본 키를 할당
TABLE : 키 생성 테이블을 사용

위와 같이 3가지의 방식이 있다.
참고로 키 생성 전략을 사용하려면 persistence.xml에 hibernate.id.new_generator_mapping=true 속성을 반드시 추가해야 한다.

IDENTITY 전략
대표적으로 MySQL의 AUTO_INCREMENT 와 같은 기능을 활용할 때 쓰는 전략이다.
이를 사용하려면 @GeneratedValue를 추가해야 한다.

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

이렇게 설정하면, em.persist()를 호출해서 엔티티를 저장한 시점에 데이터베이스가 생성한 값을 JPA가 조회하여 id 값을 얻게 된다.
엔티티가 영속 상태가 되려면 식별자가 반드시 필요한데, IDENTITY 식별자 생성 전략은 엔티티를 DB에 저장해야 식별자를 구할 수 있으므로, em.persist()를 호출하는 즉시 INSERT SQL이 DB에 전달된다. 따라서 이 전략은 트랜잭션을 지원하는 쓰기 지연이 동작하지 않게 된다.

더 알아보기: IDENTITY 전략 최적화
JDBC3에 추가된 Statement.getGeneratedKeys()를 사용하면 데이터를 저장하면서 동시에 생성된 기본 키 값도 얻어올 수 있다. 따라서 하이버네이트는 이 메소드를 사용해 DB와 한 번만 통신하게 된다.

SEQUENCE 전략

참고 : 시퀀스란?
시퀀스는 데이터베이스에서 숫자의 고유한 연속 값을 생성하는 객체
트랜잭션 간에도 중복되지 않도록 값을 관리할 수 있음
특정 값부터 시작하거나 증가 간격(step)을 설정할 수 있음
주로 Oracle, PostgreSQL 같은 데이터베이스에서 지원됨

시퀀스 매핑 코드를 우선 살펴보겠다.

@Entity(name="Member")
@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;

}

우선 사용할 데이터베이스 시퀀스를 매핑하고, 키 생성 전략을 GenerationType.SEQUENCE 로 설정하고 등록한 시퀀스 생성기를 넣어주면 된다.
참고로 IDENTITY 전략과 내부 동작 방식이 다른데,
SEQUENCE 전략은 em.persist()를 호출할 때 먼저 DB 시퀀스를 사용해서 식별자를 조회하고, 조회한 식별자를 엔티티에 할당한 후에 엔티티를 영속성 컨텍스트에 저장한다. 이후 트랜잭션을 커밋해서 플러시가 일어나면 엔티티를 데이터베이스에 저장하고, IDENTITY 전략은 엔티티를 DB에 저장한 후에 식별자를 조회해서 엔티티의 식별자에 할당하고 영속성 컨텍스트에 저장하게 된다.

@SequenceGenerator 속성은 다음과 같다.

속성	기능	기본값
name	식별자 생성기 이름	필수
sequenceName	DB에 등록되어 있는 시퀀스 이름	hibernate_sequence
initialValue	DDL 생성 시에만 사용. 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정	50
catalog, schema	DB catalog, schema 이름

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

//table 전략 키 생성 DDL
create table SEQUENCE_TABLE (
	sequence_name varchar(255) not null,
    next_val bigint,
    primary key (sequence_name)
)

그리고 다음과 같이 매핑해준다.

@Entity
@TableGenerator(
	 name = "MEMBER_SEQ_GENERATOR",
 	table = "SEQUENCE_TABLE",
	 pkColumnValue = "MEMBER_SEQ", allocationSize = 1)
 public class Member {
  @Id
  @GeneratedValue (strategy = GenerationType.TABLE,
  					generator = "MEMBER_SEQ_GENERATOR")
  private Long id;
}

이를 사용하면, SEQUENCE_TABLE에 @TableGenrator.pkColumnValue에서 지정한 MEMBER_SEQ가 컬럼명으로 추가된 것을 확인할 수 있다. 그리고 키 생성기를 사용할 때마다 next_val 컬럼 값이 allocationSize로 등록된 만큼 증가할 것이다. 참고로 SEQUENCE_TABLE에 값이 없으면 JPA가 값을 INSERT하면서 초기화하므로 값을 미리 넣어둘 필요는 없다.

TABLE전략을 사용하면 SEQUENCE 전략과 유사하게, DB 시퀀스 생성용 테이블에서 식별자 값을 획득한 후에 영속성 컨텍스트에 저장하게 된다.

@TableGenerator 속성은 다음과 같다.

속성	기능	기본값
name	식별자 생성기 이름	필수
table	키 생성 테이블 명	hibernate_sequences
pkColumnName	시퀀스 컬럼명	sequence_name
valueColumnName	시퀀스 값 컬럼명	next_val
pkColumnValue	키로 사용할 값 이름	엔티티 이름
initalValue	초기 값. 마지막으로 생성된 값이 기준	0
allocationSize	시퀀스 한 번 호출에 증가하는 수	50

AUTO 전략
GenerationType.AUTO를 하면, 선택한 데이터베이스 방언에 따라 INDENTITY, SEQUENCE, TABLE 전략 중 하나를 자동을 선택하게 된다.
예를 들어 MySQL을 선택하면 IDNETITY 를 오라클을 선택하면 SEQUENCE 를 선택하게 된다.
AUTO 전략을 사용하면, 데이터베이스를 변경해도 코드를 수정할 필요가 없다는 장점이 있다.

더 알아보기 : 식별자 선택 전략 (자연키 vs 대리키)
자연키는 주민등록번호처럼 비즈니스에 의미가 있는 키를 말한다.
대리키는 auto_increment처럼 비즈니스와 관련 없는 임의로 만들어진 키를 말한다.
비즈니스 환경은 언젠가는 변화하기 때문에, 자연키보다는 대리 키를 권장한다.
주민번호 또한 변경될 수도 있고, 정책 상 주민번호를 저장할 수 없게 될 수도 있기 때문이다.

필드와 컬럼 매핑

자주 사용되는 어노테이션을 기준으로 간단히 살펴보겠다.

@Column

속성	기능	기본값
name	매핑 할 테이블 컬럼 이름	객체의 필드 이름
nullable(DDL)	null 값의 허용 여부를 설정	true
unique(DDL)	한 컬럼에 간단히 유니크 제약조건을 걸 때 사용
columnDefinition(DDL)	DB 컬럼 정보를 직접 줄 수 있다	필드의 자바 타입과 방언 정보를 사용해 적절한 컬럼 타입을 생성
length(DDL)	문자 길이 제약 조건. String 타입에서만 사용	255
precision,scale(DDL)	BigDecimal, BigInteger 타입에서만 사용. precision은 소수점을 포함한 전체 자릿수를 scale은 소수의 자릿수를 표현	precision19, scale= 2

사용 예시는 아래와 같다.

@Column(nullable = false, unique = true, length=400)
private String userName;

// not null, unique 제약 조건, 문자 길이 제약 조건이 추가된다.

@Column (columnDifinition = "varchar(100) default 'String'")
private String userName2;

//방언 정보에 따라 적절히 제약 조건이 추가도니다.

@Column (precision = 10, scale =2)
private BigDecimal cal;

// MySql의 경우 cal decimal(10,2)와 같이 조건이 추가된다.

이제 아래 표에 있는 어노테이션들의 예시들을 하나씩 살펴보겠다.

매핑 어노테이션	설명
@Enumerated	자바의 enum 타입을 매핑
@Temporal	날짜 타입을 매핑
@Lob	BlOB, CLOB 타입을 매핑
@Transient	특정 필드를 데이터베이스에 매핑하지 않음

//**** @Enumerated
//@Enumerated value 에는 EnumType.ORDINAL (enum 순서를 db에 저장)
// EnumType.STRING (enum 이름을 db에 저장)이 있다.

@Enumerated(EnumType.STRING)
private RoleType roleType;
//-----------------------------------------

//**** @Temporal
@Temporal (TemporalType.DATE)
private Date date; //2024-11-24과 같이 db date type과 매핑

@Temporal (TemporalType.TIME)
private Date time; // 12:20:11 과 같이 db time type과 매핑

@Temporal (TemporalType.TIMESTAMP)
private Date date; // 2024-11-24 12:20:11 와 같이 db timestamp type 과 매핑

//참고로 @Temporal을 생략하면 자바의 Date와 가장 유사한 timestamp로 정의됨.
//mySQL의 경우 datetime
//-----------------------------------------


//**** @Lob
// String,char[] 처럼 문자면 CLOB으로 매핑
// byte[] 와 같이 나머지는 BLOB으로 매핑

@Lob
private String lobString;
//-----------------------------------------

//**** @Transient
// 매핑하지 않음. 따라서 DB에 저장되지도, 조회되지도 않음. 객체에 임시로 어떤 값을 보관하고 싶을 때 사용

@Transient
private int temp;

마지막으로 @Access 어노테이션을 알아보겠다.
JPA가 엔티티 데이터에 접근하는 방식을 지정하는 것이다.

필드 접근 : AccessType.FIELD로 지정. 필드에 직접 접근하며, 필드 접근 권한이 private 이어도 접근할 수 있음.
프로퍼티 접근 : AccessType.PROPERTY로 지정. 접근자(getter)를 사용.

@Access를 사용하지 않으면 @Id위 위치를 기준으로 접근 방식이 설정된다.


@Id
private String id; // @ID가 필드에 있으므로, 자동으로  AccessType.FIELD로 설정된다.
//-------------------------

private String id;
@Id
public String getId(){
	return id;
} //@Id가 프로퍼티에 있으므로AccessType.PROPERTY 로 설정된다.