엔티티 매핑
엔티티 매핑 소개
- 객체와 테이블 매핑: @Entity, @Table
- 필드와 컬럼 매핑: @Column
- 기본 키 매핑: @Id
- 연관관계 매핑: @ManyToOne, @JoinColumn
객체와 테이블 매핑
@Entity
- @Entity 가 붙은 클래스는 JPA가 관리, 엔티티라 한다.
- JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 필수
주의 - 기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자) 왜? 리플렉션, 프록시 등을 이용하기 위해서 - final 클래스, enum, interface, inner 클래스 사용X - 저장할 필드에 final 사용X
@Entity 속성 정리
속성 : name
- JPA에서 사용할 엔티티 이름을 지정한다
- 기본값: 클래스 이름을 그대로 사용(예: Member)
- 같은 클래스 이름이 없으면 가급적 기본값을 사용한다
@Table
- @Table은 에티티와 매핑할 테이블 지정
속성 | 기능 | 기본값 |
---|---|---|
name | 매핑할 테이블 이름 | 엔티티 이름을 사용 |
catalog | 데이터베이스 catalog 매핑 | |
schema | 데이터베이스 schema 매핑 | |
uniqueConstraints(DDL) | DDL 생성 시에 유니크 제약 조건 생성 |
name 예시
@Entity
@Table(name = "MBR")
public class Member {
~~
}
데이터베이스 스키마 자동 생성
- DDL을 애플리케이션 실행 시점에 자동 생성
- 테이블 중심 -> 객체 중심
- 데이터베이스 방언(dialect)을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
- 이렇게 생성된 DDL은 개발 장비에서만 사용
- 생성된 DDL은 운영서버에서는 사용하지 않거나, 적절히 다음은 후 사용
데이터베이스 스키마 자동 생성 - 속성
hibernate.hbm2ddl.auto
<properties>
<property name="hibernate.hbm2ddl.auto" value="create"/>
</properties>
옵션 | 설명 | 비고 |
---|---|---|
create | 기존 테이블 삭제 후 다시 생성 (DROP + CREATE) | |
create-drop | create 와 같으나 Application 종료 시점에 테이블 DROP | 테스트 케이스 완료 후 깔끔하게 지우고 싶으면 사용 |
update | 변경분만 반영(운영DB에는 사용하면 안됨) | 필드 추가만 가능하고 지우는 경우에는 반영안됨 |
validate | 엔티티와 테이블이 정상 매핑되어있는지만 확인 | 다르면 서비스 실행 불가 |
none | 사용하지 않음 |
데이터베이스 스키마 자동 생성 - 주의점!! (중요)
운영 및 스테이징 장비에는 절대 create, create-drop, update 사용하면 안됨!!
- 개발 초기 단계는 create 또는 update
- 테스트 서버는 update 또는 validate
- 스테이징과 운영 서버는 validate 또는 none
서비스가 사용하는 DB계정은 ALTER, DROP 자체를 못하도록 권한 설정을 해 놓아야한다
그냥 "none" 로 사용하자!!
DDL 생성 기능
- 제약조건 추가: 회원 이름은 필수, 10자 초과X
@Entity
@Table(name = "MBR")
public class Member {
@Column(nullable = false, length = 10)
private String name;
}
- 유니크 제약조건 추가
@Entity
@Table(uniqueConstraints = {@UniqueConstraint( name = "NAME_AGE_UNIQUE",columnNames = {"NAME", "AGE"} )})
public class Member {
@Column(nullable = false, length = 10)
private String name;
}
- DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않는다
필드와 컬럼 매핑
매핑 어노테이션 정리
hibernate.hbm2ddl.auto
<properties>
<property name="hibernate.hbm2ddl.auto" value="create"/>
</properties>
어노테이션 | 설명 | 비고 |
---|---|---|
@Column | 컬럼 매핑 | |
@Temporal | 날짜 타입 매핑 | 기본적으로 DB는 DATE, TIME, TIMESTAMP 세가지로 분리하기 때문에 JAVA에서의 DATE 타입과 맞는 형식을 지정해줘야 한다. JAVA의 DATE타입은 TIMESTAMP |
@Enumerated | enum 타입 매핑 | |
@Lob | BLOB, CLOB 매핑 | |
@Transient | 특정 필드를 컬럼에 매핑하지 않음(매핑 무시) |
@Entity
public class Member {
@Id
private Long id;
@Column(name = "name")
private String name;
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 String tmp; // DB 테이블과 연동 제외됨
public Member() {
}
}
@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 |
name
@Column(name = "name")
private String username;
테이블 필드명이 username이 아닌 name 으로 맵핑됨
insertable, updatable
@Column(insertable = false, updatable = false)
private String username;
username 필드에 대해서는 이제 insert와 update가 불가능하게 막힘
nullable(DDL)
@Column(nullable = true)
private String username;
username 필드는 null값 비허용됨
unique(DDL)
@Column(unique = true)
private String username;
username 필드는 이제 한 테이블내의 고유값만 들어갈 수 있음 중복값 불가
unique 는 잘 안쓴다
왜? unique 를 사용하여 자동으로 만들어지는 제약조건의 이름 이 랜덤 난수로 생성된다.
ex) UK_AAWJE912ANSDASD1QWEASD
이렇게되면 제약조건 위배시 UK_AAWJE912ANSDASD1QWEASD 제약조건을 위배했습니다.
라는 식의 로그가 나올텐대
이름만 보고 무슨 목적의 제약조건인지 파악이 안된다.
그렇기 때문에 실질적으로 더 자주 쓰이는 방식은 아래의 방식이다
@Entity
@Table(uniqueConstranints = ~~~)
public class Member {
}
이렇게 하면 제약조건의 이름도 지정할 수 있다
columnDefinition(DDL)
@Column(columnDefinition = "varchar(100) default 'EMPTY'")
private String username;
테이블의 username 필드가 varchar(100) 으로 지정되고 default 값이 Empty로 지정된다
length(DDL)
@Column(length = 10)
private String username;
테이블의 username 필드가 varchar(10) 으로 지정된다
@Enumerated
자바 enum 타입을 매핑할 때 사용
주의! ORDINAL 사용 금지XXX!! 왜? Enum 타입을 추가될 때 Number는 언제든지 바뀔 수 있다. 예를 들어 A = 1, B = 2 인 상태에서 A = 1, C = 2, B = 3 이 될 수 있다
속성 | 설명 | 기본값 |
---|---|---|
value | EnumType.ORDINAL: enum 순서 를 데이터베이스에 저장, EnumType.STRING: enum 이름 을 데이터베이스에 저장 |
@Temporal
날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때만 사용
java8 에서 나온 LocalDate, LocalDateTime을 사용할 때는 생략 가능(최신 하이버네이트 지원)
속성 | 설명 | 기본값 |
---|---|---|
value | TemporalType.DATE: 날짜, 데이터베이스 date 타입과 매핑(예: 2013–10–11), TemporalType.TIME: 시간, 데이터베이스 time 타입과 매핑(예: 11:11:11), TemporalType.TIMESTAMP: 날짜와 시간, 데이터베이스 timestamp 타입과 매핑(예: 2013–10–11 11:11:11) |
그냥 무조건 java에서 날짜 타입은 LocalDate, LocalDateTime 써라!
@Lob
데이터베이스 BLOB, CLOB 타입과 매핑
- @Lob에는 지정할 수 있는 속성이 없다.
- 매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB 매핑
- CLOB: String, char[], java.sql.CLOB
- BLOB: byte[], java.sql. BLOB
@Transient
- 필드 매핑X
- 데이터베이스에 저장X, 조회X
- 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용
기본 키 매핑 방법
DB마다 다르다
• 직접 할당: @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에서 식별자를 조회
@Entity
public class Member {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
}
SEQUENCE 전략 - 특징
• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(예: 오라클 시퀀스)
• 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용
테이블마다 시퀀스를 따로 지정할 수 있음
@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;
}
SEQUENCE - @SequenceGenerator
속성
속성 | 설명 | 기본값 |
---|---|---|
name | 식별자 생성기 이름 | 필수 |
sequenceName | 데이터베이스에 등록되어 있는 시퀀스 이름 | hibernate_sequence |
initialValue | DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정한다. | 1 |
allocationSize | 시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨) 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 allocationSize를 반드시 1로 설정해야 한다 | 50 |
catalog, schema | 데이터베이스 catalog, schema 이름. |
TABLE 전략
• 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉 내내는 전략
• 장점: 모든 데이터베이스에 적용 가능
• 단점: 성능
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 이름 | |
uniqueConstraints(DDL) | 유니크 제약 조건을 지정할 수 있다. |
권장하는 식별자 전략
그냥 AUTO INCREMENT 사용해라
• 기본 키 제약 조건: null 아님, 유일, 변하면 안된다.
• 미래까지 이 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대 체키)를 사용하자.
• 예를 들어 주민등록번호도 기본 키로 적절하기 않다.
• 권장: Long형 + 대체키 + 키 생성전략 사용
중요 내용!
IDENTITY 전략을 사용하면 예외 적으로 Commit 이전에 Insert 쿼리가 실행된다
왜? ID 값이 정해지려면 DB에 INSERT 를 해야 정해짐.
JPA에서 영속성 컨텍스트(1차 캐싱) 을 위해서는 ID값이 필수임, 근데 INSERT 안하면 ID 값이 없기 때문에 일단 INSERT 먼저 때림
그렇다면 Bulk Insert와 같이 한번에 여러 insert를 하고 싶지만, JPA를 사용하면 불가능하다.
영한님 왈 : Buffer에 모아놨다가 Insert하는게 그다지 메리트 있지 않음, 트랜잭션이 여러번 실행되면 문제되지만 하나의 트랜잭션에서 여러번의 insert 호출은 큰 차이 없음
SEQUENCE 전략을 사용하면 em.persist(entity) 를 하면 SEQUENCE 객체로 부터 다음 값을 가져온다
IDENTITY 와는 다르게 insert commit단계에서 실행되서 Buffer에 모아놨다가 Insert하는게 가능하다
em.persist(entity) 를 하면 SEQUENCE 객체로 부터 다음 값을 가져오는 쿼리를 날리는데 매번 그러면 성능이슈가 발생하는거 아닌가?
allocationSize 를 사용하면 한번에 50개의 값을 셋팅해놓고 memory에서 카운팅하는 방법을 사용할 수 있다 즉 매번 SEQUENCE 값을 확이하지 않고 50번마다 확인함