[JPA] 엔티티 매핑

출처

https://www.inflearn.com/course/ORM-JPA-Basic/dashboard

자바 ORM 표준 JPA 프로그래밍 - 기본편 강의 - 인프런

 

목차

 

 

객체와 테이블 매핑

@Entity

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

💡주의

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

@Entity
public class Member {

@Entity 속성

속성	기능	기본값
name	엔티티 이름을 지정합니다.	클래스 이름명 (예) Member) 같은 클래스의 이름이 없다면, 가급적 정의하지 않습니다.

 

 

 

@Table

• 엔티티와 매핑할 테이블을 지정합니다.

@Entity
@Table(name = "MBR")
public class Member {

 

속성	기능	기본값
name	매핑할 테이블 이름	엔티티 이름 사용
catalog	데이터베이스 catalog 매핑
schema	데이터베이스 schema 매핑
uniqueContraints (DDL)	DDL 생성 시, 유니트 제약 조건 설정

 

참고 카탈로그(catalog)
카탈로그는 데이터베이스에 포함된 메타데이터의 모음을 의미합니다. 메타데이터는 데이터베이스 객체(테이블, 뷰, 인덱스 등)의 구조와 속성에 대한 정보를 포함합니다. 
따라서, 카탈로그는 데이터베이스에 관한 정보를 조회하고 관리하기 위한 도구로 사용됩니다. 
일반적으로 카탈로그는 다음과 같은 정보를 포함할 수 있습니다.
1. 테이블 정보
2. 인덱스 정보
3. 뷰 정보
4. 프로시저 및 트리거 정보
5. 사용자 및 권한 정보
6. 시스템 정보
일반적으로 데이터베이스 관리 시스템(DBMS)는 시스템 카탈로그를 내장하고 있으며, 사용자는 SQL 쿼리나 DBMS 관리 도구를 통해 카탈로그 정보에 접근할 수 있습니다. 

참고 스키마(schema)
데이터베이스 스키마는 데이터베이스에서 사용되는 데이터의 구조, 제약 조건, 관계 등을 정의하는 전체적인 계획이나 청사진을 나타냅니다. 데이터베이스 스키마에는 여러 개의 테이블, 뷰, 프로시저, 트리거 등과 관련된 모든 객체들이 포함됩니다. 즉, 데이터베이스 전체 구조를 정의하고, 이를 통해 데이터의 논리적인 구조와 관계를 명시합니다. 

 

 

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

• 애플리케이션 실행 시점에 DDL 이 자동으로 생성됩니다.
• 데이터베이스 방언을 활용하여 데이터베이스에 맞는 적절한 DDL을 생성합니다. (ex) Oracle은 varchar2, MySQL은 varchar를 사용)
• 테이블 중심이 아닌 객체 중심으로 생성됩니다. 
• 이렇게 생성된 DDL은 개발 시에만 사용해야 합니다. (운영에서 사용하면 안 됩니다.)
• 생성된 DDL은 운영 서버에서는 사용하지 않거나, 필요한 경우에만 불안하므로 적절히 다듬은 후 사용해야 합니다.

 

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

<property name="hibernate.hbm2ddl.auto" value="create" />

옵션	설명
create	기존 테이블 삭제 후 다시 생성 (DROP + CREATE)
create-drop	create와 같으나, 종료 시점에 테이블 DROP
update	변경 부분만 반영 (운영 DB에서 사용하면 X)  참고로, 컬럼 추가는 반영이 되지만, 삭제는 반영되지 않습니다. (컬럼이 삭제되면 안되므로)
validate	엔티티와 테이블이 정상 매핑되었는지 확인 (테이블에 없는 컬럼이 엔티티에 있다면 오류가 발생합니다.)
none	사용하지 않음 (주석처리한 것과 같습니다.)

 

실습

데이터베이스 방언 별로 DDL SQL이 변경됩니다.

eX) H2에서 Oracle로 변경할 경우, Oracle은 varchar2를 사용하기 때문에 해당 SQL이 변경됩니다.

 

 

💡주의

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

가장 권장하는 방법은 로컬에서는 자유롭게 사용하고, 스테이징이나 운영 서버에선 사용하지 않고 스크립트를 직접 짜서 DBA에게 검증받아 적용하는 것을 권장합니다.
JPA가 생성하는 스크립트를 일일이 필요한 것들을 꼼꼼히 따져보면서 다듬은 후에 사용하는 것도 괜찮은 방법입니다. 

참고 스테이징
스테이징 환경은 개발된 소프트웨어가 실제 운영 환경으로 이동하기 전에 테스트되고 평가되는 환경을 의미합니다. 실제 운영 환경과 최대한 유사하게 구성되어 있습니다. 이는 소프트웨어의 안정성과 성능을 검증하며 문제를 해결하는 데 중점을 둡니다. 또한, 사용자 피드백을 수집하고 사용자들이 소프트웨어를 실제로 사용하는 환경을 시뮬레이션합니다. 

 

 

DDL 생성 기능

• @Column(nullable = false, length = 10)
  • 컬럼의 제약 조건을 추가할 수 있습니다. 
  • 해당 컬럼은 null을 허용하지 않고, 10글자를 초과할 수 없습니다.
• @Table(uniqueContraints = {@UniqueConstraint(name="NAME_AGE_UNIQUE", columnNames = {"NAME", "AGE" })})
  • 유니크 제약 조건을 추가할 수 있습니다.

