[JPA] 리스너 - 엔티티의 생명주기에 따른 이벤트 처리

리스너

모든 엔티티를 대상으로 언제 어떤 사용자가 삭제를 요청했는지 모두 로그로 남겨야 하는 요구사항이 있다고 가정하자.

이때 애플리케이션 삭제 로직을 하나 하나 찾아가며 로그를 남기는 것은 너무 비효율적이다. 

이럴 때 JPA의 리스너 기능을 사용하면, 엔티티의 생명주기에 따른 이벤트를 처리할 수 있다.

 

 

---

 

이벤트의 종류

이벤트의 종류와 발생 시점은 다음과 같다.

 

• PostLoad : 엔티티가 영속성 컨텍스트에 조회된 직후, 또는 refresh를 호출한 후(2차 캐시에 저장되어 있어도 호출된다.)
• PrePersist : persist() 메소드를 호출해서 엔티티를 영속성 컨텍스트에 관리하기 직전에 호출된다. 식별자 생성 전략을 사용한 경우에는 엔티티의 식별자는 존재하지 않는 상태이다. 새로운 인스턴스를 merge 할 때도 수행된다.
• PreUpdate : flush나 commit을 호출해서 엔티티를 데이터베이스에 수정하기 직전에 호출된다.
• PreRemove : remove 메소드를 호출해서 엔티티를 영속성 컨텍스트에서 삭제하기 직전에 호출된다. 또한 삭제 명령어로 영속성 전이가 일어날 때도 호출된다. orphanRemoval 에 대해서는 flush나 commit 시에 호출된다.
• PostPersist : flush나 commit을 호출해서 엔티티를 데이터베이스에 저장한 직후에 호출된다. 식별자가 항상 존재한다. 참고로 식별자 생성 전략이 IDENTITY인 경우 식별자를 생성하기 위해 persist()를 호출하면서 데이터베이스에 해당 엔티티를 저장하므로, 이때는 persist()를 호출한 직후에 바로 PostPersist가 호출된다.
• PostUpdate : flush나 commit을 호출해서 엔티티를 데이터베이스에 수정한 직후에 호출된다.
  • persist 시에는 호출되지 않는다
  • 변경 감지로 인해 업데이트 될 때에도 호출된다.
• PostRemove : flush나 commit을 호출해서 엔티티를 데이터베이스에 삭제한 직후에 호출된다.

 

 

 

 

---

이벤트 적용 위치

이벤트는 엔티티에서 직접 받거나, 별도의 리스너를 등록해서 받을 수 있다.

• 엔티티에 직접 적용
• 별도의 리스너 사용
• ...

 

 

 

엔티티에 직접 적용

@Getter
@NoArgsConstructor(access = AccessLevel.PUBLIC)
@Entity
public class Member {

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    private String name;
    
    @PostLoad
    public void postLoad() {
        System.out.println("PostLoad");
    }
    @PrePersist
    public void prePersist() {
        System.out.println("prePersist");
    }
    @PreUpdate
    public void preUpdate() {
        System.out.println("PreUpdate");
    }
    @PreRemove
    public void preRemove () {
        System.out.println("PreRemove ");
    }
    @PostPersist
    public void postPersist() {
        System.out.println("PostPersist ");
    } 
    @PostUpdate
    public void postUpdate () {
        System.out.println("PostUpdate ");
    }
    @PostRemove
    public void postRemove() {
        System.out.println("PostRemove ");
    }
}

 

 

 

별도의 리스너 등록

@Getter
@NoArgsConstructor(access = AccessLevel.PUBLIC)
@Entity
@EntityListeners(Listener.class)
public class Member {

    @Id @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    private String name;


}

public class Listener {
    @PostLoad
    public void postLoad(Member obj){
        System.out.println("PostLoad obj = "+obj);
    }
    @PrePersist
    public void prePersist(Member obj){
        System.out.println("prePersist"+obj);
    }
    @PreUpdate
    public void preUpdate(Object obj){
        System.out.println("PreUpdate");
    }
    @PreRemove
    public void preRemove (Object obj){
        System.out.println("PreRemove ");
    }
    @PostPersist
    public void postPersist (Object obj){
        System.out.println("PostPersist ");
    } 
    @PostUpdate
    public void postUpdate (Object obj){
        System.out.println("PostUpdate ");
    }
    @PostRemove
    public void postRemove(Object obj){
        System.out.println("PostRemove ");
    }
}

 

들어오는 타입이 확실하다면 Object 대신 타입을 적어줘도 된다!

 

 

 

📔 Reference

[자바 ORM 표준 JPA 프로그래밍]