JPA - Entity

📖 JPA Entity?

관계형 데이터베이스에서 데이터를 저장하고 관리하기 위해 자바 객체를 사용하는 방식인 ORM에서 사용되는 객체를 말합니다.

JPA Entity

데이터베이스 테이블과 매핑되는 자바 클래스입니다. 해당 클래스는 데이터베이스 테이블의 구조와 동일한 구조를 가져야하며, 클래스 내의 멤버 변수는 테이블의 컬럼과 매핑됩니다.

create table user_data (
       id integer not null,
        created_at timestamp(6),
        email varchar(255),
        name varchar(255),
        updated_at timestamp(6),
        primary key (id)
)

예를 들어 해당 테이블과 매핑되는 Entity클래스를 만들기 위해서는 해당 테이블과 동일한 구조를 가진 클래스가 필요합니다. 각 컬럼과 매핑되는 멤버 변수를 선언하고, 해당 변수를을 getter, setter 메서드로 접근할 수 있도록 만들어야 합니다.

JPA Entity 클래스에는 반드시 @Entity 어노테이션을 사용해야 해당 클래스가 데이터베이스와 매핑된다는 것을 인식할 수 있습니다.

Id

@Id로 PrimaryKey 역할을 하는 필드를 지정하고 @GeneratedValue 어노테이션을 사용하여 PrimaryKey 값을 자동으로 생성하는 방법을 지정할 수 있습니다.

@GeneratedValue

@Id 어노테이션과 함께 사용되며 자동으로 고유한 값을 생성하며 고유ID(PK)를 생성하는 방법에 대한 정보를 제공하는 어노테이션입니다.

@Target({METHOD, FIELD})
@Retention(RUNTIME)

public @interface GeneratedValue {

    /**
     * (Optional) The primary key generation strategy
     * that the persistence provider must use to
     * generate the annotated entity primary key.
     */
    GenerationType strategy() default AUTO;

    /**
     * (Optional) The name of the primary key generator
     * to use as specified in the {@link SequenceGenerator} 
     * or {@link TableGenerator} annotation.
     * <p> Defaults to the id generator supplied by persistence provider.
     */
    String generator() default "";
}

public enum GenerationType { 

    /**
     * Indicates that the persistence provider must assign 
     * primary keys for the entity using an underlying 
     * database table to ensure uniqueness.
     */
    TABLE, 

    /**
     * Indicates that the persistence provider must assign 
     * primary keys for the entity using a database sequence.
     */
    SEQUENCE, 

    /**
     * Indicates that the persistence provider must assign 
     * primary keys for the entity using a database identity column.
     */
    IDENTITY,

    /**
     * Indicates that the persistence provider must assign
     * primary keys for the entity by generating an RFC 4122
     * Universally Unique IDentifier.
     */
    UUID,

    /**
     * Indicates that the persistence provider should pick an 
     * appropriate strategy for the particular database. The 
     * <code>AUTO</code> generation strategy may expect a database 
     * resource to exist, or it may attempt to create one. A vendor 
     * may provide documentation on how to create such resources 
     * in the event that it does not support schema generation 
     * or cannot create the schema resource at runtime.
     */
    AUTO
}

해당 어노테이션과 내부의 GenerationType입니다. @GeneratedValue에는 4가지의 전략이 제공됩니다.

GenerationType

• AUTO : 데이터베이스 플랫폼을 기반으로한 생성 전략을 자동으로 선택합니다. (기본값)

• IDENTITY : 엔티티에 대한 고유한 PK를 생성하기 위해 데이터베이스에 의존합니다. 주로 자동 증가 숫자 열을 지원하는 데이터베이스와 사용되며 새로운 엔티티가 영속되는 경우 데이터베이스는 새로운 고유 ID값을 생성하여 엔티티의 ID 필드에 할당합니다.

• SEQUENCE : 데이터베이스 시퀀스를 사용하여 고유한 기본 키 값을 생성합니다. 시퀀스를 지원하는 데이터베이스와 함께 사용되며 IDENTITY전략보다 더 나은 성능을 보여줍니다. 새 엔티티가 영속되면 데이터베이스 시퀀스에서 새 값을 요청 엔티티의 ID필드에 할당합니다.

@Data
@AllArgsConstructor
@RequiredArgsConstructor
@NoArgsConstructor
@Builder
@Entity
@SequenceGenerator(
        name = "TEST_SEQ",
        sequenceName = "USER_SEQ_GEN",
        initialValue = 1,
        allocationSize = 50
)
public class UserData {
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "TEST_SEQ")
    @Id
    private int id;

    @NonNull
    private String name;

    @NonNull
    private String email;

    private LocalDateTime createdAt;

    private LocalDateTime updatedAt;
}

@SequenceGenerator를 사용하여 지정할 수 있으며 안에 들어간 내용은 각각 다음과 같습니다.

• name : 시퀀스 제너레이터 이름
• sequenceName : 시퀀스 이름- > PK값을 생성하는데 사용할 데이터베이스 시퀀스의 이름을 지정
• initialValue : 해당 엔티티의 PK의 초기값 default 1
• allocationSize : 메모리를 통해 할당할 범위 사이즈 default 50

종합해보면 해당 엔티티에서 Id값을 자동생성할 때 초기값은 1, 식별자 생성기를 설정해 놓은 TEST_SEQ로 설정, 50까지는 메모리에서 현재 시퀀스에서 값을 저장하며 이후 51이 되는 시점에 DB 시퀀스를 한번 더 호출한 이후 100까지 가상으로 시퀀스 식별자를 관리하겠다는 내용입니다.

• TABLE : DB종류에 상관없이 별도의 테이블을 만들어두고 해당 테이블에서 ID값을 계속 추출해서 사용할 수 있도록 제공합니다. -> Key생성 Table

해당 전략은 SEQUENCE전략과 동일하게 generator를 설정하여 매핑합니다. 주로 다른 전략을 사용하지 않을 때 사용합니다.

@Column어노테이션으로 멤머 변수와 데이터베이스 column간의 매핑을 지정합니다.

Entity클래스를 생성했다면 해당 클래스와 관련된 CRUD를 제공하는 작업을 수행하기 위한 Repository인터페이스를 정의하고 메서드를 작성해야 합니다.

@Table

해당 어노테이션은 데이터베이스 테이블 간의 매핑을 정의하는데 사용됩니다. 엔티티 클래스에 적용되며 테이블의 이름과 구성해야 하는 추가 테이블 수준 속성을 지정합니다.

• name : 엔티티가 매핑될 데이터베이스 테이블의 이름을 지정할 수 있습니다. default는 엔티티 클래스 이름과 동일합니다.

• category : 데이터베이스 테이블의 카테고리 지정할 수 있습니다. default : ""

• scherma : 데이터베이스 테이블의 스키마를 지정할 수 있습니다. default : ""

• UniqueConstraint[] : 테이블에 배치해야 하는 고유 제약 조건을 지정할 수 있습니다. @Column, @JoinColumn 어노테이션으로 모든 제약 조건과 PK매핑이 수반하는 제약 조건외에도 적용이 가능합니다. default : {}

• Index[] : 테이블에 대해 생성해야 하는 인덱스를 지정할 수 있습니다. deafult : {} -> @NonNull와 같은 역할

@Table 어노테이션은 테이블을 매핑하는데 사용하며 엔티티, 테이블 네임, 스키마 등을 적용해야 하는 조건을 지정하는데 사용될 수 있습니다. 하지만 실제 DB에 index설정이 되어있지 않은데 테이블 속성에 index설정이 되어있다고 해서 동작하지 않습니다.

인덱스나 제약사항들은 DB설정에 맡기고 Entity에 표기하지 않는 것이 조금 더 좋아보입니다.

🤔 사용해야 하는 이유는?

JPA Entity 클래스를 작성하면, 해당 클래스를 사용하여 데이터베이스와 상호작용하는데 사용될 수 있습니다. 해당 클래스는 다양한 JPA 쿼리 메서드를 사용하여 데이터베이스에서 데이터를 검색하고 저장할 수 있습니다.

❌ 문제가 되는 경우

1. 로직 분리 어려움

JPA Entity는 데이터베이스와 1:1로 매핑되는 객체입니다. 객체지향 프로그래밍에서 권장하는 엔티티와 비즈니스 로직을 분리하는 방식을 사용하기 어려워 Service 등을 추가로 구현해야 할 수도 있습니다.

2. 일부 기능 미지원

JPA Entity는 데이터베이스의 기본 기능을 지원하며, 일부 기능은 지원하지 않을 수 있습니다. 이러한 경우 Native Query를 사용하거나 별도의 JDBC 코드를 작성해야 할 수도 있습니다.

3. 성능 이슈

데이터베이스와의 매핑을 위해 많은 메타데이터를 생성합니다. JPA 내부동작을 위해 필요하지만, 실행시간이 늘어나는 원인이 될 수 있습니다. 또한 Entity는 객체 그래프를 따라 다른 Entity 객체를 자동으로 로드하는 기능을 제공합니다 이 때, 불필요한 Entity 객체를 로드하는 경우가 발생할 수 있으며 이는 성능 문제를 야기할 수 있습니다.

✅ 요약

• ORM에서 사용되는 객체이며 데이터베이스 테이블과 매핑되는 자바 클래스
• 데이터베이스 테이블과 1:1구조로 같은 구성이여야 한다.
• 다양한 쿼리 메서드제공으로 개발자에게 편리함을 가져다 준다.
• 많은 메타데이터 생성, 독립적이지 못한 객체 로드는 성능 이슈를 가져온다.