Spring

[Spring JPA] 객체와 테이블 매핑 (3)

아윤_ 2024. 5. 13. 20:58

 

JPA에서 가장 중요하게 봐야 되는 두 가지는 영속성 컨텍스트와 같이 JPA가 내부적으로 어떤 메커니즘으로 동작하는지에 대한 측면과 객체와 관계형 데이터베이스를 어떻게 매핑하여 쓰는지에 대한 설계적인 측면이 있다. 이번에는 엔티티 매핑에 대해 알아보자.

 

 

 

객체와 테이블 매핑

 

@Entity

  • @Entity가 붙은 클래스는 JPA가 관리하며, 이를 엔티티라 한다.
  • JPA를 사용해서 테이블과 매핑할 클래스는 @Entity를 반드시 붙여야 한다.
  • 주의할 점
    • 기본 생성자 필수
    • final 클래스, enum, interface, inner 클래스 사용 불가
    • 저장할 필드에 final 사용 불가

 

@Entity 속성

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

 

@Entity(name ="member")
public class Member {
	(생략)
}

 

@Table

  • @Table은 엔티티와 매핑할 테이블을 지정한다.

 

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

 

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

 

다음과 같이 테이블의 name을 "MBR"로 지정하면 매핑할 테이블의 이름이 "MBR"로 설정된다.

 

 

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

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

 

속성

  • hibernate.hbm2ddl.auto

 

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

 

주의 사항

  • 운영 장비에는 절대 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”})})

 

@Entity
public class Member {

    @Id
    private Long id;

    @Column(nullable= false, length = 10)
    private String name;
    
}

 

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

 

 

필드와 컬럼 매핑

 

예시를 위해 다음과 같은 요구사항을 추가해 보자.

 

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

 

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

    @Temporal(TemporalType.TIMESTAMP)
    private Date lastModifiedDate;

    @Lob
    private String description;

    public Member() {

    }
}

 

요구사항에 따라 다음과 같이 필드와 컬럼에 대해 매핑을 진행할 수 있다. 

 

매핑 어노테이션 정리

  • @Column: 컬럼 매핑
  • @Temporal: 날짜 타입 매핑
  • @Enumerated: enum 매핑
  • @Lob: BLOB, CLOB 매핑
  • @Trainsient: 특정 필드를 컬럼에 매핑하지 않음

 

@Temporal의 경우 타입이 DATE(날짜), TIME(시간), TIMESTAMP(날짜, 시간) 세 가지가 있다. 따라서 타입을 지정해주어야 한다.

데이터베이스에 varchar의 범위를 넘어서는 큰 값을 갖고 싶을 경우 @Lob을 사용하면 된다.

 

@Column

 

@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 매핑할 때 사용한다.

 

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

 

주의할 점은 ORDINAL 타입은 사용하면 안 된다는 점이다. 만약 회원의 역할이 GUEST인 enum 타입을 맨 처음에 추가한 다음 다시 DB에 회원의 역할이 GUEST인 회원을 추가할 경우 번호가 0번부터 시작되기 때문에 enum 타입에 ORDINAL을 사용할 경우 운영 시 굉장히 큰 버그가 발생할 수 있다. 그렇기에 필수로 STRING 타입을 사용해야 한다.

 

@Temporal

 

@Temporal은 날짜 타입( java.util.Date, java.util.Calendar)을 매핑할 때 사용한다. 예전에는 많이 사용하였지만, 지금은 잘 사용하지 않는다.

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

 

@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
    • IDENTITY: 데이터베이스에 위임 (MySQL)
    • SEQUENCE: 데이터베이스 시퀀스 오브젝트 사용 (ORACLE)
    • TABLE: 키 생성용 테이블 사용, 모든 DB에서 사용
    • AUTO: 방언에 따라 자동 지정, 기본값

 

IDENTITY 전략

 

- 특징

  • 기본 키 생성을 데이터베이스에 위임한다.
  • 주로 MySQL, PostgreSQL, SQL Server, DB2에서 사용(예: MySQL의 AUTO_INCREMENT)
  • AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있다.
  • IDENTITY 전략은 em.persist() 시점에 즉시 INSERT_SQL을 실행하고 DB에서 식별자를 조회한다.

 

- 매핑

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

 

- 문제

 

IDENTITY 전략의 경우 id 값을 DB에 값이 들어갔을 때 알 수 있다. JPA에서 영속성 컨텍스트에 의해 관리되려면 무조건 PK 값이 있어야 한다. 따라서 JPA는 IDENTITY 전략에서만 예외적으로 em.persist()를 호출한 시점에 바로 INSERT 쿼리를 날린다.

 

따라서 IDENTITY 전략에서는 쿼리를 모아서 INSERT 하는 것이 불가능하다는 단점이 있다.

 

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

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

 

TABLE 전략

 

- 매핑

@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
pkColumnValue 키로 사용할 값 이름 엔티티 이름
initialValue 초기 값, 마지막으로 생성된 값이 기준 0
allocationSize 시퀀스 한 번 호출에 증가하는 수(성능 최적화에 사용됨)  50
uniqueConstraint(DDL) 유니크 제약 조건을 지정할 수 있다.  
catalog, schema
 데이터베이스 catalog, schema 이름  

 

권장하는 식별자 전략

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

 

결론적으로 AUTO_INCREMENT 또는 SEQUENCE 오브젝트 둘 중 하나를 사용하고, 그게 아니면 때에 따라 UUID, 랜덤 값을 조합하여 사용하는 것을 권장한다. 절대 비즈니스를 키로 끌고 오는 것은 권장하지 않는다.

저작자표시 비영리 변경금지

'Spring' 카테고리의 다른 글

[Spring JPA] 연관관계 매핑 (4)  (0) 2024.05.16
[Spring JPA] 영속성 컨텍스트 (2)  (0) 2024.05.12
[Spring JPA] JPA 소개 (1)  (0) 2024.05.12
[스프링부트] 컨트롤러  (0) 2023.11.05
[스프링부트] 스프링부트 프로젝트의 구조  (1) 2023.10.19

'Spring'의 다른글

  • 현재글[Spring JPA] 객체와 테이블 매핑 (3)

관련글

댓글

티스토리툴바