spring jpa 审计功能自定义填充字段方式

 更新时间:2021年11月25日 14:32:48   作者:哎吆不错哦  
这篇文章主要介绍了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这样的注解,只会有一个生效,也就是说在一次请求中,只会被调用一次

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • java对象池管理方式common-pool2使用

    java对象池管理方式common-pool2使用

    这篇文章主要为大家介绍了java对象池common-pool2使用示例解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • Java的Hibernate框架数据库操作中锁的使用和查询类型

    Java的Hibernate框架数据库操作中锁的使用和查询类型

    这篇文章主要介绍了Java的Hibernate框架数据库操作中锁的使用和查询类型,Hibernate是Java的SSH三大web开发框架之一,需要的朋友可以参考下
    2016-01-01
  • java多线程CyclicBarrier的使用案例,让线程起步走

    java多线程CyclicBarrier的使用案例,让线程起步走

    这篇文章主要介绍了java多线程CyclicBarrier的使用案例,让线程起步走!具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • 利用@Value注解为bean的属性赋值方法总结

    利用@Value注解为bean的属性赋值方法总结

    这篇文章主要介绍了利用@Value注解为bean的属性赋值方法总结,文中有详细的代码示例,对学习@Value注解有一定的参考价值,需要的朋友可以参考下
    2023-05-05
  • Java如何使用Query动态拼接SQL详解

    Java如何使用Query动态拼接SQL详解

    这篇文章主要给大家介绍了关于Java如何使用Query动态拼接SQL的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-01-01
  • 一文详解JDK21中虚拟线程

    一文详解JDK21中虚拟线程

    虚拟线程是JDK19中引入的,JDK21正式发布,本文主要介绍了JDK21中虚拟线程,具有一定的参考价值,感兴趣的可以了解一下
    2023-10-10
  • Java 注解@PostConstruct的原理及最佳使用场景分析

    Java 注解@PostConstruct的原理及最佳使用场景分析

    @PostConstruct 是 Java 中非常实用的注解,尤其是在 Spring 等框架中,它使得开发者可以方便地在 Bean 初始化后执行额外的操作,本文给大家介绍@PostConstruct 的原理、使用场景及最佳实践,感兴趣的朋友一起看看吧
    2025-04-04
  • SpringBoot实现websocket服务端及客户端的详细过程

    SpringBoot实现websocket服务端及客户端的详细过程

    文章介绍了WebSocket通信过程、服务端和客户端的实现,以及可能遇到的问题及解决方案,感兴趣的朋友一起看看吧
    2024-12-12
  • Java web Hibernate如何与数据库链接

    Java web Hibernate如何与数据库链接

    这篇文章主要介绍了Java web Hibernate如何与数据库链接,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • Java gbk转utf-8

    Java gbk转utf-8

    本文主要介绍了Java gbk转utf-8的方法,具有一定的参考价值,下面跟着小编一起来看下吧
    2017-02-02

最新评论