Spring

[Spring] JPA 엔티티 매핑

하부루 2024. 7. 4. 17:48
 

자바 ORM 표준 JPA 프로그래밍 - 기본편 강의 | 김영한 - 인프런

김영한 | JPA를 처음 접하거나, 실무에서 JPA를 사용하지만 기본 이론이 부족하신 분들이 JPA의 기본 이론을 탄탄하게 학습해서 초보자도 실무에서 자신있게 JPA를 사용할 수 있습니다., 실무에서도

www.inflearn.com


1. 엔티티 매핑

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

[@Entity]

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

@Entity(name = "UserEntity")
public class User {

	@Id
	@Column(name = "username") 
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private Long id;
	
	protected User() {
		// 기본 생성자
	}
	
	public User(Long id) {
		this.id = id;
	}
}

 

[@Table]

- @Table의 name 속성을 이용해 테이블 이름을 지정 가능. -

@Entity
@Table(name = "Member")
public class User {

	@Id
	@Column(name = "username") 
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private Long id;
	
	protected User() {
		// 기본 생성자
	}
	
	public User(Long id) {
		this.id = id;
	}
}


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

  • JPA을 사용해 구현했을 때 애플리케이션 실행 시점에 DDL을 자동으로 생성 해준다.
  • JPA는 데이터베이스 방언을 활용해서 적절한 DDL을 생성
  • JPA가 DDL을 자동으로 생성하기에 엔티티 클래스만 구현해도 테이블을 만들어준다.(객체중심)
  • 다만 이렇게 생성된 DDL은 개발 장비에서만 사용하거나 적절히 다듬은 후에 사용한다.

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

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

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

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

[DDL 생성 기능]

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

    @Id
    private Long id;

    @Column(nullable = false, length = 10, unique = true)
    private String username;

    @Column(nullable = false)
    private String email;

3. 필드와 컬럼 매핑

  • @Column : 컬럼 매핑
  • @Temporal : 날짜 타입 매핑
  • @Enumerated : enum 타입 매핑
  • @Lob : BLOB, CLOB 매핑
  • @Transient : 특정 필드를 컬럼에 매핑하지 않음 (매핑 무시)
package hellojpa; 
import javax.persistence.*; 
import java.time.LocalDate; 
import java.time.LocalDateTime; 
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; 
}

 

[@Column]

 

[@Enumerated]

  • ORDINAL 사용 X

 

[@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]

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

4. 기본 키 매핑

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

 

[기본 키 매핑 방법]

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

[IDENTITY 전략]

  • 기본 키 생성을 데이터베이스에 위임(예: MySQL의 AUTO_INCREMENT)
  • JPA는 보통 트랜잭션 커밋 시점에 INSERT SQL 실행
  • AUTO_INCREMENT는 데이터베이스에 INSERT SQL을 실행한 이후에 ID 값을 알 수 있다.
  • IDENTITY 전략은 em.persist() 시점에 즉시 INSERT SQL 실행하고 DB에서 식별자를 조회
@Entity 
public class Member { 

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

 

[SEQUENCE 전략]

  • 데이터베이스 시퀀스는 유일한 값을 순서대로 생성하는 특별한 데이터베이스 오브젝트
  • 주로 Oracle, 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;

 

[AUTO_INCREMENT 와 SEQUENCE의 차이점]

 

[TABLE 전략]

  • 키 생성 전용 테이블을 하나 만들어서 데이터베이스 시퀀스를 흉내내는 전략
    • 장점: 모든 데이터베이스에 적용 가능
    • 단점: 성능이 좋지않다.
  • 자연 키: 실제 비즈니스 의미를 가지고 있는 키이다. 예를 들어, 주민등록번호, 이메일 주소 등이 있다. 그러나 이러한 키는 변경될 가능성이 있거나, 비즈니스 로직에 따라 중복될 가능성이 있기 때문에 기본 키로 사용하기에 적절하지 않을 수 있다.
  • 대체 키: 비즈니스 의미가 없는 키로, 데이터베이스 내에서 유일하게 식별할 수 있도록 생성된 키이다. 주로 자동 증가되는 숫자 값이나 UUID 등을 사용한다.
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;

[권장하는 식별자 전략]

  • 기본 키 제약 조건: null이 아님, 유일해야 함, 변하면 안됨
  • 미래까지 위 조건을 만족하는 자연키는 찾기 어려우므로 대리키(대체키)를 사용하자.
  • 예를 들어 주민등록번호도 기본 키로 적절하지 않다.
  • 권장하는 것은 Long형 + 대체키 + 키 생성 전략을 사용하는 것이다.
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.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;

    private String name;

    // 기본 생성자, 게터, 세터
    protected Member() {
    }

    public Member(String name) {
        this.name = name;
    }

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