Spring JPA 엔티티 맵핑

엔티티 매핑

객체와 테이블 매핑

@Entity

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

---

@Table

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

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

---

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

• hibernate.hbm2ddl.auto

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

  <property name="hibernate.hbm2ddl.auto" value="create or create-drop or update or validate"/>

• 개발 초기 단계는 create 또는 update
• 테스트 서버는 update 또는 validate
• 스테이징과 운영 서버는 validate 또는 none

---

DDL 생성기능

• 제약조건 추가: 회원 이름은 필수 , 10자 초과 x
  • @Column(nullable = false, length = 10)
• 유니크 제약조건 추가

@Column(unique = true,length = 10)
private String name;

• DDL 생성 기능은 DDL을 자동 생성할 때만 사용되고 JPA의 실행 로직에는 영향을 주지 않는다.

---

필드와 컬럼 매핑

매핑 어노테이션 정리

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

@Column

속성	설명	기본값
name	필드와 매핑할 테이블의 컬럼 이름	객체의 필드이름
insertable,updatable	등록, 변경 가능 여부	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

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

---

@Temporal

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

참고: 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

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

---

기본 키 매핑 방법

• 직접 할당 : @Id만 사용
• 자동 생성(@GeneratedValue)

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

  • IDENTITY : 데이터베이스에 위임, MYSQL
    • Identity전략은 값이 DB에 저장될 때 까지 pk가 생성 안된다. 즉, DB에 들어갈 때 pk가 생성된다.
      그래서 Identity전략을 사용하면 JPA는 영속 상태를 만들 때 1차 캐시에서 pk값을 가져와야 하는데 가져올 것이 없기 때문에 예외적으로 em.persist(member)를 할 때 DB에 값을 넣어버린다.
  • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용, ORACLE
    • @SequenceGenerator 필요

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

  • TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용
    • @TableGenerator 필요

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

    • MY_SEQUENCES 테이블을 만들고 MEMBER_SEQ 를 sequence_name 컬럼값으로 넣고 next_val 컬럼값을 1로 지정한다. 여기서 1이 키이다. 다음에 Member를 저장하면 키 값이 2로 증가한다.
      이 전략이 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내내는 전략이다.
    • 

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

• AUTO: 방언에 따라 자동 지정, 기본값

권장하는 식별자 전략

---

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

참고

• 이 글은 김영한님의 인프런강좌 JPA기본편을 보고 정리한 글입니다.