DDL 생성 기능은 DDL을 자동 생성할 때만 사용이 되고, JPA의 실행 로직에는 영향을 주지 않습니다. 
단순히, Alter table과 같은 SQL이 실행되는 것입니다. 따라서, Validate에 걸리지 않을 수도 있습니다.
(@Table(name="MBR") 같은 코드들은 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 lastModifiedDate;
    @Lob
    private String description;

    public Member() {
    }
		
    //Getter, Setter ...
}

package hellojpa;

public enum RoleType {
    USER, ADMIN
}

package javax.persistence;

public enum TemporalType {
    DATE, 
    TIME, 
    TIMESTAMP
}

 

 

매핑 어노테이션

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

 

 

@Column

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

 

 

@Enumerated

• enum 타입을 매핑할 때 사용합니다.

주의! ORDINAL 값 사용 X
(만약, USER, ADMIN 순서대로 enum이 정의되어 있다면, 데이터베이스에는 USER의 값이 0으로 변경되어 저장됩니다. 중간에 GUEST가 맨 앞에 추가가 된다면 해당 값이 0으로 바뀌기 때문에 기존의 데이터베이스 값들이 잘못된 값을 저장하게 됩니다.)

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

 

 

@Temporal

• 날짜 타입 (java.util.Date, java.util.Calendar)을 매핑할 때 사용합니다.
• 자바의 Date에는 날짜, 시간, 날짜시간 모두 포함되어 있지만, DB는 날짜(DATE), 시간(TIME), 날짜시간(TIMESTAMP)를 구분합니다.
• 참고로 LocalDate, LocalDateTime을 사용할 때는 생략이  가능합니다. (최신 하이버네이트 지원)

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

 

 

@Lob

• 데이터베이스 BLOB, CLOB 타입과 매핑할 떄 사용합니다.
• @Lob에는 지정할 수 있는 속성이 없습니다.
• 매핑하는 필드 타입이 문자면 CLOB 매핑, 나머지는 BLOB을 매핑합니다.
  • CLOB: String, char[], java.sql.CLOB
  • BLOB: byte[], java.sql.BLOB

 

@Transient

• 필드 매핑을 원하지 않을 때 사용합니다. 
• 데이터베이스에 저장도 되지 않고, 조회도 되지 않습니다. 
• 주로 메모리상에서만 임시로 어떤 값을 보관하고 싶을 때 사용되빈다.

@Transient 
private Integer temp;

 

 

 

기본 키 매핑

기본 키 매핑 어노테이션

• @Id
• @GeneratedValue

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

 

 

@GeneratedValue

• 기본 키 값을 자동으로 생성할 때 사용합니다.
• AUTO : 방언에 따라 자동 지정, 기본 값 (Oracle 이면 SEQUENCE가 생성됩니다.)
• IDENTITY: 데이터베이스에 위임, MYSQL에서 사용
• SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE에서 사용
  • @SequenceGenerator 사용 가능
• TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용 가능 
  • @TableGenerator 사용 가능

 

IDENTITY 전략

• 기본 키 생성을 데이터베이스에 위임합니다.
• 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용합니다. (예: MySQL의 AUTO_INCREMENT)

💡중요

• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행합니다.
• AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있습니다.
• 따라서, IDENTITY 전략에서만 em.persist() 시점에 즉시 INSERT SQL을 실행하고, DB에서 식별자를 조회합니다. (Select 쿼리 없이 조회가 가능하도록 내부적으로 설계가 되어있습니다.)

Member member = new Member();
member.setUsrname("C");               //Id를 입력하지 않음

em.persist(member);                  //커밋 시점이 아니라 em.persist 시점에 SQL을 실행
System.out.println(member.getId());  //1이 출력된다.

tx.commit();

 

 

SEQUENCE 전략

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트입니다. (예: 오라클 시퀀스)
• 오라클, 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 속성

주의: allocationSize 기본값 = 50

속성	설명	기본값
name	식별자 생성기 이름	필수
sequenceName	매핑할 데이터베이스에 등록된 시퀀스 이름	hibernate_sequence
initialValue	시퀀스 DDL을 생성할 때, 처음 시작하는 수를 지정 (시퀀스 DDL 생성 시에만 사용)	1
allocationSize	시퀀스 한 번 호출에 증가하는 수 (성능 최적화에 사용된다. 만약 설정 값이 50이라면, 호출 한 번에 DB에 50으로 설정을 해두고, 메모리에서 필요할 때마다 1씩 가져다가 쓴다. 하지만, 데이터베이스 시퀀스 값이 하나씩 증가하도록 설정되어 있으면 이 값을 반드시 1로 설정해야 한다.)	50
catalog, schema	데이터베이스 catalog, schema 이름

 

allocationSize

• call next value 가 호출될 때, 50개씩 DB에 저장해둡니다.
• em.persist()가 호출되어 id값이 필요할 땐, 메모리에 저장되어 있는 값을 하나씩 가져와 사용합니다.

 

TABLE 전략

• 키 생성 전용 테이블을 하나 만들어서 키를 가져옵니다. 데이터베이스 시퀀스를 흉내내는 전략입니다.
• 장점: 모든 데이터베이스에 적용 가능합니다. (MySQL의 auto_increment, Oracle의 sequence 구분하지 않아도 됩니다.)
• 단점: 성능 (테이블을 직접 사용하므로 lock이 걸릴 수도 있고, 최적화가 되어있지 않습니다.)

@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;

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

• 현재 MEMBER_SEQ가 생성되어 있는데, 만약 ORDER_SEQ가 생성된다면 밑에 추가 됩니다.
• NEXT_VAL은 데이터가 추가될 때마다 증가됩니다.

 

@TableGenerator - 속성

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

 

 

 

권장하는 식별자 전략

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