JPA 엔티티 매핑 - 테이블, 컬럼, 기본키

관련 내용

<JPA 영속성 컨텍스트부터 다양한 매핑까지 완전히 이해하기>

• JPA 기본 동작과 영속성 원리 이해하기

JPA 기본 동작과 영속성 원리 이해하기

• (현재 글)JPA 엔티티 매핑 - 테이블, 컬럼, 기본키

JPA 엔티티 매핑 - 테이블, 컬럼, 기본키

• JPA 연관 관계 매핑과 고급 매핑

JPA 연관 관계 매핑과 고급 매핑

• JPA지연 로딩, 즉시 로딩 이해와 사용법 영속성전이, 고아 객체 알아보기

JPA지연 로딩, 즉시 로딩 이해와 사용법 영속성전이, 고아 객체 알아보기

• JPA 값 타입 이해하기

JPA 값 타입 이해하기

• JPQL, fetch join 중심으로 이해하기

JPA JPQL, fetch join 중심으로 이해하기

개요 목적

이번 글에서는 자바 엔티티 객체와 DB 테이블 데이터를 연결하는 JPA 엔티티 매핑에 대해서 알아본다.

객체와 테이블 매핑

객체와 테이블 연결해주는 어노테이션 @Entity, @Table에 대해서 알아보자

//1. @Entity
@Entity(name = "EntityName")
//2. @Table
@Table(name = "TableName")
public class Member {

    @Id
    private Long id;
    private String name;

    public Member(Long id, String name) {
        this.id = id;
        this.name = name;
    }
    public Member() {
    }		
}

1. @Entity

JPA를 사용해서 테이블과 매핑할 클래스는 @Entity를 붙여야 한다.

주의 사항

• 기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자)
• final 클래스, enum, interface, inner 클래스 사용X
• 저장할 필드에 final 사용 X

속성 설정 값

• name - JPA가 구분하는 Entity 이름, 보통 클래스 이름인 기본값을 사용한다. 다른 패키지에 같은 이름 클래스가 있을 때 구분해줄 때 entity name을 지정해 줄 수 있다.

2. @Table

해당 엔티티와 매핑할 테이블 지정, 설정한다.

속성 설정 값

속성	설명
name	매핑할 테이블 이름, 기본값으로 위에서 나온 엔티티 이름을 사용한다.
catalog	데이터베이스 catalog 매핑
schema	데이터베이스 schema 매핑
uniqueConstraints(DDL)	DDL 생성 시에 유니크 제약 조건 생성
indexs(DDL)	DDL 생성 시에 인덱스 조건 생성

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

애플리케이션 실행 시점에서 DDL을 자동 생성해주는 기능이 있다.

JPA에 설정한 데이터 방언에 맞게 적적할 DDL 쿼리를 날려준다.

이런 자동 DDL 생성 기능은 개발 단계에서만 사용하고, 운영 서버에서는 절대 사용하면 안 된다.

DDL을 애플리케이션 실행 시점에 자동 생성한다. • 테이블 중심 -> 객체 중심으로 엔티티 클래스 작성 • 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성. 설정한 방언에 따라서 DDL 쿼리를 알맞게 보내서 DB 테이블을 생성해준다. 

이렇게 생성된 DDL은 개발 장비에서만 사용 • 생성된 DDL은 운영 서버에서는 사용하지 않거나, 적절히 다듬은 후 사용해야 한다.

hibernate.hbm2ddl.auto 옵션

• create - 기존테이블 삭제 후 다시 생성 (DROP + CREATE)
• create-drop - create와 같으나 종료시점에 테이블 DROP
• update - 변경 부분만 반영, 새로운 필드가 추가되었을 때, 새롭게 create table이 아닌 alter table을 통해 필드 값을 추가해준다. 기존에 있던 필드가 지워졌을 때는 아무런 동작도 하지 않는다.
• validate - 엔티티와 테이블이 정상 매핑되었는 지만 확인
• none - 사용하지 않음
• @Column(nullable = false, length = 10) - DDL 생성 시 필드 제약 조건을 추가해준다.

필드와 컬럼 매핑

해당 필드는 해당 데이터 베이스 컬럼간의 연결을 도와주는 속성에 대해서 알아보자.

사용 예제

@Entity
public class Member {
    @Id
    private Long id;
    //1.@column
    @Column(name = "name")
    private String username;
    private Integer age;
    //2.@Enumerated
    @Enumerated(EnumType.STRING)
    private RoleType roleType;
    //3.@Temporal
    @Temporal(TemporalType.TIMESTAMP)
    private Date createdDate;
    @Temporal(TemporalType.DATE)
    private Date lastModifiedDate;
    //4.@Lob
    @Lob
    private String description;
    //5.@Transient
    @Transient
    private int temp;
}

Hibernate:   
    create table Member (
       id bigint not null,
        age integer,
        createdDate timestamp,
        description clob,
        lastModifiedDate date,
        roleType varchar(255),
        name varchar(255),
        primary key (id)
    )

1. @Column

속성	설명	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드 이름
insertable,
updatable	insertable : SQL INSERT문에 해당 컬럼을 포함할지 여부,
updatable : SQL UPDATE문에 해당 컬럼을 포함할지 여부insertable = false, updatable = false 로 놓고 읽기 전용 필드로 사용할 수 있다.	TRUE
nullable(DDL)	null 값의 허용 여부를 설정한다. false로 설정하면 DDL 생성 시에 not null 제약 조건이 붙는다.
unique(DDL)	@Table의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약 조건을 걸 때 사용한다. 보통 @Table 속성을 사용한다.
columnDefinition(DDL)	데이터베이스 컬럼 정보를 직접 줄 수 있다.
ex) varchar(100) default ‘EMPTY’
length(DDL)	문자 길이 제약조건, String 타입에만 사용한다.	255
precision,
scale(DDL)	엄청 큰 수를 사용할 때, precision은 소수점을 포함한 전체 자 릿수를, scale은 소수의 자릿수를 지정한다. BigDecimal 타입에서 사용한다(BigInteger도 사용할 수 있다)	precision=19,
scale=2

