[자바 ORM 표준 JPA 프로그래밍 - 기본편] 4. 엔티티 매핑

📌 엔티티 매핑 소개

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

 

 

📌 객체와 테이블 매핑

⚡ @Entity

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

Entity 속성 정리

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

 

⚡ @Table

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

 

 

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

⚡ 정의

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

 

⚡ 속성

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

•  persistence.xml 파일에 추가

 

실습

• 스키마 자동 생성하기 설정
• 스키마 자동 생성하기 실행, 옵션별 확인
• 데이터베이스 방언 별로 달라지는 것 확인(varchar)

 

❗ 주의

• 운영 장비에는 절대 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의 실행 로직에는 영향을 주지 않음

 

 

📌 필드와 컬럼 매핑

⚡ 요구사항 추가

• 회원은 일반 회원과 관리자로 구분해야 함
• 회원 가입일과 수정일이 있어야 함
• 회원을 설명할 수 있는 필드가 있어야 함 (이 필드 길이는 제한 없음)

 

⚡ 매핑 어노테이션 정리

 

✔ @Column

 

✔ @Enumnerated

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

❗주의 : ORDINAL 사용 X

 

✔ @Temporal

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

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

 

✔ @Lob

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

✔ @Transient

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

@Transient
private Intege r 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 Sever, DB2에서 사용
  • ex. MySQL의 AUTO_INCREMENT
• JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
• AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID값을 알 수 있음

 

✔  IDENTITY 전략 - 매핑

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

 

✔ SEQUENCE 전략 - 특징

• 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트
  • ex. 오라클 시퀀스
• 오라클, PostgreSQL, DB2, H2 데이터베이스에서 사용

 

✔ SEQUENCE 전략 - 매핑

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

 

✔ SEQUENCE - @SequenceGenerator

• ❗ 주의 : allocationSize 기본값 = 50
  

 

✔ 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;
    ...
}

 

✔ @TableCenerator - 속성

 

⚡ 권장하는 식별자 전략

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

 

 

 

 

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

⚡ 요구사항 분석

• 회원은 상품을 주문할 수 있음
• 주문 시 여러 종류의 상품을 선택할 수 있음

 

⚡ 기능 목표

• 회원 기능
  • 회원 등록
  • 회원 조회
• 상품 기능
  • 상품 등록
  • 상품 수정
  • 상품 조회
• 주문 기능
  • 상품 주문
  • 주문 내역 조회
  • 주문 취소

 

⚡ 도메인 모델 분석

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

 

 

⚡ 테이블 설계

 

⚡ 엔티티 설계와 매핑

 

프로젝트 생성

GroupId : jpabook
ArtifactId : jpashop

• Member
• Order
• OrderItem
• Item

 

Member.class

package jpabook.jpashop.domain;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class Member {

    @Id @GeneratedValue(strategy = AUTO)
    private Long id;
    private String name;
    private String city;
    private String street;
    private String zipcode;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }

    public String getStreet() {
        return street;
    }

    public void setStreet(String street) {
        this.street = street;
    }

    public String getZipcode() {
        return zipcode;
    }

    public void setZipcode(String zipcode) {
        this.zipcode = zipcode;
    }

}

 

Order.class

package jpabook.jpashop.domain;

import javax.persistence.*;
import java.time.LocalDateTime;

@Entity
@Table(name="ORDERS")
public class Order {
    @Id @GeneratedValue
    @Column(name="ORDER_ID")
    private Long id;

    @Column(name = "MEMBER_ID")
    private Long memberId;

    private LocalDateTime orderDate;

    @Enumerated(EnumType.STRING)
    private OrderStatus orderStatus;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public Long getMemberId() {
        return memberId;
    }

    public void setMemberId(Long memberId) {
        this.memberId = memberId;
    }

    public LocalDateTime getOrderDate() {
        return orderDate;
    }

    public void setOrderDate(LocalDateTime orderDate) {
        this.orderDate = orderDate;
    }

    public OrderStatus getOrderStatus() {
        return orderStatus;
    }

    public void setOrderStatus(OrderStatus orderStatus) {
        this.orderStatus = orderStatus;
    }




}

 

OrderStatus.enum

package jpabook.jpashop.domain;

public enum OrderStatus {
    ORDER, CANCEL
}

 

OrderItem.class

package jpabook.jpashop.domain;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class OrderItem {

    @Id @GeneratedValue
    @Column(name = "ORDER_ITEM_ID")
    private Long id;

    @Column(name="ORDER_ID")
    private Long orderId;

    @Column(name="ITEM_ID")
    private Long itemId;

    private int orderPrice;
    private int count;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public Long getOrderId() {
        return orderId;
    }

    public void setOrderId(Long orderId) {
        this.orderId = orderId;
    }

    public Long getItemId() {
        return itemId;
    }

    public void setItemId(Long itemId) {
        this.itemId = itemId;
    }

    public int getOrderPrice() {
        return orderPrice;
    }

    public void setOrderPrice(int orderPrice) {
        this.orderPrice = orderPrice;
    }

    public int getCount() {
        return count;
    }

    public void setCount(int count) {
        this.count = count;
    }


}

 

Item.class

package jpabook.jpashop.domain;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class Item {

    @Id @GeneratedValue
    @Column(name = "ITEM_ID")
    private Long id;

    private String name;
    private int price;
    private int stockQuantity;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getPrice() {
        return price;
    }

    public void setPrice(int price) {
        this.price = price;
    }

    public int getStockQuantity() {
        return stockQuantity;
    }

    public void setStockQuantity(int stockQuantity) {
        this.stockQuantity = stockQuantity;
    }

}

 

JpaMain.java

package jpabook.jpashop;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;

public class JpaMain {

    public static void main(String [] args){
        EntityManagerFactory emf = Persistence.createEntityManagerFactory("jpashop");

        EntityManager em = emf.createEntityManager();

        EntityTransaction tx = em.getTransaction();

        tx.begin();

        try{
            tx.commit();

        }catch (Exception e){
            tx.rollback();
        }finally {
            em.close();
        }
        emf.close();
    }
}

•  JpaMain 실행하면 테이블 생성됨
• id가 아니라 Member를 바로 꺼내오는게 좋음

 

db의 관례는 보통 띄어쓰기는 _ 사용

 

 

⚡ 데이터 중심 설계의 문제점

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

 

 

 

<자바 ORM 표준 JPA 프로그래밍 - 기본편_김영한>을 수강하고 작성한 글입니다

 

 

 

 

 

---

PREV

[자바 ORM 표준 JPA 프로그래밍 - 기본편] 3. 영속성 관리 - 내부 동작 방식

NEXT

[자바 ORM 표준 JPA 프로그래밍 - 기본편]5. 연관관계 매핑 기초