spring?jpa審計功能如何自定義填充字段

小編給大家分享一下spring jpa審計功能如何自定義填充字段，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！

spring jpa 審計功能自定義填充字段

spring data jpa 通過@CreateBy等注解實現了審計功能（在新建或者修改的時候自動填充某些字段） 但是當我們有多個字段需要填充的時候就不滿足了 這就需要我們自己實現相關接口來實現自動填充

有兩種方式

• 一種是實現 auditable接口 但是這樣會在實體類中莫名增加很多setter getter方法 會對序列化造成干擾 所以不推薦

• 我推薦的是第二種方法 重寫Listener

具體步驟

在configration 類開啟審計功能

@SpringBootApplication
@EnableJpaAuditing
public class Config() {
}

實現entity通用繼承類 指定自定義的listener

@EntityListeners({CustomAuditingListener.class})
public class Base{
 private Long id;
 private Long creator;
 private String creatorName;
 private Long modifier;
 private String modifierName;
     ... 省略setter getter
}

實現自定義listener 其中有兩個核心的接口 @PrePersist 和 @PreUpdate 第一個是在保存的前置方法（新增 和 更新） 第二個是更新的前置方法 通過這兩個方法就可以實現自己填充

@Configurable
public class CustomAuditingListener implements ConfigurableObject {
    public AuditListener() {
    }
    @Autowired
    private AuditHandler auditHandler;
    @PrePersist
    private void prePersist(Object obj) {
        auditHandler.prePersist(obj);
    }
    @PreUpdate
    private void preUpdate(Object obj) {
        auditHandler.preUpdate(obj);
    }
}

實現自定義的 AuditHandler

@Component
public class CustomAuditHandler implements AuditHandler {
    @Override
    public void prePersist(Object obj) {
        if (obj instanceof Base) {
            Base ae = (Base) obj;
            if (ae.getId() == null) {
                this.markForCreate(ae);
            }
        }
    }
    @Override
    public void preUpdate(Object obj) {
        if (obj instanceof Base) {
            Base ae = (Base) obj;
            this.markForUpdate(ae);
        }
    }
    public void markForCreate(Base be) {
        ae.setCreator("自己獲取的用戶id");
        ae.setCreatorName("自己獲取的用戶名稱");
    }
    public void markForUpdate(Base ae) {
        ae.setModifier("自己獲取的用戶id");
        ae.setModifierName("自己獲取的用戶名稱");
    }
}*/

啟用Spring Data JPA審計功能

突然發現 Spring Data JPA 有這么一個功能，英文是 Auditing

JPA Audit 說明

在spring jpa中，支持在字段或者方法上進行注解@CreatedDate、@CreatedBy、

@LastModifiedDate、@LastModifiedBy，從字面意思可以很清楚的了解，這幾個注解的用處。

• @CreatedDate：表示該字段為創建時間時間字段，在這個實體被insert的時候，會設置值

• @CreatedBy：表示該字段為創建人，在這個實體被insert的時候，會設置值

• @LastModifiedDate、@LastModifiedBy同理。

如何使用審計功能

首先申明實體類，需要在類上加上注解@EntityListeners(AuditingEntityListener.class)，其次在application啟動類中加上注解EnableJpaAuditing，同時在需要的字段上加上@CreatedDate、@CreatedBy、@LastModifiedDate、@LastModifiedBy等注解。

這個時候，在jpa.save方法被調用的時候，時間字段會自動設置并插入數據庫，但是CreatedBy和LastModifiedBy并沒有賦值，因為需要實現AuditorAware接口來返回你需要插入的值。

1.編寫AuditorAware

/**
 * 監聽
 * @CreatedBy
 * @LastModifiedBy
 * 自動注入用戶名
 */
@Configuration
public class UserAuditorAware implements AuditorAware<String> {  
    @Override
    public Optional<String> getCurrentAuditor() {
        //TODO: 根據實際情況取真實用戶
        return Optional.of("admin");
    }
}

2.在實體類中聲明@EntityListeners和相應的注解

考慮到所有實體都需要聲明，就寫在BaseEntityModel 中

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class)
public class BaseEntityModel  implements Serializable { 
    /**
     * 
     */
    private static final long serialVersionUID = -6163675075289529459L; 
    @JsonIgnore
    String entityName = this.getClass().getSimpleName();
 
    @CreatedBy
    String createdBy;
 
    @LastModifiedBy
    String modifiedBy;
    /**
     * 實體創建時間
     */
    @Temporal(TemporalType.TIMESTAMP)
    @CreatedDate
    protected Date dateCreated = new Date();
 
    /**
     * 實體修改時間
     */
    @Temporal(TemporalType.TIMESTAMP)
    @LastModifiedDate
    protected Date dateModified = new Date(); 
     #省略getter setter
}

3.在Application 中啟用審計@EnableJpaAuditing

@SpringBootApplication
@EnableJpaAuditing
public class Application {    
    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application .class, args);
    }
 
    /**
     * 測試中如果無法自動識別,可能是包路徑的問題，采用手動聲明bean的方式
     * @return
     */
    @Bean
    public UserAuditorAware setUserAuditorAware(){
        return new UserAuditorAware();
    }
}

經過測試如果你的實體類上面的多個字段使用了@CreatedBy這樣的注解，只會有一個生效，也就是說在一次請求中，只會被調用一次

看完了這篇文章，相信你對“spring jpa審計功能如何自定義填充字段”有了一定的了解，如果想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！