2. @Enumerated

보통의 DB에는 없는 자바 enum 타입을 매핑할 때 사용한다.

속성	설명	기본값
navalue	EnumType.ORDINAL: enum 순서를 데이터베이스에 저장
• EnumType.STRING: enum 이름을 데이터베이스에 저장	EnumType.ORDINAL

주의! ORDINAL 사용하지 않고, 반드시 STRING을 사용한다. 순서 숫자로 저장되면 구분이 힘들다.

//EnumType.STRING 적용. 구분이 쉬운 문자로 잘 나오는 것을 확인할 수 있다. 
public enum RoleType {
    USER, ADMIN
}

Member member = new Member(1L, "username", 20, null, null, null, "dscription", 1);
member.setRoleType(RoleType.USER);
em.persist(member);

3. @Temporal

자바에는 DATE 타입 밖에 없는데, DB에는 DATE, TIME, TIMESTAMP으로 나누어져 있어서 그 차이를 매핑할 때 사용한다.

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

java.sql 타입이 잘 나와 있기 때문에 잘 사용하지 않는다.

MySQL 설명 java

DATE	'1000-01-01' ~ '9999-12-31' (3 Byte)	Java.sql.Date
TIME	'-838:59:59' ~ '838:59:59’ (3 Byte)	Java.sql.Time
DATETIME	1000-01-01 00:00:00' ~ '9999-12-31 23:59:59’ (8 Byte)	Java.sql.Timestamp
TIMESTAMP	1970-01-01 00:00:01' ~ '2038-01-19 03:14:07’ (4 Byte)	Java.sql.Timestamp

4. @Lob

LOB은 가변 길의를 갖는 큰 데이터를 저장하는데 사용하는 데이터이다.

CLOB은 문자기반을 데이터를 저장하는데 사용한다.

BLOB은 binary 데이터를 저장하는데 사용한다.

@Lob은 일반적인 데이터베이스에서 저장하는 길이인 255개 이상의 문자를 저장하고 싶을 때 지정한다 String과 char 를 기본으로 하는 타입을 제외하면 @Blob으로 사용된다.

5. @Transient

데이터 베이스 저장,조회 하지 않기 위해서 즉 필드 매핑을 하지 않고, 메모리 상에서 임시로 값을 보관하고 싶은 필드에 지정한다.

기본키 매핑

기본키 매핑 종류

• 직접 할당 : @Id만 입력하여, 코드에서 직접 작성 할당
• 자동 할당: @GeneratedValue추가 및 키 생성 전략 선택.
  • 1 IDENTITY : 기본 키 생성을 데이터베이스에 위임.
  • 2 SEQUENCE : 데이터베이스 시퀀스를 사용해서 기본 키를 할당.
  • 3 TABLE : 키 생성 테이블을 사용한다.
  • AUTO : 선택한 데이터베이스 방언에 따라 INDENTITY, SEQUENCE, TABLE 전략 중 하나를 자동으로 선택한다

1. IDENTITY 전략

@Entity
public class Professor {
  @Id 
  @GeneratedValue(strategy=GenerationType.IDENTITY)
  private int id;
  private String name;
  ...
}

기본 키 생성을 데이타베이스에 위임하는 전략, 주로 MySQL, PostgreSQL, SQL Server, DB2, H2에서 사용

INSERT 특징으로는, 쓰기 지연이 동작하지 않는다.

em.persist() 호출 시 INSERT 쿼리가 데이터베이스 전달된다. 왜냐하면, em.persist를 하면, 해당 객체를 영속성 컨텍스트에 올려야하기 때문이다.

영속성 컨텍스트에는 객체와 기본키ID를 매치해서 저장하기 때문에, IDENTITY 방식은 DB에 저장되고 나서야 기본키를 할당 받아서 DB 먼저 저장 후에, 영속성 컨텍스트에 올리게 된다.

2. SEQUENCE 전략

유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(ex)오라클 시퀀스)를 사용한다. 주로 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용한다.

@Entity
@SequenceGenerator(
    name = "BOARD_SEQ_GENERATOR",
    sequenceName = "BOARD_SEQ",
    initialValue = 1,
    allocationSize = 1)
public class Board {

    @Id
    @GeneraedValue(strategy = GenerationType.SEQUNCE,
                    generator = "BOARD_SEQ_GENERATOR")
    private Long id;
		...
}

INSERT 특징으로는, 영속석 컨텍스트에 객체를 올리려면 기본키가 반드시 필요하기 때문에, 먼저 데이터 베이스의 시퀀스에서 해당 INSERT 되는 기본키를 가져온다.

그 기본키를 persist하는 객체에 할당.

기본키를 할당받은 객체를 영속성 컨텍스트 올린다.

트랜잭션이 커밋되면, INSERT 쿼리를 날린다.

3. TABLE 전략

키 생성 전용 테이블을 하나 만들고 여기에 이름과 값을 사용할 컬럼을 만들어 데이터베이스 시퀀스를 흉내내는 전략이다. 테이블을 사용하므로 모든 데이터베이스에 적용 할 수 있다.

@Entity
@TableGenerator(
        name = "USER_SEQ_GENERATOR",
        table = "MY_SEQUENCES",
        pkColumnValue = "USER_SEQ", allocationSize = 1)
public class User {
    @Id @GeneratedValue(strategy = GenerationType.TABLE, generator = "USER_SEQ_GENERATOR")
    private Long id;
    private String name;
		...
}