Orm 표준 jpa 프로그래밍 (2) - 엔티티 매핑
- 객체와 테이블 매핑: @Entity, @Table
- 필드와 컬럼 매핑: @Column
- 기본 키 매핑: @Id
- 연관관계 매핑: @ManyToOne, @JoinColumn, ...
1. @Entity
- @Entity가 붙은 클래스는 jpa가 관리하고, 엔티티라 부른다.
- jpa를 사용해서 테이블과 매핑할 클래스는 @Entity 필수
주의점
1. 기본 생성자 필수( 파라미터가 없는 public 또는 protected 생성자 )
2. final 클래스, enum, interface, inner 클래스는 사용하지 않는다
3. 저장할 필드에 final 사용하지 않는다.
속성
1. name: jpa에서 사용할 엔티티 이름을 지정하며, 기본값으로 클래스 이름을 그대로 사용하고, 중복된 이름의 클래스가 존재하지 않는다면 가급적 기본값을 사용한다.
2. @Table
- 엔티티와 매핑할 테이블을 지정한다.
속성
1. name: 매핑할 테이블 이름을 작성 (기본값으로 엔티티 이름을 사용함)
2. catalog: 데이터베이스 catalog 매핑
3. schema: 데이터베이스 schema 매핑
4. uniqueConstraints: DDL 생성 시에 유니크 제약 조건 생성
3. 데이터베이스 스키마 자동 생성
- DDL을 어플리케이션 실행 시점에 자동 생성
- 테이블 중심 >> 객체 중심
- 데이터베이스 dialect를 활용해서 데이터베이스에 맞는 적절한 DDL 생성
- 이렇게 생성된 DDL은 '개발' 장비에서만 사용 (생성된 DDL은 운영서버에서는 사용하지 않거나 적절히 다듬어 사용)
속성(hibernate.hbm2ddl.auto)
1. create: 기존테이블 삭제 후 다시 생성
2. create-drop: create와 같으나 '종료 시점'에 테이블 drop
3. update: 변경분만 반영됨 (운영DB에는 사용X)
4. validate: 엔티티와 테이블이 정상 매핑되었는지만 확인
5. none: 사용 X
- 운영 장비에는 절대 create / create-drop / update 사용하면 안됨
- 개발 초기 단계에는 create 또는 update
- 테스트 서버는 update 또는 validate
- 스테이징과 운영 서버는 validate 또는 none
DDL 생성 기능
@Column(nullable = false, length = 10)
// 제약조건 추가: 회원 이름은 필수, 10자 초과X
@Table(uniqueConstraints = {@UniqueConstraint( name = "NAME_AGE_UNIQUE",
columnNames = {"NAME", "AGE"} )})
// 유니크 제약조건 추가- DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않음
4. 필드와 컬럼 매핑
매핑 어노테이션(hibernate.hbm2ddl.auto)
1. @Column: 컬럼 매핑
2. @Temporal: 날짜 타입 매핑
3. @Enumerated: enum 타입 매핑
4. @Lob: BLOB / CLOB 매핑
5. @Transient: 특정 필드를 컬럼에 매핑하지 않음(매핑 무시)
4-1. @Column
- name: 필드와 매핑할 테이블의 컬럼 이름(기본값: 객체의 필드 이름)
- insertable / updateable: 등록, 변경 가능 여부
- nullable(DDL): null 값의 허용 여부를 설정, false로 설정하면 DDL 생성 시에 not null 제약조건이 붙음
- 이외에도 여러 속성들이 존재함
4-2. @Enumerated
- 자바 enum 타입을 매핑할 때 사용
속성: value ( EnumType.STRING: enum 이름을 데이터베이스에 저장, 기본값은 EnumType.ORDINAL )
4-3. @Temporal
- 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용
- LocalDate, LocalDateTime을 사용할 때는 생략 가능(최신 하이버네이트 지원)
ex)
- TemporalType.DATE: 날짜, 데이터베이스 date 타입과 매핑( 2023-05-08 )
- TemporalType.TIME: 시간, 데이터베이스 time 타입과 매핑( 16:33:58 )
- TemporalType.TIMESTAMP: 날짜와 시간, 데이터베이스 timestamp 타입과 매핑( 2023-05-08 16:33:58 )
4-4. @Lob
- @Lob에는 지정할 수 있는 속성이 없음
- 매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB 매핑
4-5. @Transient
- 필드 매핑이 되지 않고, 데이터베이스에 저장과 조회가 되지 않는다.
- 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용
@Transient
private Integer temp;
5. 기본 키 매핑
1. @Id
2. @GenaratedValue
@Id @GeneratedValue(strategy = GenerationType.AUTO)
private Long id;매핑 방법
- 직접 할당: @Id만 사용
- 자동 생성( @GeneratedValue ):
1. IDENTITY: DB에 위임(MYSQL 사용)
2. SEQUENCE: DB 시퀀스 오브젝트 사용(ORACLE 사용, @SequenceGenerator 필요)
3. TABLE: 키 생성용 테이블 사용(모든 DB에서 사용, @TableGenerator 필요)
4. AUTO: dialect에 따라 자동 지정 (기본값)
5-1. IDENTITY 전략의 특징
- 기본 키 생성을 DB에 위임
- 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용 (예: MySQL의 AUTO_ INCREMENT)
- jpa는 보통 트랜잭션 커밋 시점에 insert sql 실행, AUTO_ INCREMENT는 db에 insert sql을 실행한 이후에 id값을 알 수 있음
- IDENTITY 전략은 em.persist() 시점에 즉시 insert sql을 실행하고 db에서 식별자를 조회
public class Member {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
...
}
5-2. SEQUENCE 전략의 특징
- DB 시퀀스는 유일한 값을 순서대로 생성하는 특별한 DB 오브젝트 (ex: 오라클 시퀀스)
- 오라클, 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;
@SequenceGenerator 의 속성
1. name: 식별자 생성기 이름(필수값)
2. sequenceName: DB에 등록되어 있는 시퀀스 이름 (기본값: hibernate_sequence)
3. initialValue: DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 1 시작하는 수를 지정 (기본값 1)
4. allocationSize: 시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값 을 반드시 1로 설정, 기본값 = 50 )
5. catalog, schema: 데이터베이스 catalog, schema 이름
5-3. Table 전략의 특징
- 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉 내내는 전략 (장점은 모든 DB에 적용 가능한 것이고 단점은 성능)
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의 속성
1. name: 식별자 생성기 이름 (필수값)
2. table: 키생성 테이블 명 (기본값: hibernate_sequences)
3. pkColumnName: 시퀀스 컬럼명 (기본값: sequence_name)
4. valueColumnName: 시퀀스 값 컬럼명 (기본값: next_val)
5. pkColumnValue: 키로 사용할 값 이름 (기본값: 엔티티 이름)
6. initialvalue: 초기 값, 마지막으로 생성된 값이 기준 (기본값: 0)
7. allocationSize: 시퀀스 한번 호출에 증가하는 수(성능 최적화에 사용, 기본값: 50)
8. catalog / schema: DB 카탈로그 / 스키마 이름
9. uniqueConstraints: 유니크 제약 조건 지정
6. 권장 식별자 전략
- 기본키 제약 조건은 null이 아니며, 유일해야 하고, 변하면 안됨
- Long 형 + 대체키 + 키 생성전략 사용