[JPA] 엔티티 매핑

 

엔티티 매핑 소개

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

2. 필드와 컬럼 매핑: @Column

3. 기본 키 매핑: @Id
4. 연관관계 매핑: @ManyToOne, @JoinColumn

 

 

 

1. 객체와 테이블 매핑

@Entity

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

 

✕ 주의

•기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자)

•final 클래스, enum, interface, inner 클래스 사용X

•저장할 필드에 final 사용 X

 

 

@Entity 속성 정리

▸ 속성: name

JPA에서 사용할 엔티티 이름을 지정한다. 일반적으로 사용할 일이 거의 없다. 예를 들어 다른 패키지에 같은 이름의 클래스가 있고 JPA매핑이 되어있는 경우에 사용한다.

 

기본값: 클래스 이름을 그대로 사용(예: Member)
같은 클래스 이름이 없으면 가급적 기본값을 사용한다. 

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

    @Id
    private Long id;
    private String name;

}

 

 

@Table

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

 

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

 

Table(name="MBR")로 설정해주면 매핑할 때 from절에 설정된 테이블 이름으로 매핑 되는 것을 볼 수있다.

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

    @Id
    private Long id;
    private String name;

}

 

 

 

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

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

• 테이블 중심 -> 객체 중심

• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성

• 이렇게 생성된 DDL은 개발 장비에서만 사용

• 생성된 DDL은 운영서버에서는 사용하지 않거나, 적절히 다듬 은 후 사용 (주로, 개발 단계나 Local환경에서 도움이 됨)

 

hibernate.hbm2ddl.auto

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

 

persistence.xml에 설정 후 실행하면 기존 테이블을 DROP하고 새로 CREATE하는 것을 볼 수 있다.

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

DROP + CREATE

✕ 주의

• 운영 장비에는 절대 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의 실행 로직에는 영향을 주지 않는다.

 

 

 

2. 필드와 컬럼 매핑

요구사항 추가
1. 회원은 일반 회원과 관리자로 구분해야 한다.
2. 회원 가입일과 수정일이 있어야 한다.
3. 회원을 설명할 수 있는 필드가 있어야 한다.이 필드는 길이 제한이 없다.

 import javax.persistence.*; 
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.Date;
 
 @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;
    
    // Getter, Setter ...
}

실행결과 

---

❍ 매핑 어노테이션 정리

hibernate.hbm2ddl.auto

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

ORDINAL을 사용하면 enum순서를 DB에 저장하게 된다. (0 : USER, 1 : ADMIN)

EnumType ORDINAL일 경우

사용하면 안되는 이유는 만약 여기서 요구사항이 추가되어 EnumType이 추가되어 (0: GUEST, 1 : USER, 2: ADMIN)이 되었다면 어떻게 될까? 해결할 수 없는 버그가 발생한다!

 

아래의 데이터처럼 운영상에 이미 저장된 데이터 값과 새로 바뀐 데이터 값이 혼동되어 오류가 발생하게 된다. 

ID 1: USER,  ID 3 : GUSET

 

그래서 데이터를 조금 더 쓰더라도 처음부터 EnumType.STRING을 사용하는 것이 좋다.

@Enumerated(EnumType.STRING)
private RoleType roleType;

GUEST로 저장됨

 

 

@Temporal

날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용한다. (옛 버전에서만 사용)

 

참고: LocalDate, LocalDateTime을 사용할 때는 생략 가능(최신 하이버네이트 지원)

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

 

최신 버전을 사용한다면 그냥 LocalDate, LocalDateTime을 사용하면 된다.

@Temporal(TemporalType.TIMESTAMP)
private Date createdDate;

@Temporal(TemporalType.TIMESTAMP)
private Date lastModifiedDate;

// Java8이후 부터는 그냥 이거 쓰면됨 (Hibernate에서 지원)
private LocalDate testLocalDate;  // type : date 
private LocalDateTime testLocalDateTime;  // type : timestamp

 

 

@Lob

LOB은 TEXT, 그래픽, 이미지, 비디오, 사운드 등 구조화되지 않은 대형 데이터를 저장하는데 사용한다. 텍스트로는 Varchar보다 더 큰 데이터를 다룰 때 사용한다 .

 

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

•@Lob에는 지정할 수 있는 속성이 없다.

 

•매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB 매핑

    • CLOB: String, char[], java.sql.CLOB

          (문자 대형 객체 (Character). Oracle Server는 CLOB과 VARCHAR2 사이에 암시적 변환을 수행한다.)

 

    • BLOB: byte[], java.sql.BLOB

        (이진 대형 객체 (Binary). 이미지, 동영상, MP3 등...)

 

@Lob
private String description;

필드 타입이 문자(String)라서 clob으로 매핑

 

 

@Transient

필드와 매핑을 시키지 않는다.

주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용한다.

 

@Transient가 명시된 객체는 데이터베이스에 저장X, 조회X

@Entity
public class Member {

    @Id
    private Long id;

    @Column(name = "name", nullable = false)
    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;

    @Transient
    private Integer temp;
 }

 

temp는 DB에 생성되지 않은 것을 볼 수 있다.

 

 

 

3. 기본 키 매핑

기본 키 매핑 어노테이션

@Id

@GeneratedValue

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

 

기본 키 매핑 방법

▸  직접 할당: @Id만 사용
▸  자동 생성(@GeneratedValue)

     • IDENTITY: 데이터베이스에 위임, MYSQL
     • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE

               > @SequenceGenerator 필요
     • TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용

               > @TableGenerator 필요
     • AUTO: 방언에 따라 자동 지정, 기본값

 

 

IDENTITY 전략

▸  기본 키 생성을 데이터베이스에 위임

▸  주로 MySQL, PostgreSQL, SQL Server, 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;

자동으로 ID값 증가

 

> em.persist()시점에 바로 INSERT 쿼리를 날리기 때문에 한 번에 모든 쿼리를 모아서 INSERT하지 못하는게 단점

   (근데 모든 쿼리를 버퍼링해서 한 번에 DB에 write하는게 크게 메리트있지는 않음)

 

 

SEQUENCE 전략

▸  데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(예: 오라클 시퀀스)

▸  오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용

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

 

Table마다 Sequence를 따로 관리하고싶으면 @SequenceGenrator로 직접 설정하면 된다.

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

 

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

 

 

TABLE 전략

▸  키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉 내내는 전략

▸  장점: 모든 데이터베이스에 적용 가능

▸  단점: 성능

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

 

 

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

 

 

권장하는 식별자 전략

▸  기본 키 제약 조건: null 아님, 유일, 변하면 안된다.

▸  미래까지 이 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대체키)를 사용하자.

▸  예를 들어 주민등록번호도 기본 키로 적절하기 않다.

▸  권장: Long형 + 대체키 + 키 생성전략 사용

 

---

❈출처

인프런 김영한 개발자님 강의 - 자바 ORM 표준 JPA 프로그래밍