[JPA] 엔티티 매핑 🐶

1. 객체와 테이블 매핑

 

1-1. @Entity

• @Entity가 붙은 클래스는 JPA가 관리한다.
• JPA를 사용해서 테이블과 매핑할 클래스는 @Entity가 필수이다.
• 주의
  • 기본 생성자 필수(파라미터가 없는 public 또는 protected 생성자)
  • final 클래스, enum, interface, inner 클래스 사용 불가
  • 저장할 필드에 final 사용 X

 

@Entity 속성 정리

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

 

name이라는 속성을 사용하는 것 보다, 차라리 클래스 명을 고치는 것이 낫다.

 

 

1-2. @Table

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

속성	기능	기본값
name	매핑할 테이블 이름	엔티티 이름을 사용
catalog	데이터베이스 catalog 매핑
schema	데이터베이스 schema 매핑
uniqueConstraints (DDL)	DDL 생성 시에 유니크 제약 조건 생성

 

---

2. 필드와 컬럼 매핑

Member

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

 

2-1. @Column (컬럼 매핑)

속성	설명	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드 이름
insertable, updatable	등록, 변경 가능 여부	TRUE
nullable(DDL)	null 값의 허용 여부를 설정한다. false로 설정하면 DDL 생성 시에 not null 제약조건이 붙는다.
unique(DDL)	@Table의 uniqueConstraints와 같지만 한 컬럼에 간단히 유니크 제약조건을 걸 때 사용한다.
columnDefinition(DDL)	데이터베이스 컬럼 정보를 직접 줄 수 있다. ex) varchar(100) defalut 'EMPTY'	필드의 자바 타입과 방언 정보를 사용해
length(DDL)	문자 길이 제약조건, String 타입에만 사용한다.	255
precision, scale(DDL)	BigDecimal 타입에서 사용한다(BigInteger도 사용할 수 있다). precision은 소수점을 포함한 전체 자릿수를, scale은 소수의 자릿수이다. 참고로 double, float 타입에는 적용되지 않는다. 아주 큰 숫자나 정밀한 소수를 다루어야할 때만 사용한다.	precision = 19, scale = 2

• unique는 잘 사용하지 않는다.
• unique 제약조건을 만들게 되면 제약조건의 이름이 랜덤으로 설정돼서 알아보기 힘들다.
• @Table 어노테이선에서 uniqueConstraints 속성을 사용하는 것이 좋다.

unique 제약조건의 이름 (알아보기 힘들다)

 

 

2-2. @Temporal (날짜 타입 매핑)

• 날짜 타입 (java.uti.Date, java.util.Calender)을 매핑할 때 사용
• 참고로 LocalDate, LocalDateTime을 사용할 때는 생략 가능하다. (최신 하이버네이트에서 지원)

속성	설명	기본값
value	TemporalType.Date : 날짜, 데이터베이스 date타입과 매핑 (ex. 2023-11-11) TemporalType.Time : 시간, 데이터베이스 time타입과 매핑 (ex. 11:11:11) TemporalType.TimeStamp : 날짜와 시간, 데이터베이스 timestamp타입과 매핑 (ex. 2023-11-11 11:11:11)

 

2-3. @Enumerated (enum 타입 매핑)

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

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

주의 (ORDINAL 사용 X)
만약 중간에 enum이 추가, 수정, 삭제가 발생했을 경우 순서가 엉키게 된다.
따라서 STRING을 사용하자!

 

2-4. @Lob (BLOB, CLOB 매핑)

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

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

 

2-5. @Transient (특정 필드를 컬럼에 매핑 X)

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

@Transient
private Integer temp;

 

---

 

3. 기본 키 매핑

 

3-1. @Id

• 직접 ID를 만들어서 할당하는 경우엔 @Id만 사용한다.
• 그러나 일반적인 RDB에서는 값을 자동으로 생성해주는 경우(Oracle의 Sequence, MySQL의 Auto Increment 등)가 많다.
• 그런 경우에는 @GeneratedValue를 사용하면 된다.

 

3-2. @GeneratedValue

3-2-1. IDENTITY

• 기본 키 생성을 데이터베이스에 위임한다.
• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용한다.

Member

@Entity
public class Member {

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

IDENTITY 전략의 특징

• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL을 실행한다.
• IDENTITY 전략은 DB에 넣기까지 PK의 값을 모른다.
• AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있다.
• 그래서 JPA는 커밋 시점이 아니라 em.persist()를 호출하는 시점에 INSERT SQL을 실행한다.
• 따라서 INSERT SQL을 모아서 커밋 시점에 한번에 처리하는 것이 불가능하다.

 

3-2-2. SEQUENCE

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트이다.
• Oracle, 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	데이터베이스에 등록되어 있는 시퀀스 이름	hibernate_sequence
initialValue	DDL 생성 시에만 사용됨, 시퀀스 DDL을 생성할 때 처음 시작하는 수를 지정한다.	1
allocationSize	시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨) 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값을 반드시 1로 설정해야 한다.	50
catalog, schema	데이터베이스 catalog, schema 이름

 

 

 

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

 

이렇게 실행할 경우

create table MY_SEQUENCES (
    sequence_name varchar(255) not null,
    next_val bigint,
    primary key ( sequence_name )
)

• @TableGenerator 안의 내용을 바탕으로 MY_SEQUENCES 라는 이름의 테이블이 생성된다.

@TableGenerator

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

 

3-2-4. AUTO

• 방언에 따라 자동으로 지정한다.

 

---

출처 : 자바 ORM 표준 JPA 프로그래밍 - 기본편