BackEnd/ORM(JPA)

엔티티 매핑

객체와 테이블 매핑

 

객체와 테이블을 매핑하는 방법에 대해서 다룹니다.

더보기

@Entity

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

@Entity 속성 정리

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

@Table

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

 

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

 

데이터베이스 스키마를 자동 생성해주는 방법과 사용시 주의점에 대해 다룹니다.

더보기

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

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

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

hirbernate.hbm2ddl.auto

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

<property name="hibernate.hbm2ddl.auto" value="create"/>
@Entity
public class Member {
    @Id
    private Long id;
    private String name;
    private int age;	// <- age라는 instance변수 추가
    //Getter, Setter …

    public Member() {}

    ...

데이터베이스 스키마 자동 생성 - 주의

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

DDL 생성 기능

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

 

필드와 컬럼 매핑

 

필드에 어노테이션을 추가하여 컬럼과 매핑하는 방법에 대해 다룹니다.

더보기

요구사항 추가

  1. 회원은 일반 회원과 관리자로 구분해야 한다.
  2. 회원 가입일과 수정일이 있어야 한다.
  3. 회원을 설명할수 있는 필드가 있어야 한다. 이 필드는 길이 제한이 없다.
package hellojpa;

import javax.persistence.*;
import java.util.Date;

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

    public Member() {}

    //Getter, Setter …

}

 

매핑 어노테이션 정리

 

hibernate.hbm2ddl.auto

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

 

@Column

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

 

@Enumerated

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

주의! ORDINAL 사용 X

Enum ORDINAL은 순서를 저장한다. ex) USER / ADMIN (0, 1)
member.setRoleType(RoleType.USER); // 0값이 저장된다.
요구사항으로 Enum이 변경될때 순서에 대한 값이기 때문에 기존 데이터는 새로운 Enum을 반영하지 못한다.
ex) GUEST추가 GUEST / USER / ADMIN (0, 1, 2) -> 아까 저장해놓은 User는 0이었지만 지금은 1이되었다.
기존 데이터 0은 USER를 고려하였지만 GUEST가 추가됨으로써 더이상 제 기능을 상실함 (오류 야기)
속성 설명 기본값
value - EnumType.ORDINAL: enum 순서를 데이터베이스에 저장
- EnumType.STRING : enum 이름을데이터베이스에 저장 
EnumType.ORDINAL

 

@Temporal

날짜 타입(java.util.Date, java.util.Calendar)을 매핑할 때 사용

 

참고 : LocalDate, LocalDateTime을 사용할 때는 생략 가능 (최신 하이버네이트지원)

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

 

@LOB

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

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

@Transient

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

 

기본 키 매핑

 

기본키를 매핑하고 활용하는 법에 대해 다룹니다.

더보기

기본 키 매핑 어노테이션

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

 

기본 키 매핑 방법

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

직접 할당

  • @Id 사용

IDENTITY 전략 - 특징

  • 기본 키 생성을 데이터베이스에 위임
  • 주로 MYSQL, PostgreSQL, SQL Server, DB2에서 사용
    • (ex : MySQL의 AUTO_INCREMENT)
  • JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
  • AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있음 (Null)
  • IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자를 조회 
  • buffedWrite 전략이 불가능
 @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
Member member = new Member();
            member.setUsername("C");

            System.out.println("=====================");
            em.persist(member);
            System.out.println("=====================");

 

IDENTITY 전략 - 매핑

@ENTITY
public class Member {
    @ID
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
}

 

SEQUENCE 전략 - 특징

  • 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트(예: 오라클 시퀀스)
  • 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용
  • allocationSize를 이용해 pagenation과 같이 50개의 sequence 정보를 미리 가지고 있음

SEQUENCE 전략 - 매핑

@Entity
@SequenceGenerator(
    name = "MEMBER_SQL_GENERATOR"
    sequenceName = "MEMBER_SEQ". // 매핑할 데이터베이스 시퀀스 이름
    initialValue = 1, allocationSize = 1)
public class Member {

	@Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE,
    	generator = "MEMBER_SEQ_GENERATOR")
    private Long id;

}

 

 @Entity
@SequenceGenerator(name = "MEMBER_SEQ_GENERATOR",
sequenceName = "MEMBER_SEQ",
initialValue = 1, allocationSize = 50)
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "MEMBER_SEQ_GENERATOR")
    private Long id;
 
 
 // JpaMain class
 Member member1 = new Member();
            member1.setUsername("A");

            Member member2 = new Member();
            member2.setUsername("B");

            Member member3 = new Member();
            member3.setUsername("C");

            System.out.println("=====================");
            em.persist(member1);
            em.persist(member2);
            em.persist(member3);

            System.out.println("member1 = " + member1.getId()); // 1, 51
            System.out.println("member2 = " + member2.getId()); // memory
            System.out.println("member3 = " + member3.getId()); // memory

            System.out.println("=====================");

 

 

SEQUENCE - @SequenceGenerator

- 주의 : allocationSize 기본값 = 50

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

 

SEQUENCE 전략과 최적화

 

테이블마다 다른 Sequence를 사용하고 싶을 때 @SequenceGenerator를이용해 Sequence를 만들고 적절한 위치에 매핑하여 Sequence를 테이블마다 다르게 사용하면 된다.  

 

 

TABLE 전략

  • 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내내는 전략
  • 장점 : 모든 데이터베이스에 적용 가능
  • 단점 : 성능

TABLE 전략 - 매핑

create table MY_SEQUENCES (
	sequence_name varchar(255) not null,
    next_val bigint,
    primary key ( sequence_name)
)
@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;

}

 

@TableGenerator - 속성

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

 

권장하는 식별자 전략

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

 

실전 예제 - 1. 요구사항 분석과 기본 매핑

 

요구사항을 분석하고 그에 해당하는 매핑을 해보는 과정을 다룹니다.

더보기
  요구사항 분석
  • 회원은 상품을 주문할 수 있다.
  • 주문 시 여러 종류의 상품을 선택할 수 있다.

 

 

도메인 모델 분석

  • 회원과 주문의 관계: 회원은 여러 번 주문할 수 있다. (일대다)
  • 주문과 상품의 관계: 주문할 때 여러 상품을 선택할 수 있다. 반대로 같은 상품도 여러 번 주문될 수 있다. 주문상품이라는 모델을 만들어서 다대다 관계를 일다대, 다대일 관계로 풀어냄

 

테이블 설계

 

엔티티 설계와 매핑

 

데이터 중심 설계의 문제점

  • 현재 방식은 객체 설계를 테이블 설계에 맞춘 방식
  • 테이블의 외래키를 객체에 그대로 가져옴
  • 객체 그래프 탐색이 불가능
  • 참조가 없으므로 UML도 잘못

 

// order를 찾아서 해당하는 memberId값으로 Member를 검색
// 객체지향적 코드와 결이 다름
// 관계형DB 맞춤 설계 
Order order = em.find(Order.class, 1L);
Long memberId = order.getMemberId();

Member member = em.find(Member.class, memberId);

// 객체지향적 코드
Member findMember = order.getMember();
findMember.getName();

 

 

'BackEnd > ORM(JPA)' 카테고리의 다른 글

다양한 연관관계 매핑  (0) 2022.12.31
연관관계 매핑 기초  (0) 2022.12.30
준영속 상태 (Detached)  (0) 2022.12.29
플러시 (Flush)  (0) 2022.12.29
영속성 컨텍스트 (persistence Context)  (0) 2022.12.28