JPA中EntityListeners注解的使用

使用場景

EntityListeners在jpa中使用，如果你是mybatis是不可以用的

它的意義

對實體屬性變化的跟蹤，它提供了保存前，保存后，更新前，更新后，刪除前，刪除后等狀態，就像是攔截器一樣，你可以在攔截方法里重寫你的個性化邏輯。

它的使用

定義某種功能類型

@Embeddable注解表示這個對象不是單獨的數據表，它里面的字段會在其它實體中公用

/**
 * 數據建立與更新.
 * Embeddable注解表示不會生成新的數據表，而它的屬性會在其它表內部，比較容易實現代碼復用.
 */
@Getter
@Setter
@Embeddable
public class Audit {

  @Column(name = "created_on")
  private LocalDateTime createdOn;

  @Column(name = "created_by")
  private String createdBy;

  @Column(name = "updated_on")
  private LocalDateTime updatedOn;

  @Column(name = "updated_by")
  private String updatedBy;
}

定義接口，對上面類型進行讀和寫的行為

/**
 * 數據建立與更新.
 */
public interface Auditable {

  Audit getAudit();

  void setAudit(Audit audit);
}

定義跟蹤器，接口參數會在具體實現類中傳過來

/**
 * Hibernate 事件監聽器.
 * 實體監聽@EntityListeners(AuditListener.class).
 */
@Slf4j
@Component
@Transactional
public class AuditListener {
  @PrePersist
  public void setCreatedOn(Auditable auditable) {
    Audit audit = auditable.getAudit();

    if (audit == null) {
      audit = new Audit();
      auditable.setAudit(audit);
    }

    audit.setCreatedOn(LocalDateTime.now());
    audit.setUpdatedOn(LocalDateTime.now());
  }

  @PreUpdate
  public void setUpdatedOn(Auditable auditable) {
    Audit audit = auditable.getAudit();
    audit.setUpdatedOn(LocalDateTime.now());
  }
}

實體去實現這個對應的跟蹤接口

@Embedded注解表示它是一個內嵌到當前實體里的對象，它自己不是實體，它只表示實體里某些字段。

@EntityListeners(DataEntityListener.class)
public class Product implements DataEntity {
  /**
   * 存儲復雜對象內的元素.
   */
  @Embedded
  private Audit audit;

  @Override
  public Audit getAudit() {
    return audit;
  }

  @Override
  public void setAudit(Audit audit) {
    this.audit = audit;
  }
}

上面代碼將實現在實體保存時對Audit實體里的createdOn，updateOn進行賦值，當實體進行更新時對updateOn進行重新賦值的操作。

注意，在當前實體Product對應的數據表里，它會有Audit類型里的屬性，即它的數據表字段會有created_on,created_by,updated_on和updated_by等。