spring?jpa?審計(jì)功能自定義填充字段方式

更新時(shí)間：2021年11月25日 14:32:48 作者：哎吆不錯(cuò)哦

這篇文章主要介紹了spring?jpa審計(jì)功能自定義填充字段方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

spring jpa 審計(jì)功能自定義填充字段

spring data jpa 通過@CreateBy等注解實(shí)現(xiàn)了審計(jì)功能（在新建或者修改的時(shí)候自動(dòng)填充某些字段）但是當(dāng)我們有多個(gè)字段需要填充的時(shí)候就不滿足了這就需要我們自己實(shí)現(xiàn)相關(guān)接口來(lái)實(shí)現(xiàn)自動(dòng)填充

有兩種方式

一種是實(shí)現(xiàn) auditable接口但是這樣會(huì)在實(shí)體類中莫名增加很多setter getter方法會(huì)對(duì)序列化造成干擾所以不推薦
我推薦的是第二種方法重寫Listener

具體步驟

在configration 類開啟審計(jì)功能

@SpringBootApplication
@EnableJpaAuditing
public class Config() {
}

實(shí)現(xiàn)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
}

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

@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);
    }
}

實(shí)現(xiàn)自定義的 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審計(jì)功能

突然發(fā)現(xiàn) Spring Data JPA 有這么一個(gè)功能，英文是 Auditing

JPA Audit 說明

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

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

@CreatedDate：表示該字段為創(chuàng)建時(shí)間時(shí)間字段，在這個(gè)實(shí)體被insert的時(shí)候，會(huì)設(shè)置值
@CreatedBy：表示該字段為創(chuàng)建人，在這個(gè)實(shí)體被insert的時(shí)候，會(huì)設(shè)置值
@LastModifiedDate、@LastModifiedBy同理。

如何使用審計(jì)功能

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

這個(gè)時(shí)候，在jpa.save方法被調(diào)用的時(shí)候，時(shí)間字段會(huì)自動(dòng)設(shè)置并插入數(shù)據(jù)庫(kù)，但是CreatedBy和LastModifiedBy并沒有賦值，因?yàn)樾枰獙?shí)現(xiàn)AuditorAware接口來(lái)返回你需要插入的值。

1.編寫AuditorAware

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

2.在實(shí)體類中聲明@EntityListeners和相應(yīng)的注解

考慮到所有實(shí)體都需要聲明，就寫在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;
    /**
     * 實(shí)體創(chuàng)建時(shí)間
     */
    @Temporal(TemporalType.TIMESTAMP)
    @CreatedDate
    protected Date dateCreated = new Date();
 
    /**
     * 實(shí)體修改時(shí)間
     */
    @Temporal(TemporalType.TIMESTAMP)
    @LastModifiedDate
    protected Date dateModified = new Date(); 
     #省略getter setter
}

3.在Application 中啟用審計(jì)@EnableJpaAuditing

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

經(jīng)過測(cè)試如果你的實(shí)體類上面的多個(gè)字段使用了@CreatedBy這樣的注解，只會(huì)有一個(gè)生效，也就是說在一次請(qǐng)求中，只會(huì)被調(diào)用一次

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: