Home Entity
Post
Cancel

Entity

minsokim on Jul 4, 20212021-07-04T15:25:58+09:00

Entity Annotation

@Entity

  • 해당 객체가 JPA에서 관리하는 Entity객체임을 표시한다.

@Id

  • 레코드를 유일하게 식별 할 수 있는 PK를 지정한다.

@GeneratedValue

  • strategy
    • IDENTITY
      • mysql에서 많이 사용하는 전략
      • DB의 AUTO increasment 값을 활용해 트랜잭션이 동작하기 전에 Insert문이 동작을 해서 ID값을 사전에 받아온다. 커밋되지 않고 종료해도 이미 ID값이 증가한 상태여서 중간이 비어있는 상태가 발생할 수 있다.
    • SEQUENCE
      • sequence라는 특별한 함수를 제공하는 oracle, postgresql, h2 등에서 사용한다.
    • TABLE
      • DB의 종류에 상관 없이 별도의 ID관리용 Table을 만들고 해당 Table에서 ID값을 추출해서 사용하도록 제공하는 전략
    • AUTO(Default)
      • 각 DB에 적합한 전략을 자동으로 넘겨준다.

@Table

  • 해당 Entity의 table명을 지정할 수 있다. 없을 경우 객체 이름 기준으로 생성이 된다.

    1
2

      @Entity
  @Table(name = "user", indexes = {@Index(columnList = "name")}, uniqueConstraints = {@UniqueConstraint(columnNames = {"email"})})

  • index나 제약사향을 정의 할 수 있다. 하지만 실제 DB에 적용된 것과 다를 수 있다.

@Column

  • DB의 Column명을 지정할 수 있다.

    1
2
3
4
5
6
7
8

      public class User{

      @Id
      private Long id;
   
      @Column(name = "crtd")
      private LocalDateTime createdAt;
  }
    • DB의 crtd column과 Entity의 createdAt을 Mapping

  • nullable, unique (true, false)속성을 지정할 수 있고 length도 지정할 수 있다..

    1
2
3
4
5
6
7
8

      public class User{

      @Id
      private Long id;
   
      @Column(nullable = false)
      private LocalDateTime createdAt;
  }

@Transient

  • 해당 Annotation이 작성되어 있는 field는 영속성 처리에서 제외 되기 때문에 DB Data에 반영되지 않고 객체의 생성주기와 함께하게 된다.

    1
2
3
4
5
6
7
8
9
10
11
12
13
14

      public class User{

      @Id
      private Long id;

      @Column(updatable = false)
      private LocalDateTime createdAt;

      @Column(insertable = false)
      private LocalDateTime updatedAt

      @Transient
      private String testStr;
  }

enum

  • enum의 경우 default속성이 ordinal로 되어있다. DB에 저장될 때 순서에 따라 0번 index부터 차례로 값이 저장된다.

    1
2
3
4

      public enum Gender {
      MALE,
      FEMALE
  }
  • 위의 enum 속성을 가지는 Entity가 있을 경우 male이면 DB에 0으로 저장이된다. 만약 BOY, GIRL이 앞에 추가되었다면 이후 0은 BOY가 되고 이전에 저장된 MALE에 대한 정보를 제대로 가져올 수 없게된다.

  • 다음과 같이 ordinal이 아닌 string으로 저장하는 옵션을 선택하면 번호가 아닌 String값으로 저장되기 때문에 이런 문제를 방지할 수 있다.

    1
2

      @Enumerated(value = EnumType.STRING)
  private Gender gender;

Entity Listener

JPA event

  • @PrePersist
    • Insert method 호출 전
  • @PreUpdate
    • update method 호출 전
  • @PreRemove
    • delete method 호출 전
  • @PostPersist
    • insert method 호출 후
  • @PostUpdate
    • update method 호출 후
  • @PostRemove
    • delete method 호출 후
  • @PostLoad
    • Select 조회가 수행 된 후
  • 다음과 같이 업데이트 및 생성 전에 생성 시간 수정 시간을 자동으로 변경하게 해줄 수 있다.
    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

      @Entity
  public class User {
      ...    
        
      private LocalDateTime createdAt;
      private LocalDateTime updatedAt;
      ...

      @PrePersist
      public void prePersist(){
          this.createdAt = LocalDateTime.now();
          this.updatedAt = LocalDateTime.now();
      }
    
      @PreUpdate
      public void preUpdate(){
          this.updatedAt = LocalDateTime.now();
      }
  }

Listener 작성

  • 만약 entity가 여러개라면 모든 class마다 createdAt, updatedAt을 처리하기 위한 listener를 작성해야한다. Listener동작을 묶어서 Class를 만든 뒤 EntityListeners Annotation으로 일괄 작업을 할 수 있다.
  • Listener Class를 만들기 전에 entity들이 createdAt, updatedAt field를 가지고 있어야 하므로 interface를 만들어 entity가 구현하게 한다.

    • BaseEntity

      1
2
3
4
5
6
7

        public interface BaseEntity {
      LocalDateTime getCreatedAt();
      LocalDateTime getUpdatedAt();
        
      void setCreatedAt(LocalDateTime createdAt);
      void setUpdatedAt(LocalDateTime updatedAt);
  }

    • User

      1
