자바 ORM 표준 JPA 프로그래밍(5) - 엔티티 매핑

대표적인 매핑 어노테이션

• 객체와 테이블 매핑: @Entity, @Table
• 필드와 컬럼 매핑: @Column
• 기본 키 매핑: @Id
• 연관관계 매핑: @ManyToOne,@JoinColumn

 

@Entity

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

@Table

• @Table은 엔티티와 매핑할 테이블 지정

 

속성 설명

• name: 매핑할 테이블 이름 (default: 엔티티 이름을 사용)
• catalog: catalog 기능을 가진 데이터베이에서 catalog를 매핑
• schema: schema 기능을 가진 데이터베이스 schema 매핑
• uniqueConstraints(DDL): DDL 생성 시에 유니크 제약 조건 생성

 

다양한 매핑 사용

• @Enumerated: 자바의 enum을 사용하여 매핑하기 위해 쓴다.
• @Temporal: 자바의 날짜 타입을 매핑하기 위해 사용한다.
  • TemporalType.DATE: java.sql.Date
  • TemporalType.TIME: java.sql.Time
  • TemporalType.TIMESTAMP: java.sql.Timestamp
• @Lob: CLOB, BLOB 타입을 매핑하기 위해 쓴다.
• @Transient: 특정 필드를 컬럼에 매핑하지 않음(매핑 무시)

---

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

• DDL을 애플리케이션 실행 시점에 자동 생성
• 테이블 중심의 설계에서 객체 중심의 설계를 가능하게 해줌
• 데이터베이스 방언을 활용해서 데이터베이스에 맞는 적절한 DDL 생성
• 이렇게 생성된 DDL은 개발 장비에서만 사용하는 것을 권장
• 생성된 DDL은 운영서버에서는 사용하지 않거나, 생성된 DDL을 적절히 다듬은 후
• persistence.xml에 hibernate.hbm2ddl.auto 속성을 추가해 사용할 수 있다.

 

hibernate.hbm2ddl.auto 옵션 설명

• create: 기존테이블 삭제 후 다시 생성 (DROP + CREATE)
• create-drop: create와 같으나 종료시점에 테이블 DROP
• update: 변경분만 반영(운영DB에는 사용하면 안됨)
• validate: 엔티티와 테이블이 정상 매핑되었는지만 확인
• none: 사용하지 않음

 

권장 가이드라인

• 운영 장비에는 절대 create, create-drop, update 사용하지 않는다.
• 개발 초기 단계는 create 또는 update를 쓰면 빠른 개발을 도와준다.
• 테스트 서버는 update 또는 validate → 하지만 웬만하면 쓰진 말 것, validate는 괜찮음.
• 스테이징과 운영 서버는 validate 또는 none

---

DDL 생성 기능

• 제약조건 추가
  • ex) @Column(nullable = false, length = 10) → null 값이 들어올 수 없음, 10자 초과X
• 유니크 제약조건 추가
  • ex) @Table(uniqueConstraints = {@UniqueConstraint( name = "NAME_AGE_UNIQUE",
    columnNames = {"NAME", "AGE"} )})
• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고, JPA의 실행 로직에는 영향을 주지 않는다.

 

필드와 칼럼 매핑

 

@Column

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

 

@Enumerated

• 자바 enum 타입을 매핑할 때 사용
• 주의! ORDINAL은 사용하지 않는 것을 권장함. 비즈니스 요구사항 추가 혹은 변경에 따른 Enum의 순서가 변경될 수 있기 때문이다.

 

속성 설명

• (default) EnumType.ORDINAL: enum 순서를 데이터베이스에 저장
• EnumType.STRING: enum 이름을 데이터베이스에 저장 EnumType.ORDINAL

 

@Temporal

• 날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용
• LocalDate, LocalDateTime을 사용할 때는 어노테이션 생략 가능(java 8 이상, 최신 하이버네이트 지원)

 

속성 설명

• 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

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

 

1 2

@Transient private Integer temp;

cs

---

기본 키 매핑

@Id 와 @GeneratedValue를 이용해서 매핑한다.

1 2

@Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; Colored by Color Scripter

cs

 

JPA가 제공하는 데이터베이스 기본 키 생성 전략은 다음과 같다.

• 직접 할당: @Id만 사용 시
• 자동 생성: @GeneratedValue를 붙여 추가한다.
  • IDENTITY: 데이터베이스에 위임, MYSQL
  • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE
    • @SequenceGenerator 필요
  • TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용
    • @TableGenerator 필요
  • AUTO: 방언에 따라 자동 지정, 기본값

 

TIP) Id의 타입은 Long을 쓰는 것을 권장함, Integer는 십몇 억이 넘어가면 한 바퀴돔. Long을 추천. 지금 어플리케이션 성능에 크게 영향을 끼치지 않음.

---

기본 키 직접 할당 전략

직접 할당 전략은 em.persist()로 엔티티 저장하기 전 어플레케이션에서 기본 키를 직접 할당하는 방법이다.

1 2 3

Board board = new Board(); board.setid("id1"); // 기본 키 직접 할당 em.persist(board);

cs

 

@Id 적용 가능 자바 타입

