엔티티 매핑
- 객체와 테이블 매핑 - @Entity, @Table
- 필드와 컬럼 매핑 - @Column
- 기본 키 매핑 : @Id
- 연관관계 매핑 : @ManyToOne, @JoinColumn
객체와 테이블 매핑
1. @Entity
- JPA가 @Entity 붙은 클래스를 관리
- 테이블과 매핑할 클래스는 @Entity 사용
주의
- 기본 생성자 필수
- final 클래스, enum, interface, inner 클래스 사용 못함
- 저장할 필드에 final 사용 안됨
속성
- name
사용할 엔티티 이름을 지정
기본값 - 클래스 이름을 그대로 사용
같은 클래스 이름이 없으면 가급적 기본값을 사용
@Table
- 엔티티와 매핑할 테이블 지정
속성
- name : 매핑할 테이블 이름
- catalog : 데이터베이스 catalog 매핑
- schema : 데이터베이스 schema 매핑
- uniqueConstraints(DDL) : DDL 생성 시에 유니크 제약 조건 생성
데이터베이스 스키마 자동 생성
-
DDL을 애플리케이션 실행 시점에 자동 생성
-
데이터베이스 방언(Dialect)을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
-
생성된 DDL은 개발 환경에서만 사용
-
운영서버에서는 사용하지 않거나, 적절히 다듬은 후 사용
속성
- create : 기존 테이블 삭제 후 다시 생성
(DROP + CREATE) - create-drop : create와 같으나 종료시점에 테이블 DROP
- update : 변경부분만 반영
- validate : 엔티티와 테이블이 정상 매핑되었는지만 확인
- none : 사용하지 않음
주의
- 운영 장비에는 절대 create, create-drop, update 사용하면 안됨
- 개발 초기 단계 : create 또는 update
- 테스트 서버 : update 또는 validate
- 스테이징과 운영 서버: validate 또는 none
DDL 생성 기능
-
제약 조건 추가, 유니크 제약조건 추가
ex) @Column(uniqe = true, length = 10) -
DDL을 자동 생성할 때만 사용되고, JPA의 실행 로직에는 영향을 주지 않음
필드와 컬럼 매핑
매핑 어노테이션
- @Column : 컬럼 매핑
- @Temporal : 날짜 타입 매핑
- @Enumerated : enum 타입 매핑
- @Lob : BLOP, CLOB 매핑
- @Transient : 특정 필드를 컬럼에 매핑하지 않음
1. @Coumn 속성
-
name : 필드와 매핑할 테이블의 컬럼 이름 (기본 값 : 객체의 필드 이름)
-
insertable, updatable : 등록, 변경 가능 여부 (기본값 : TRUE)
-
nullable(DDL) : null 값의 허용 여부를 설정 (false로 설정시 not null 제약 조건)
-
unique(DDL) : @Table 의 uniqueConstraints와 같지만 한 컬럼에 간단한 유니크 제약조건을 걸 때 사용 (보통은 @Table에서 사용)
-
columnDefinition(DDL) : 데이터베이스 컬럼 정보를 직접 줄 수 있음 ex) varchar(100) default 'EMPTY'
-
length(DDL) : 문장 길이 제약조건, String 타입에만 사용 (기본값 : 255)
-
precision, scale(DDL) : BigDecimal 타입에서 사용 (아주 큰 숫자나 정밀한 소수를 다루어야 할 때만 사용, 기본값 : precision=19, scale=2)
-> precision : 소수점을 포함한 전체 자릿수
-> scale : 소수의 자리수
-> 참고: double, float 타입에는 적용되지 않음
2. @Enumerated
value 속성
- EnumType.ORDINAL : enum 순서를 데이터베이스에 저장 (숫자로 저장, 운영환경에서 사용 X)
- EnumType.STRING : enum 이름을 데이터베이스에 저장
3. @Temporal
- 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용
- 최신 버전에서는 LocalDate, LocalDateTime을 사용할 때는 생략 가능
value
1. TemporalType.Date : 날짜, 데이터베이스 date 타입과 매핑(ex. 2022-07-28)
2. TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑 (ex. 23:22:22)
3. TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑 (ex. 2022-07-28 23:22:22)
4. @Lob
- 데이터베이스 BLOB, CLOB 타입과 매핑
- @Lob 에는 지정할 수 있는 속성이 없음
- CLOB 매핑 : 필드 타입이 문자일 때 (ex. String)
- BLOB 매핑 : 문자 외 타입일 때 (ex. byte[])
5. @Transient
- 필드 매핑 무시
- 데이터베이스에 저장 및 조회를 안함
- 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용
기본 키 매핑
1. @Id
- 직접 할당
2. @GeneratedValue
- 자동 생성
전략
- IDENTITY : 데이터베이스에 위임 (MYSQL)
- SQUENCE : 데이터베이스 시퀀스 오브젝트 사용 (Oracle)
-> @SequenceGenerator 필요 - TABLE : 키 생성용 테이블 사용, 모든 DB에서 사용
-> @TableGenerator 필요 - AUTO : 방언에 따라 자동 지정
1. IDENTITY 전략
- 기본 키 생성을 데이터베이스에 위임
- 주로 MySQL, PostgreSQL, SQL Server, DB2 에서 사용 (AUTO_INCREMENT)
- JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
- AUTO_INCREMENT 는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있음
- entityManager.persist( ) 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자 조회
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
val id: Long? = null,2. SEQUENCE 전략
- 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트 (ex. 오라클 시퀀스)
- Oracle, PostgreSQL, DB2, H2 데이터베이스에서 사용
- 테이블 마다 시퀀스를 따로 관리하고 싶으면 @SequenceGenerator를 사용
- IDENTITY 전략과 달리 commit 전에 Sequenc Value 를 가져온다.
@SequenceGenerator 속성
- name : 식별자 생성기 이름
- sequenceName : 데이터베이스에 등록되어 있는 시퀀스 이름
- initialValue : DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 시작하는 수를 지정
- allocationSize : 시퀀스 한 번 호출에 증가하는 수
(성능 최적화에 사용됨)- catalog, schema : 데이터베이스 catalog, schema 이름
@Entity
@SequenceGenerator(
name = "MEMBER_SEQ_GENERATOR",
sequenceName = "MEMBER_SEQ",
initialValue = 1,
allocationSize = 1
)
class Member(
@Id
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "MEMBER_SEQ_GENERATOR")
val id: Long = 0L,
@Column
var username: String
)3. TABLE 전략
- 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내내는 전략
- 장점 : 모든 데이터베이스에 적용 가능
- 단점 : 성능 이슈
@TableGenerator 속성
- name : 식별자 생성기 이름
- table : 키 생성 테이블 명
- pkColumnName : 시퀀스 컬럼명
- valueColumnName : 시퀀스 값 컬럼 명
- pkColumnValue : 키로 사용할 값 이름
- initailValue : 초기 값, 마지막으로 생성된 값이 기준
- allocationSize : 시퀀스 한 번 호출에 증가하는 수
- catalog, schema : 데이터베이스 catalog, schema 이름
- uniqueConstraints(DDL) : 유니크 제약조건 지정
@Entity
@TableGenerator(
name = "MEMBER_SEQ_GENERATOR",
table = "MY_SEQUENCES",
pkColumnValue = "MEMBER_SEQ",
allocationSize = 1
)
class Member(
@Id
@GeneratedValue(strategy = GenerationType.TABLE, generator = "MEMBER_SEQ_GENERATOR")
val id: Long = 0L
)권장 식별자 전략
- 기본 키 제약 조건 : null이 아니고, 유일하며 변하면 안됨
- 대리키(대체키)를 사용
- 권장 : Long 타입 + 대체키 + 키 생성 전략 사용
