[JPA] 엔티티 매핑 1

객체와 테이블 매핑

@Entity

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

@Entity
class Member {
	// ... code
}

주의

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

속성 정리

속성 : name

• JPA에서 사용할 텐티티 이름을 지정한다.
• 기본값 : 클래스 이름을 그대로 사용한다(예 : Member)
• 동일한 클래스의 이름이 있는 경우 사용하지만, 권장하지 않는다.

@Table

• @Table은 엔티티와 매핑할 테이블을 지정한다.

속성

속성 : name

• 매핑할 테이블 이름
• 기본값 : 엔티티 이름을 사용한다.

속성 : catalog

• 데이터베이스 catalog 매핑

속성 : schema

• 데이터베이스 schema 매핑

속성 : uniqueConstraints(DDL)

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

@Entity
@Table(name = "mbr", schema = "sample_test")
class Member {
	...
}

단 스키마의 경우 hibernate.hbm2ddl.auto의 값이 create 라도 생성되지 않고, 해당 스키마가 존재해야 실행된다.

schema가 존재하지 않을 때 Insert

---

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

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

속성

hibernate.hbm2ddl.auto

옵션 : create

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

hibernate.hbm2ddl.auto = "create"

옵션 : create-drop

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

hibernate.hbm2ddl.auto = "create-drop"

옵션 : update

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

옵션 : validate

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

옵션 : none

• 사용하지 않음

주의점

• 운영 장비에는 절대 create, create-drop, update를 사용하면 안된다.
• 개발 초기 단계에는 create 또는 update (local에서)
• 테스트 서버는 update 또는 validate
• 스테이징과 운영 서버는 validate 또는 none

DDL 생성 기능

제약조건 추가

• 회원 이름은 필수, 10자 초과x
• @Column(nullable = false, length = 10)

@Entity
public class Member {

    @Id
    private Long id;
    @Column(nullable = false, length = 10)
    private String name;
}

@Column 추

유니크 제약조건 추가

• @Table(uniqueConstraints = {@UniqueConstraint(name = "NAME_AGE_UNIQUE, columnNames = {"NAME", "AGE"})})
• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않는다.

@Entity
@Table(uniqueConstraints = {
        @UniqueConstraint(
                name = "NAME_AGE_UNIQUE",
                columnNames = {"NAME", "AGE"}
        )
})
public class Member {
    @Id
    private Long id;
    private String name;
    private int age;
}

제약 조건 추

---

필드와 컬럼 매핑 

@Column 컬럼 매핑

속성

name

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

insertable, updatable

• 등록 변경 가능 여부
• default true
• SQL을 통한 INSERT, UPDATE는 가능하지만, JPA에서는 불가능하도록 설정된다.

nullable(DDL)

• null 값의 허용 여부를 결정한다 
• false로 설정하면 DDL 생성 시에 not null 제약조건이 붙는다
• 또한 hibernate 내부에서 체크를 한번 더 해준다.

unique(DDL)

• @Table의 uniqueConstaints와 같지만 한 컬럼에 간단히 유니크 제약조건을 걸 때 사용한다.
• 하지만 유니크 제약조건 이름이 랜덤으로 나오기 때문에 테스트 용도로만 사용한다.
• 또는 @Table에 @UniqueConstraint를 통해 제약조건을 사용한다.

columnDefinition(DDL)

• 데이터베이스 컬럼 정보를 직접 줄 수 있다.
• varchar(100) default 'EMPTY'
• 필드의 자바 타입과 방언에 따라 사용한다.

length(DDL)

• 문자 길이 제약조건
• String 타입에만 사용한다
• default 255

precision

• BigDecimal 타입에서 사용한다 (BigInteger도 사용할 수 있다)
• precision은 소수점을 포함한 전체 자릿수
• scale은 소수의 자릿수
• double, float 타입에는 사용하지 않는다.
• 아주 큰 숫자나, 정밀한 소수를 다루어야 할 때만 사용한다.
• default
  • percision = 19
  • scale = 2

@Temporal 날짜 타입 매핑

• 최신 hibernate에서는 LocalDate, LocalDateTime 클래스를 지원하여 생략할 수 있다.
• 하지만 Date 클래스를 사용할 경우 @Temporal이 필요하고 value값이 필요하다
• TemporalType.DATE 날짜, 데이터베이스 date 타입과 매핑
• TemporalType.TIME 시간, 데이터베이스 time 타입과 매핑
• TemporalType.TIMESTAMP 날짜와 시간, 데이터베이스의 timestamp 타입과 매핑

@Enumerated enum 타입 매핑

• 속성 value
• EnumType.ORDINAL : enum 순서를 데이터베이스에 저장 (default)
• EnumType.STRING : enum 이름을 데이터베이스에 저장
• ORDINAL의 경우 enum의 순서가 변경된다면 기존 데이터베이스와 일치하지 않는 데이터가 될 수 있으므로 사용하면 안된다.

@Lob BLOB CLOB 매핑

• @Lob에는 지정할 수 있는 속성이 없다.
• 매핑하는 필드 타입에 따라 자동적으로 매핑이 설정된다.

@Transient

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

---

기본 키 매핑

@Id

• 직접 할당의 경우 사용한다.

@GeneratedValue

IDENTITY

• 기본 키 생성을 데이터베이스에 위임
• MYSQL, PostgreSQL, SQL Server, DB2에서 사용
• 예 MySQL의 AUTO_INCREMENT
• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
• AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID값을 알 수 있음
• IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자를 조회

@Entity
class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
}

H2 DB Strategy = Identity

SEQUENCE

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

@Entity
@SequenceGenerator(
        name = "ID_SEQ",
        sequenceName = "MEMBER_ID_SEQ",
        initialValue = 10,
        allocationSize = 100
)
class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "ID_SEQ")
    private Long id;
    private String name = "A";
}

Sequence Generator

TABLE

• 키 생성 전용 테이블을 하나 만들어서 데이터베이스 스퀀스를 흉내내는 전략
• 장점 : 모든 DB에서 사용
• 단점 : 성능 
• @TableGenerator 필요
  • name 속성
    • 식별자 생성기 이름
    • 필수
  • table 속성
    • 키 생성 테이블명
    • default : hibernate_sequence
  • pkColumnName 속성
    • 시퀀스 컬럼명
    • default : sequence_name
  • valueColumnName 속성
    • 시퀀스 값 컬럼명
    • default : next_val
  • pkColumnValue 속성
    • 키로 사용할 값 이름
    • default : 엔티티 이름
  • initialValue 속성
    • 초기 값
    • 마지막으로 생성된 값이 기준이다.
    • default : 0
  • allocationSize 속성
    • 시퀀스 한 번 호출에 증가하는 수 (성능 최적화에 사용됨)
    • default : 50
  • catalog, schema 속성
    • 데이터베이스 catalog, schema 이름
  • uniqueConstraints(DDL) 속성
    • 유니크 제약 조건을 지정할 수 있다.

@Entity
@TableGenerator(
        name = "ID_GENERATOR",
        table = "TABLE_ID",
        pkColumnName = "PK_COLUMN",
        valueColumnName = "VALUE_COLUMN",
        initialValue = 10,
        allocationSize = 100
)
class Member {
    @Id
    @GeneratedValue(
            strategy = GenerationType.TABLE,
            generator = "ID_GENERATOR"
    )
    private Long id;
    private String name = "A";
}

Table Generator

AUTO

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

권장하는 식별자 전략

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

 

Reference

자바 ORM 표준 JPA 프로그래밍(인프런, 김영한)