2
3
4
5
6
7
8
9
10

        ...
  @Entity
  @EntityListeners(value = MyEntityListener.class)
  public class User implements BaseEntity{
            
      ...
      private LocalDateTime createdAt;
      private LocalDateTime updatedAt;
      ...
  }
      • EntityListeners로 Listener를 지정해준다.

  • Listener작성

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

      public class MyEntityListener {
      @PrePersist
      public void prePersist(Object o){
          if(o instanceof BaseEntity){
              ((BaseEntity) o).setCreatedAt(LocalDateTime.now());
              ((BaseEntity) o).setUpdatedAt(LocalDateTime.now());
          }
      }
    
      @PreUpdate
      public void preUpdate(Object o){
          if(o instanceof BaseEntity){
              ((BaseEntity) o).setUpdatedAt(LocalDateTime.now());
          }
      }
  }
    • 시간 속성 두개를 가지는 interface를 구현하도록 User를 만들었므로 들어온 객체가 해당 interface를 구현한것인지 확인하고 동작을 작성해주면 된다.
    • 이후에는 BaseEntity를 구현하도록 Entity Class를 구현하고, EntityListeners Annotation을 통해 Listener만 지정해주면 된다.

Auditing Entity Listener

  • createdAt, updatedAt과 같은 경우 많이 사용하는 field이기 때문에 JPA에서 Listener를 제공한다.

    1
2
3
4
5
6
7
8

      @SpringBootApplication
  @EnableJpaAuditing
  public class ExampleApplication {

      public static void main(String[] args) {
          SpringApplication.run(ExampleApplication.class, args);
      }
  }

  • EnableJpaAuditing Annotation을 작성해 Auditing하겠다는 것을 표시하고 각 entity에 listener를 작성하고, 추가 Annotation을 작성해주면 된다.

    1
2
3
4
5
6
7
8
9
10
11
12
13
14

      @Data
  @Entity
  @EntityListeners({AuditingEntityListener.class})
  public class User implements BaseEntity{

      ...
      @CreatedDate
      private LocalDateTime createdAt;
    
      @LastModifiedDate
      private LocalDateTime updatedAt;
    
      ...
  }
    • AuditingEntityListener를 추가하고, CreatedDate 혹은 LastModifiedDate같은 Annotation을 감시하려는 field에 작성해주면 된다.

MappedSuperclass

  • Entity는 Entity만 상속받을 수 있다. 하지만 부모 객체를 아래의 코드처럼 Table을 만들 목적이 아닌 공통으로 사용할 부분을 공통으로 처리하기위해 사용하고 싶은 경우가 있다.
  • 이럴 때 부모가 될 Class에 MappedSuperclass Annotation을 작성하는 것으로 Entity에서 상속받을 수 있도록 할 수 있다.
1
2
3
4
5
6
7
8
9
10
11

@Data
@MappedSupperclass
@EntityListener(value = AuditingEntityListener.class)
public class BaseEntity{

    @CreatedDate
    private LocalDateTime createdAt;

    @LastModifiedDate
    private LocalDateTime updatedAt;
}

1
2
3
4
5
6
7
8
9

@Data
@Entity
@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)
public class User extends BaseEntity implements BaseEntity{

    ...

}

Embeddable

  • embeddable객체는 entity내부에서 가질 수 있고 Table이 생성될 때 마치 원래 entity내부의 Field처럼 취급된다.
1
2
3
4
5
6
7
8
9
10

@Data
@AllArgsConstructor
@NoArgsConstructor
@Embeddable
public class Address {
    private String city;
    @Column(name = "address_detail")
    private String details;
    private String zipCode;
}

1
2
3
4
5
6
7
8

...
@Entity
public class Member {
    ...
    @Embedded
    private Address address;
    ...
}
  • 만약 집주소, 회사 주소에 대한 Column이 필요할 때 Embedded를 사용하지 않는다면 아래와 같이 작성해야한다.
1
2
3
4
5
6
7
8
9

private String homeCity;
private String homeDistrict;
private String homeDetail;
private String homeZipCode;

private String companyCity;
private String companyDistrict;
private String companyDetail;
private String companyZipCode;
  • Embedded를 사용하면 아래와 같이 적용할 수 있다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

@Embedded
@AttributeOverrides({
	@AttributeOverride(name = "city", column = @Column(name = "home_city")),
	@AttributeOverride(name = "detail", column = @Column(name = "home_address_detail")),
	@AttributeOverride(name = "zipCode", column = @Column(name = "home_zip_code")),
})
private Address homeAddress;

@Embedded
@AttributeOverrides({
	@AttributeOverride(name = "city", column = @Column(name = "company_city")),
	@AttributeOverride(name = "detail", column = @Column(name = "company_address_detail")),
	@AttributeOverride(name = "zipCode", column = @Column(name = "company_zip_code")),
})
private Address companyAddress;
  • 객체 재활용면에서 좋을 수 있으나 Annotation의 반복으로 가독성이 오히려 떨어질 수 있다. 적절히 선택해 사용해야한다.
Spring/Spring Boot, JPA
Spring Spring Boot JPA Entity EntityListener MappedSupperclass Embeddable
This post is licensed under CC BY 4.0 by the author.
Recent Update
Contents

ORM

Repository Interface