[JPA] 자바 ORM 표준 JPA 프로그래밍 : 엔티티 매핑

엔티티 매핑 소개

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

객체와 테이블 매핑

@Entity

• @Entity가 붙은 클래스는 JPA가 관리하는 엔티티. 그 외에는 관리하지 않는 자유롭게 사용되는 클래스
• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 필수로 붙여줘야 함 !
• 주의할 점
  • 기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자) → reflection 등으로 기능이 추가되기 때문
  • final 클래스, enum, interface, inner 클래스 사용 불가
  • DB에 저장할 필드에 final 사용 불가
• @Entity annotation 속성 정리
  • name
    • JPA에서 사용할 엔티티 이름을 지정한다.
    • 기본값 : 클래스 이름을 그대로 사용 (예: Member)
    • 같은 클래스 이름이 없으면 가급적 기본값을 사용한다. ( 다른 패키지에 이미 Entity 이름이 사용 중일 때 정도만 다른 이름으로 매핑)
    • @Entity(name = "HomePageMember") public class Member() { }
• @Table annotation : 엔티티와 매핑할 테이블 지정 (index 정보는 가급적이면 명시해주는 게 좋음)

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

@Entity
@Table(name = "MBR", catalog = "catalog", schema = "schema")
public class Member() {
		
}

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

• DDL을 애플리케이션 실행(로딩) 시점에 자동 생성
• 테이블 중심 → 객체 중심
• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
• 생성된 DDL은 개발 장비에서만 사용 (운영서버 사용 X)
• 생성된 DDL은 운영서버에서는 사용하지 않거나 적절히 다듬은 후 사용
• 속성 (hbm2ddl.auto)

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

<!-- persistence.xml  -->
<property name="hibernate.hbm2ddl.auto" value="create" />

 

데이터베이스 스키마 자동 생성의 주의할 점

• 운영 장비에는 절대 create, create-drop, update 사용하면 안된다.스키마 변경은 DBA와 충분히 논의 후 권한 있는 유저가 직접 반영하는 것이 좋음
• app loading 시점에 자동으로 스키마 변경을 일으키는건 장애 날 여지가 있기 때문!
• 개발 초기 단계는 create 또는 update
• 테스트 서버는 update 또는 validate
• 스테이징과 운영 서버는 validate 또는 none

DDL 생성 기능

• 제약조건 추가 : 회원 이름은 필수, 10자 초과 불가

@Column(nullable = false, length = 10) 

• 유니크 제약조건 추가

@Table(uniqueConstraints = {@UniqueConstraint( name = "NAME_AGE_UNIQUE",
																							columnNames = {"NAME", "AGE"})})

• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않음
• ALTER SCRIPT가 생성/실행될 때만 도와줌. 즉 DB관련된 작업. JPA 실행 중일 때와는 관련 없는 작업

필드와 컬럼 매핑

매핑 어노테이션 정리

hibernate.hbm2ddl.auto

어노테이션	설명
@Column	컬럼 매핑
@Temporal	날짜 타입 매핑
@Enumerate	enum 타입 매핑
@Lob	BLOB, CLOB 매핑
@Transient	특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

@Entity
public class Member {
    @Id //PK Mapping
    private Long id;

    @Column(name = "name") // 객체와 DB Column명이 다를 때
    private String username;

    private Integer age;     // Integer와 가장 적절한 숫자 타입이 DB column으로 생성됨

    @Enumerated(EnumType.STRING)
    private RoleType roleType;  // Enum은 DB에 없기 때문에 Enumerated annotation 적용하면 됨
																// 생성은 가장 가까운 타입으로 매핑됨 (varchar 등) 

    @Temporal(TemporalType.TIMESTAMP)   // 날짜 타입 매 (date, time, timestamp 중 선택 필)
    private Date createdDate;

    @Temporal(TemporalType.TIMESTAMP)
    private Date lastModifiedDate;

    @Lob
    private String description;     //@Lab anno 붙이고 문자 타입이면 기본적으로 CLOB column 생성

		@Transient
    private int temp // DB columnr과 연결 안함
}

 

