본문 바로가기

BackEnd/JPA

[JPA] 엔티티 매핑

객체와 테이블 매핑

 @Entity

  • @Entity가 붙은 클래스는 JPA가 관리하는 엔티티라 한다.
  • @Entity 속성 name : JPA에서 사용할 엔티티 이름을 지정한다. (기본값 : 클래스명)
  • 주의
    - 기본 생성자 필수 (파라미터가 없는 public 또는 protected 생성자)
    - final 클래스, enum, interface, inner 클래스는 사용할 수 없다.
    - 저장할 필드에 final을 사용할 수 없다.

 @Table

  • @Table은 엔티티와 매핑할 테이블을 지정한다.
  • 속성 name : 매핑할 테이블 이름 (기본값 : 엔티티 이름을 사용)
  • 속성 catalog/schema : 데이터베이스 catalog/schema 매핑
  • 속성 uniqueConstraints(DDL) : DDL 생성 시에 유니크 제약 조건 생성

 

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

  • 하이버네이트는 DDL을 애플리케이션 실행 시점에서 자동으로 생성할 수 있다.
  • 테이블 중심 ⇒ 객체 중심
  • 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL을 생성한다.
  • 이렇게 생성된 DDL은 개발 장비에서만 사용해야 한다. (운영X)
  • 생성된 DDL은 운영서버에서는 사용되지 않거나, 적절히 다듬은 후 사용할 수 있다.

 hibernate.hbm2ddl.auto 속성

  • create : 기존테이블 삭제 후 다시 생성 (DROP + CREATE)
  • create + drop : create와 같으나 종료시점에 테이블 DROP
  • update : 변경분만 반영 (운영DB에는 사용하면 위험(테이블 락 가능))
  • validate : 엔티티와 테이블이 정상 매핑되었는지만 확인
  • none : 사용하지 않음.

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

  • 운영 장비에는 절대 create, create-drop, update 사용 불가.
  • 개발 초기 단계(create, update), 테스트 단계(update, validate), 스테이징과 운영서버(validate, none)

 DDL 생성 기능

  • 제약조건 추가 : 필수, 글자 수 제한
    @Column(nullable = false, length = 10)​
     
  • 유니크 제약조건 추가
  • DDL 생성 기능 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향이 없다.
    @Table(uniqueConstraints = { @uniqueConstraints( name = "NAME_AGE_UNIQUE"
                                                   , columnNames = {"NAME", "AGE"})})​
     

필드와 컬럼 매핑

 매핑 어노테이션 정리 (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) : 데이터베이스 컬럼 정보를 직접 줄 수 있다.
    @Column(columnDefinition="varchar(100) default 'EMPTY'")
    private String name;​
     
  • length(DDL) : 문자 길이 제약조건, String 타입에서만 사용한다. (기본값 : 255)
  • precision, scale(DDL) : BigDecimal, BigInteger 타입에서만 사용되며 아주 큰 숫자나 정밀한 소수를 다룰 때 사용한다.
    - precision : 소수점을 포함한 전체 자릿 수 (기본값 : 19)
    - scale : 소수의 자릿 수 (기본값 : 2)

 

 @Enumerated

  • 자바의 enum 타입을 매핑할 때 사용한다.
  • 속성 value : 기본값 EnumType.ORDINAL
    - EnumType.ORDINAL : enum 순서를 데이터베이스에 저장한다.
    - EnumType.STRING : enum 이름을 데이터베이스에 저장한다.
    - ORDINAL은 순서이므로 ENUM이 추가될 경우 데이터가 회손될 수 있어 사용을 금한다.

 @Temporal

  • 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용한다.
  • 참고 : LocalDate, LocalDateTime을 사용 시 생략가능(최신 하이버네이트 지원)
  • value 속성
    - TemporalType.DATE : 날짜, DB date 타입과 매핑 (YYYY-MM-DD)
    - TemporalType.TIME : 시간, DB time 타입과 매핑 (HH:MM:SS)
    - TemporalType.DATESTAMP : 날짜와 시간, DB timestamp 타입과 매핑(YYYYY-MM-DD HH:MM:SS)

 @Lob

  • 데이터베이스 BLOB, CLOB 타입과 매핑한다.
  • 매핑하는 필드 타입이 문자면 CLOB매핑, 나머지는 BLOB 매핑
    - CLOB : String, char[], java.sql.CLOB
    - BLOB : byte[], java.sql.BLOB

 @Transient

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

기본 키 매핑

 기본 키 매핑 어노테이션

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

 기본 키 매핑 방법

  • 직접 할당 : @Id만 사용
  • 자동생성(@GeneratedValue)의 strategy GenerationType의 속성
    - IDENTITY : 데이터베이스에 위임, MYSQL
    - SEQUENCE : 데이터 베이스 시퀀스 오브젝트를 사용(@SequenceGenerator 필요), ORACLE
    - TABLE : 키 생성용 테이블을 사용, 모든 DB에서 사용(@TableGenerator 필요)
    - AUTO : 방언에 따라 자동 지정, 기본값(strategy를 안넣었을 경우 기본 값으로 설정)

 IDENTITY 전략 - 특징

@Entity
public class Member {
	@Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long Id;
	...
}
  • 기본 키 생성을 데이터베이스에 위임하며 주로 Mysql, PostgreSQL, SQL Server, DB2에서 사용한다.
  • JPA는 보통 트랜잭션 커밋 시점에서 INSERT SQL을 실행한다.
  • AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있다.
  • IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL을 실행해 DB에서 식별자를 조회한다.

 SEQUENCE 전략 - 특징

  • 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트이다.(ex) 오라클 시퀀스)
  • 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용한다.
  • 여러 웹 서버가 있어도 동시성 이슈가 발생하지 않는다.

 SEQUENCE - @SequenceGenerator

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

  SEQUENCE 전력과 최적화(Feat. allocationSize)

@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;
    
    private String userName;
    ...
}

 

 

 

하이버네이트는 최초 식별자 값을 확인하기 위해 call next value를 부른다.  당연히 value는 1일 것이다.

그리고 call next value를 다시 불러 시퀀스 값의 범위를 할당한다. (1 ~ 51)

 

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

 @TableGenerator 속성

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

 

 권장하는 식별자 전략

  • 기본 키 제약 조건 : null 아님, 유일, 변하면 안된다.(시스템이 없어질 때까지)
  • 미래까지 이 조건을 만족하는 자연키는 찾기 어렵다.  대리키(대체키)를 사용하자.
  • 예를 들어 주민등록번호도 기본 키로 적절하지 않다.
  • 권장 : Long형 + 대체키 + 키 생성전략 사용