[자바 ORM 표준] 엔티티 매핑

May 26, 2022 5 분 소요

엔티티 매핑 소개

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

객체와 테이블 매핑

@Entity

@Entity가 붙은 클래스는 JPA가 관리. 엔티티라 한다.
JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 필수

[주의]

기본 생성자 필수(파라미터가 없는 public or protected 생성자)

final 클래스, enum, interface, inner 클래스 사용X

저장할 필드에 final 사용X

[참고]
JPA 구현체들은 엔티티를 내부에서 다양한 방식으로 사용하는데, 예를 들면 엔티티를 JPA 구현체가 생성할 때 리플렉션을 사용해서 객체를 먼저 생성하고, 필드값을 나중에 넣어주게 되면 final을 사용할 수 없다.
이렇게 다양한 방식으로 JPA 구현체들이 사용할 수 있도록 JPA는 스펙상 final을 사용하지 못하도록 막아두었다.

@Entity 속성 정리

속성: name
- JPA에서 사용할 엔티티 이름을 지정한다.
- 기본값: 클래스 이름을 그대로 사용(Ex.Member)
- 같은 클래스 이름이 없으면 가급적 기본값을 사용.

@Table

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

DDL(Data Definition Language): 데이터베이스를 정의하는 언어이며, 데이터를 생성, 수정, 삭제하는 등의 데이터의 전체 골격을 결정하는 역할을 하는 언어.

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

DDL을 애플리케이션 실행 시점에 자동 생성
테이블 중심 -> 객체 중심
데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
- MySQL - VARCHAR / Oracle - VARCHAR2
이렇게 생성된 DDL은 개발 장비에서만 사용
생성된 DDL은 운영서버에서는 사용하지 않거나, 적절히 다듬은 후 사용

속성

hibernate.hbm2ddl.auto

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

[주의]

운영 장비에는 create, create-drop, update를 절대 사용하면 안된다.

개발 초기 단계는 create or update

테스트 서버는 update or validate

스테이징과 운영 서버는 validate or none
(사실상 테스트와 운영서버에서는 validate, none외에는 사용하지 않는다.)

DDL 생성 기능

제약조건 추가: 회원 이름은 필수, 10자 초과X
- @Column(nullable = false, length = 10)
유니크 제약조건 추가
- @Table(uniqueConstraints = {@UniqueConstraint(name = “NAME_AGE_UNIQUE”, columnNames = {“NAME”, “AGE”} )})
DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고, JPA의 실행 로직에는 영향을 주지 않는다.

필드와 컬럼 매핑

@Entity 
public class Member { 
    
    @Id 
    private Long id; 
    
    @Column(name = "name") 
    private String username; 

    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; // 회원을 설명할 수 있는 필드
    
    //Getter, Setter… 
} 

매핑 어노테이션 정리

@Column : 컬럼 매핑
@Temporal : 날짜 타입 매핑
@Enumerated : enum 타입 매핑
@Lob : BLOB, CLOB 매핑
@Transient : 특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

@Column

name : 필드와 매핑할 테이블의 컬럼 이름(기본값 : 객체의 필드 이름)
insertable, updatable : 등록, 변경 가능 여부(기본값 : TRUE)
- 기본값이 TRUE이기 때문에 변경을 막으려면 FALSE로 따로 설정을 해주어야 한다.
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도 사용 가능) (기본값 : percision=19, scale=2)
- percision은 소수점을 포함한 전체 자릿수를, scale은 소수의 자릿수다.
- double, float 타입에는 적용X

@Temporal

날짜 타입(java.util.Data, java.util.Calendar)을 매핑할 때 사용

참고: LocalDate, LocalDateTime을 사용할 때는 생략 가능

속성 : value
- TemporalType.DATE : 날짜, 데이터베이스 date 타입과 매핑(Ex.2013-10-11)
- TemporalType.TIME : 시간, 데이터베이스 time 타입과 매핑(Ex.11:11:11)
- TemporalType.TIMESTAMP : 날짜와 시간, 데이터베이스 timestamp 타입과 매핑(Ex.2013-10-11 11:11:11)

@Enumerated

자바 enum 타입을 매핑할 때 사용

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

[주의] ORDINAL을 사용하게 되면 enum 순서만 데이터베이스에 저장하게 되는데, 중간에 추가하거나 수정하게 되면 문제가 발생하기 때문에 ORDINAL은 사용하지 않는다!

@Lob

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

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

@Transient

필드 매핑X
데이터베이스에 저장X, 조회X
주로 메모리상에서만 임시로 값을 보관하고 싶을 때 사용
```
@Transient
private Integer temp;
```

기본 키 매핑

@Id

@GeneratedValue

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

기본 키 매핑 방법

직접 할당: @Id만 사용
자동 생성(@GeneratedValue)
- IDENTITY : 데이터베이스에 위임, MYSQL
- SEQUENCE : 데이터베이스 시퀀스 오브젝트 사용, ORACLE
  - @SequenceGenerator 필요
- TABLE : 키 생성용 테이블 사용, 모든 DB에서 사용
  - @TableGenerator 필요
- AUTO : 방언에 따라 자동 지정, 기본값

IDENTITY 전략

기본 키 생성을 데이터베이스에 위임
주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용
- (Ex.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 전략

데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(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

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

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 - 속성

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

권장하는 식별자 전략

기본 키 제약 조건 : null(X), 유일, 변하면 안된다.
미래까지 이 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대체키)를 사용.
Ex)주민등록번호도 기본 키로 적절하지 않다.
권장 : Long형 + 대체키 + 키 생성전략 사용
- 대체키 : auto_increment, sequence, UUID 등

allocation

성능 최적화
allocation값을 1로 했을 경우 객체를 새로 만들 때 마다 next call을 이용해 네트워크를 통해 1씩 증가한 값을 가져와야 하는데, 이렇게 되면 성능이 떨어질 수 밖에 없다.
allocation=50(기본값)와 같이 설정하면 DB에 미리 50개를 올려놓고, 메모리에서 그 갯수만큼 가져와서 1씩 쓰기 때문에 next call을 할 필요가 없다.
설정해둔 범위까지 사용하고 넘어가면 다시 next call을 호출해서 그 다음 50개를 다시 가져와 사용한다.

<출처 : 인프런 - 자바 ORM 표준 JPA 프로그래밍 - 기본편 (김영한)>

Twitter Facebook LinkedIn