• 자바 기본형
• 자바 래퍼(Wrapper형)
• String
• java.util.Date
• java.sql.Date
• java.math.BigEmcimal
• java.math.BigInteger

---

IDENTITY 전략

기본 키 생성을 데이터베이스에 위임하는 전략이다. 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용됨.(예: MySQL의 AUTO_ INCREMENT)

 

특징

JPA는 보통 쓰기 지연에 의해 트랜잭션 커밋 시점에 한꺼번에 INSERT SQL 실행
AUTO_ INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있음.

위와 같은 이유 때문에 IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행
하고 DB에서 식별자를 조회하여 영속 상태로 등록한다.

 

적용 예시)

1 2 3 4 5 6

@Entity public class Member {     @Id     @GeneratedValue(strategy = GenerationType.IDENTITY)     private Long id; } Colored by Color Scripter

cs

---

SEQUENCE 전략

유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(ex: 오라클 시퀀스)를 사용해서 기본 키를 생성하는 전략. 보통 시퀀스를 지원하는 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용.

 

적용 예시)

1 2 3 4 5 6 7 8 9 10 11

@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; } Colored by Color Scripter

cs

 

시퀀스 DDL 예시)

CREATE SEQUENCE MEMBER_SEQ_GENERATOR START WITH 1 INCREMENT BY 1;

@SequenceGenerator 속성 설명

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

 

추가 설명

 

동작에서 IDENTITY과의 차이

em.persists()가 호출되면 데이터베이스 시퀀스에 먼저 id 값을 받아온 뒤에 엔티티를 쓰기 지연에 담아놨다가 tx.commit() 시점에 받아온 아이디를 가지고 디비에 Insert 쿼리를 던지게 된다. IDENTITY 와는 달리 시퀀스는 1차 캐시에 의한 버퍼링이 가능하다.

 

그렇다면 디비와의 네트워킹이 늘어나기 때문에 성능 저하가 있지 않냐?

 

allocationSize를 통한 성능 튜닝으로 해결

미리 allocationSize 만큼 데이터베이스 시퀀스를 증가 시키고 증가 시킨 만큼은 어플리케이션 메모리를 통해 아이디를 받아와 사용함으로써 성능 개선을 할 수 있음. 하지만 너무 값을 크게 잡게되면 웹 어플리케이션이 다시 구동될 때 전에 사용하지 못한 크기 만큼은 낭비하게 된다. (50~100 정도를 권장)

 

혹 여러 분산 서버가 호출하게 된다면 동시성 문제가 일어날까?

가령 allocationSize 50으로 설정했다면 1서버가 호출한다면 1~50, 2서버가 호출한다면 51~100, 3서버가 호출한다면 101~ 150 ... 처럼 할당 받아 동작을 하기 때문에 동시성 문제는 발생하지 않는다.

---

TABLE 전략

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

• 장점: 모든 데이터베이스에 적용 가능
• 단점: 값을 조회하면서 SELECT 쿼리를 사용하고, 다음 값으로 증가시키기 위해 UPDATE 쿼리를 사용한다. SEQUENCE 전략과 비교하면 데이터베이스와 네트워킹을 한 번 더 하기 때문에 성능이 상대적으로 떨어진다.

 

적용 예시

TABLE 전략을 사용하기 위해선 아래와 같이 키 생성 용도로 사용할 테이블을 만들어 시퀀스처럼 사용함. 시퀀스 대신에 테이블을 생성해 사용한다는 것만 제외하면 SEQUENCE 전략과 내부 동작방식이 일치한다.

TABLE 전략 키 생성 DDL 예시)

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

TABLE 전략 매핑 코드 예시)

1 2 3 4 5 6 7 8 9 10

@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; } Colored by Color Scripter

cs

@TableGenerator 속성 설명

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

---

AUTO 전략

선택한 데이터베이스 방언에 따라 IDENTITY, SEQUENCE, TABLE 중 하나를 자동으로 선택해줌. 데이터베이스를 변경해도 코드를 수정할 필요가 없다는 장점이 있다. SEQUENCE, TABLE 전략이 선택된다면 시퀀스나 키 생성용 테이블을 미리 만들어둬야한다. 만약 스미카 자동 생성 기능을 사용한다면 하이버네이트가 기본값을 사용해 적절하게 만들어준다.

---

권장하는 식별자 선택 전략

• 기본 키 제약 조건: not null, 유일성 보장, 변하면 안 된다.

 

자연 키(natural key): 비즈니스에 의미가 있는 키(예: 주민등록번호, 이메일, 전화번호 등)

대리 키(surrogate key): 비즈니스와 관련이 없는 임의로 만들어진 키, 대체키로도 불린다. (예: 오라클 시퀀스, auto_increment, 키생성 테이블 사용 등)

 

TIP)

영구적으로 기본 키 제약 조건을 만족하는 자연키는 찾기 어렵다. 대리키(대체키)를 사용하는 것을 권장한다. 전화번호, 주민등록번호 같은 비즈니스와 관련 있는 값을 기본키로 사용하면 추후에 비즈니스 환경의 변경에 따른 여파가 올 수도 있다.

권장: Long형 + 대체키 + 키 생성전략 사용(오토인크리즈, 시퀀스, 랜덤값을 조합한 키 등)