JPA 엔티티 매핑

JPA 엔티티 매핑

 

1. 객체와 테이블 매핑

 

1 - 1. @Entity

• @Entity가 붙은 클래스는 JPA가 관리, 엔티티라 한다.

• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity 필수

• 주의

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

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

    • 저장할 필드에 final 사용 X

 

1 - 1 - 1. 속성

name

• JPA에서 사용할 엔티티 이름을 지정한다.

• 기본값: 클래스 이름을 그대로 사용(예: Member)

• 같은 클래스 이름이 없으면 가급적 기본값을 사용한다.

 

 

1 - 2. @Table

엔티티와 매핑할 테이블 지정

 

1 - 2 - 1. 속성

name

매핑할 테이블 이름

기본값은 엔티티 이름이다.

 

catalog

데이터베이스 catalog 매핑

 

schema

데이터베이스 schema 매핑

 

uniqueConstraints (DDL)

DDL 생성 시에 유니크 제약 조건 생성

 

 

 

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

• DDL을 애플리케이션 실행 시점에 자동 생성

• 테이블 중심 -> 객체 중심

• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성

• 이렇게 생성된 DDL은 개발 장비에서만 사용

• 생성된 DDL은 운영서버에서는 사용하지 않거나, 적절히 다듬은 후 사용

 

2 - 1. 속성

create

기존테이블 삭제 후 다시 생성 (DROP + CREATE)

 

create-drop

create와 같으나 종료시점에 테이블 DROP

 

update

변경분만 반영(운영DB에는 사용하면 안됨)

 

validate

엔티티와 테이블이 정상 매핑되었는지만 확인

 

none

사용하지 않음

사실 none이란 값은 존재하지 않는다고 한다.

아무거나 막 적어놓는 것과 같은데, 관례상 none을 사용한다고 한다.

 

 

2 - 2. 주의

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

• 개발 초기 단계는 create 또는 update

• 테스트 서버는 update 또는 validate

• 스테이징과 운영 서버는 validate 또는 none

 

 

2 - 3. DDL 생성 기능

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

@Column(nullable = false, length = 10)

 

• 유니크 제약조건 추가

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

 

• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않는다.

 

 

 

3. 필드와 컬럼 매핑

3 - 1. 요구사항 추가

1. 회원은 일반 회원과 관리자로 구분해야 한다.

2. 회원 가입일과 수정일이 있어야 한다.

3. 회원을 설명할 수 있는 필드가 있어야 한다. 이 필드는 길이 제한이 없다.

 

package hellojpa;
import javax.persistence.*;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.Date;
@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… 
}

 

3 - 2. 매핑 어노테이션

@Column

컬럼 매핑

 

@Temporal

날짜 타입 매핑

 

@Enumerated enum

타입 매핑

 

@Lob

BLOB, CLOB 매핑

 

@Transient

특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

 

 

3 - 2 - 1. @Column 속성

name

필드와 매핑할 테이블의 컬럼 이름

기본값 : 객체의 필드 이름

 

insertable, updatable

등록, 변경 가능 여부

기본값 : TRUE

 

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도 사용할 수 있다).

precision은 소수점을 포함한 전체 자릿수를,

scale은 소수의 자릿수다.

참고로 double, float 타입에는 적용되지 않는다.

아주 큰 숫자나 정 밀한 소수를 다루어야 할 때만 사용한다.

기본값 : precision=19, scale=2

 

 

3 - 2 - 2. @Enumerated 속성

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

주의! ORDINAL 사용X

 

value

• EnumType.ORDINAL: enum 순서를 데이터베이스에 저장

• EnumType.STRING: enum 이름을 데이터베이스에 저장

기본값 : EnumType.ORDINAL

 

 

3 - 2 - 3. @Temporal 속성

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

 

참고 

LocalDate, LocalDateTime을 사용할 때는 생략 가능(최신 하이버네이트 지원)

 

value

• TemporalType.DATE

날짜, 데이터베이스 date 타입과 매핑 (예: 2013–10–11)

 

• TemporalType.TIME

시간, 데이터베이스 time 타입과 매핑 (예: 11:11:11)

 

• TemporalType.TIMESTAMP

날짜와 시간, 데이터베이 스 timestamp 타입과 매핑(예: 2013–10–11 11:11:11)

 

 

3 - 2 - 4. @Lob 속성

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

• @Lob에는 지정할 수 있는 속성이 없다.

• 매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB 매핑

• CLOB: String, char[], java.sql.CLOB

• BLOB: byte[], java.sql. BLOB

 

 

3 - 2 - 5. @Transient 속성

• 필드 매핑X

• 데이터베이스에 저장X, 조회X

• 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용

@Transient 
private Integer temp;

 

 

 

4. 기본키 매핑

기본 키 매핑 어노테이션

• @Id

• @GeneratedValue

 

4 - 1. 기본 키 매핑 방법

• 직접 할당

@Id만 사용

 

• 자동 생성(@GeneratedValue)

    • IDENTITY: 데이터베이스에 위임, MYSQL

 

    • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE

        • @SequenceGenerator 필요

 

    • TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용

        • @TableGenerator 필요

 

    • AUTO: 방언에 따라 자동 지정, 기본값

 

 

4 - 1 - 1. IDENTITY 전략

특징

• 기본 키 생성을 데이터베이스에 위임

• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용 (예: MySQL의 AUTO_ INCREMENT)

• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행

• AUTO_ INCREMENT는 데이터베이스에 INSERT SQL을 실행 한 이후에 ID 값을 알 수 있음

• IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행 하고 DB에서 식별자를 조회

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

 

 

4 - 1 - 2. SEQUENCE 전략

특징

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(예: 오라클 시퀀스)

• 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용

@SequenceGenerator(
        name = "MEMBER_SEQ_GENERATOR",
        sequenceName = "MEMBER_SEQ", //매핑할 데이터베이스 시퀀스 이름
        initialValue = 1, allocationSize = 1)

 

 

@SequenceGenerator 속성

• 주의: allocationSize 기본값 = 50

 

name

식별자 생성기 이름

기본값 : 필수

 

sequenceName

데이터베이스에 등록되어 있는 시퀀스 이름

기본값 : hibernate_sequence

 

initialValue

DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 1 시작하는 수를 지정한다.

기본값 : 1

 

allocationSize

시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값 을 반드시 1로 설정해야 한다.

기본값 : 50

 

catalog, schema

데이터베이스 catalog, schema 이름

 

 

4 - 1 - 3. TABLE 전략

• 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉 내내는 전략

• 장점: 모든 데이터베이스에 적용 가능

• 단점: 성능

 

@TableGenerator - 속성

name

식별자 생성기 이름

기본값 : 필수

 

table

키생성 테이블명

기본값 : hibernate_sequences

 

pkColumnName

시퀀스 컬럼명

기본값 : sequence_name

 

valueColumnName

시퀀스 값 컬럼명

기본값 : next_val

 

pkColumnValue

키로 사용할 값 이름

기본값 : 엔티티 이름

 

initialValue

초기 값, 마지막으로 생성된 값이 기준이다.

기본값 : 0

 

allocationSize

시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)

기본값 : 50

 

catalog, schema

데이터베이스 catalog, schema 이름

 

uniqueConstraint s(DDL)

유니크 제약 조건을 지정할 수 있다.