« back

[JPA] Entity의 Listener의 활용

jpa, spring
public class User {
    ...
    @Column(updatable = false)
    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();
    }
}

@PrePersist 를 사용하여 listener 효과를 낼 수 있다.

EventListener 만들기 #

public class MyEntityListener {

    @PrePersist
    public void prePersist(Object obj) {
        if (obj instanceof Auditable) {
            ((Auditable) obj).setCreatedAt(LocalDateTime.now());
            ((Auditable) obj).setUpdatedAt(LocalDateTime.now());
        }
    }

    @PreUpdate
    public void preUpdate(Object obj) {
        if (obj instanceof Auditable) {
            ((Auditable) obj).setUpdatedAt(LocalDateTime.now());
        }
    }
}

@EntityListeners(value = MyEntityListener.class)
public class User implements Auditable {

createdAt, updatedAt 을 일일히 모든 entity 마다 반복하여 코딩하는것보다는, implements Auditable 을 달고 EntityListeners annotation과 value값을 달아준다.

★ JPA 기본 Listener #

main class에 @EnableJpaAuditing annotation 추가

@EnableJpaAuditing
public class BookmanagerApplication {

@EntityListeners(value = AuditingEntityListener.class)
public class Book implements Auditable {
    ...
    @CreatedDate
    private LocalDateTime createdAt;

    @LastModifiedDate
    private LocalDateTime updatedAt;
    ...
}
  1. User, Book, UserHistory class에 @EntityListeners 의 value 값을 AuditingEntityListener로 변경.
  2. createdAt 메서드에 @CreatedDate,
  3. updatedAt 메서드에 @LastModifiedDate annotation 추가.

이렇게 간단하게 Jpa에서 자동으로 제공해주는 Listener을 사용할 수 있음.

하지만 또 User, Book, UserHistory 등 모든 클래스의 메서드에 어노테이션을 추가해야하기 때문에, 아래의 방법을 사용해보자.

BaseEntity 클래스를 아래와 같이 생성.

@Data
@MappedSuperclass
@EntityListeners(value = AuditingEntityListener.class)
public class BaseEntity {

    @CreatedDate
    private LocalDateTime createdAt;

    @LastModifiedDate
    private LocalDateTime updatedAt;
}

public class User extends BaseEntity {

@ToString(callSuper = true)
@EqualsAndHashCode(callSuper = true)