@Column : 가급적이면 length 등 속성 조건 명시하는 걸 선호

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

@Column(name = "name", nullable = false, columnDefinition = "varchar(100), default 'EMPTY'") // 객체와 DB Column명이 다를 때
private String username;

 

@ Enumerated

• 자바 enum 타입을 매핑할 때 사용.
  • ORDINAL 사용X (주의!) : enum 추가했을 때 문제 발생
  • 이름을 저장하도록 하기 !!(STRING)

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

 

@Temporal

• 날짜 타입(java.util.Date, java.util.Calendar) 을 매핑할 때 사용
• LocalDate, LocalDateTime을 사용할 때는 생략 가능 ( 최신 하이버네이트 지원 )

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

@Temporal(TemporalType.TIMESTAMP)   // 날짜 타입 매 (date, time, timestamp 중 선택 필)
private Date createdDate;

private LocalDate modifiedDate;     // DB date type으로 생성됨

private LocalDateTime modidedDateTest;  // DB timeStamp type으로 생성됨

 

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

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

  @Lob
  private String description;     //@Lab anno 붙이고 문자 타입이면 기본적으로 CLOB column 생성
  

@Transient

• 필드 매핑 안하고 싶을 때
• 데이터베이스에 저장하지 않고, 조회하지 않을 때
• 주로 메모리상에서만 임시롤 어떤 값을 보관하고 싶을 때 사용

@Transient      // DB column과 연결 안함
private int temp;

 

기본 키 매핑

기본 키 매핑 어노테이션

• @Id
• @GeneratedValue

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

기본 키 매핑 방법

• 직접 할당 : @Id만 사용
• 자동 생성(@GeneratedValue)
  • IDENTITY: 기본 키 생성을 데이터베이스에 위임, (예. MYSQL의 auto_increment)
  • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE @SequenceGenerator 필요
  • TABLE : 키 생성용 테이블 사용, 모든 DB에서 사용. 테이블을 직접 사용하기 때문에 LOCK 등 성능 이슈 발생 가능성 있음
    • @TableGenerator 필요
  • AUTO : 방언에 따라 자동 지정, 기본값

IDENTITY 전략 - 특징

• 기본 키 생성을 데이터베이스에 위임
• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용 (예. MYSQL의 auto_increment)
• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
• AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID값을 알 수 있음
  • DB에 들어가야만 PK를 알 수 있음. 하지만 1차 캐시 내 @Id가 DB의 PK이기 때문에 기본키는 JPA가 필수로 알고 있어야 하는 값임!
• 따라서!! IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자를 조회

// IDENTITY 전략 - 매핑
@Id @GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

SEQUENCE 전략 - 특징

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트 (예: 오라클 시퀀스)
• 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용
• SEQUENCE 전략일 때는 영속성 컨텍스트에 객체 저장될 때 sequence값만 얻어와서 해당 키를 가지고 유지하다가 commit 시점에 insert SQL 날린다.

// SEQUENCE 전략 - 매핑
@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;

속성	설명	기본값
name	식별자 생성기 이름	필수
sequenceName	데이터베이스에 등록되어 있는 시퀀스 이름	hibernate_sequences
initalValue	DDL 생성 시에만 사용됨. 시퀀스는 DDL을 생성할 때 처음 1 시작하는 수를 지정한다.
allocationSize	시퀀스 한 번 호출에 증가하는 수 (성능 최적화에 사용됨) was 많이 떠 있어도 동시성 이슈 없이 저장이 가능 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값을 반드시 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;

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

 

권장하는 식별자 전략

• 기본 키 제약 조건 : null 안됨. 유일, 변하면 안됨
• 미래까지 이 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대체키)를 사용하자.
• 예를 들어 주민등록번호도 기본 키로 적절하지 않다. (외부 정책 변경 이슈)
• 권장 : Long형 + 대체키 + 키 생성전략 사용

 

출처 : 자바 ORM 표준 JPA 프로그래밍-기본편 (김영한), 자바 ORM 표준 JPA 프로그래밍(김영한 저)