[JPA] 엔티티 매핑

엔티티 매핑 소개

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

 

객체와 테이블 매핑

@Entity

• @Entity가 붙은 클래스는 JPA가 관리. 엔티티라 한다.
• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity가 필수로 붙여야 한다.

 

@Entity 사용 시 주의점

• 기본 생성자 필수이므로 임의 생성자 생성 시 기본 생성자를 설정해줘야 한다.
  (파라미터가 없는 public 또는 protected 생성자)
• final 클래스, eumn, interface, inner 클래스에는 사용할 수 없다.
• DB에 저장할 필드에 final을 사용할 수 없다.

 

@Entity 속성

• name
  • JPA에서 사용할 엔티티 이름을 지정한다.
  • 기본값 : 클래스 이름을 그대로 사용
  • 같은 클래스 이름이 없으면 가급적 기본값을 사용한다.

 

@Table

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

 

@Table 속성

• name : 매핑할 테이블 이름을 지정한다. 지정하지 않으면 엔티티 이름을 테이블 이름으로 사용한다.
• catalog : 데이터베이스 catalog를 매핑한다.
• schema : 데이터베이스 schema를 매핑한다. 
• uniqueConstraints : DDL 생성 시에 유니크 제약 조건을 생성한다.

 

 

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

• DDL을 애플리케이션 실행 시점에 자동 생성하게 설정할 수 있다.
• 객체 매핑을 해놓으면 테이블을 다 만들어주기 때문에 테이블 중심이 아닌 객체 중심으로 개발할 수 있다.
• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL을 생성한다.
• 생성된 DDL은 운영서버에서는 사용하지 않거나, 필요한 경우 적절히 다듬 은 후 사용하는 것을 권장한다.

 

hibernate.hbm2ddl.auto 옵션

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

 

hibernate.hbm2ddl.auto 옵션 주의점

• 운영장비에는 절대 create, create-drop, update를 사용하면 안 된다.
• 개발 초기 단계는 create 또는 update
• 테스트 서버는 update 또는 validate
• 스테이징 운영 서버는 validate 또는 none
• 결론은 로컬서버에서만 사용하고 여러 명이 사용하는 개발서버나 스테이징 운영서버에는 사용하지 않는 것을 권장한다.

 

 

필드와 컬럼 매핑

매핑 어노테이션 정리

• @Column : 컬럼 매핑
• @Temporal : 날짜 매핑
• @Enumerated : enum 타입 매핑
• @Lob : BLOB, CLOB 매핑
• @Transient : 특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

 

@Column 

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

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

 

 

@Eunmerated

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

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

@Enumerated(EnumType.STRING) 
private RoleType roleType;

주의 :
ORDINAL은 사용하지 않는 게 좋다. enum 순서를 데이터베이스에 저장하기 때문에 enum 순서가 변경되었을 경우 이전에 저장된 데이터와 변경된 데이터가 같게 설정된다. ORDINAL은 사용하지 말자.

 

 

@Temporal

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

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

@Temporal(TemporalType.TIMESTAMP) 
private Date createdDate;
	 
@Temporal(TemporalType.TIMESTAMP) 
private Date lastModifiedDate;
	 
private LocalDate testLocalDate;
private LocalDateTime testLocalDateTime;

참고 : 
java 1.8 이상부터 LocalDate, LocalDateTime을 사용할 때는 생략가능하다. Hibernate가 타입을 보고 자동으로 타입과 매핑해 준다.

 

 

@Lob

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

@Lob 
private String description;

 

@Transient 

• 필드와 매핑하고 싶지 않을 때 사용한다.
• 데이터베이스에 저장 및 조회되지 않는다.
• 주로 메모리상에서만 임시로 값을 저장하고 싶을 때 사용한다.

@Transient
private Integer temp;

 

 

기본 키 매핑

기본 키 매핑 방법

직접 할당 : @Id만 사용

자동 생성 : @GeneratedValue

 

 

IDENTITY 전략

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

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

참고 : 
JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행한다. AUTO_ INCREMENT는 데이터베이스에 INSERT SQL을 실행 한 이후에 ID 값을 알 수 있다.
IDENTITY 전략은 트랜잭션 커밋시점이 아닌 em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자를 조회한다.

 

 

SEQUENCE 전략

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

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

 

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

참고 : 
SEQUENCE 전략 일 경우 em.persist() 시점에 DB에서 시퀀스를 조회하여 영속성 컨텍스트에 넣는다.
트랜잭션 커밋시점에 SQL이 실행된다.

참고 : allocationSize
initialValue = 1, allocationSize = 50 으로 설정해 두었다고 하면,  1부터 50까지 시퀀스를 미리 데이터베이스에서 가져와 메모리에 넣어두기 때문에 데이터 생성 시 DB에서 시퀀스를 조회해오지 않고 메모리에서 가져온다. 시퀀스가 50이 넘어가면 그때 DB에서 51부터 100까지 가져온다.(allocationSize 범위만큼)

 

 

TABLE 전략

• 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내 내는 전략
• 장점 : 모든 데이터베이스에 적용 가능
• 단점 : 성능 저하

@Entity
@Getter @Setter
@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;

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

 

 

권장하는 식별자 전략

• 기본 키 제약 조건 : not null, unique, 변하면 안 된다.
• 미래까지 이 조건을 만족하는 자연키를 찾기 어렵다. 대체키를 사용하자.
• 예를 들어 주민등록번호도 기본 키로 적절하지 않다.
• 권장 : Long형 + 대체키 + 키 생성 전략 사용

 

 

 

---

해당 글은 인프런의 [자바 ORM 표준 JPA 프로그래밍 - 기본편] 강의를 정리한 내용입니다.

자바 ORM 표준 JPA 프로그래밍 - 기본편 - 인프런 | 강의