Spring Data Envers 支持有条件变动纪录的保存和查询

2023-10-15 15:15
文章标签 java 条件 保存 查询 spring 支持 data 变动 纪录 envers

本文主要是介绍Spring Data Envers 支持有条件变动纪录的保存和查询，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

数据审计是业务系统的一个基本能力，需要系统能够将关键数据的变动纪录都保存下来，并支持变动纪录的查询。

通过spring-data-envers可以很容易的实现数据变动纪录的保存和查询。

有些情况下，我们需要只保存满足特定条件的数据变动纪录，不满足条件的变动纪录不进行保存，例如只保存某个字段有值的变动纪录。

本文介绍支持有条件变动纪录的保存和查询的方法。

具体的代码参照 示例项目 https://github.com/qihaiyan/springcamp/tree/master/spring-data-envers-conditional

一、概述

可以通过 spring-data-envers 很容易的实现变动纪录的保存和查询，只需要增加几个注解就可以。但是要实现有条件的变动纪录的保存和查询就需要进行一些复杂的处理。

二、使用 spring-data-envers

首先引入 spring-data-envers 依赖。

在 build.gradle 中增加一行代码:

implementation 'org.springframework.data:spring-data-envers'

在实体类上增加 Audited 注解：

@Data
@Entity
@Audited
public class MyData {@Id@GeneratedValueprivate Long id;private String author;
}

Repository 扩展 RevisionRepository 方法：

public interface MyDataRepository extends JpaRepository<MyData, Long>, RevisionRepository<MyData, Long, Integer> {
}

通过以上3步操作，就添加好了变动纪录的保存功能，我们可以通过调用变动纪录查询方法确认变动纪录保存成功。

当 Repository 扩展 RevisionRepository 方法后，会有一个默认实现的 findRevisions 方法，我们可以直接调用：

public Revisions<Integer, MyData> findRevisions(Long id) {return myDataRepository.findRevisions(id);
}

最后我们可以执行完整的主体数据的保存，在控制台中打印变动纪录：

@Override
public void run(String... args) {MyData myData = new MyData();myData.setId(1L);myData.setAuthor("test");dbService.saveData(myData);dbService.findRevisions(myData.getId()).forEach(r -> System.out.println("revision: " + r.toString()));myData.setAuthor("newAuthor");dbService.saveData(myData);dbService.findRevisions(myData.getId()).forEach(r -> System.out.println("revision: " + r.toString()));
}

执行完程序后，可以看到两次保存数据的操作都可以查询到对应的变动纪录，并且变动纪录还通过 revisionType 显示了是插入还是更新操作：

revision: Revision 1 of entity MyData(id=1, author=test) - Revision metadata DefaultRevisionMetadata{entity=DefaultRevisionEntity(id = 1, revisionDate = Oct 15, 2023, 11:41:15 AM), revisionType=INSERT}
revision: Revision 2 of entity MyData(id=1, author=newAuthor) - Revision metadata DefaultRevisionMetadata{entity=DefaultRevisionEntity(id = 2, revisionDate = Oct 15, 2023, 11:41:16 AM), revisionType=UPDATE}

三、通过自定义 Event Listener 实现有条件的变动纪录的保存

在进行数据变动时， Envers 通过监听事件来进行对应的处理，总共有以下几个监听事件：

EventType.POST_INSERT
EventType.PRE_UPDATE
EventType.POST_UPDATE
EventType.POST_DELETE
EventType.POST_COLLECTION_RECREATE
EventType.PRE_COLLECTION_REMOVE
EventType.PRE_COLLECTION_UPDATE

每个监听事件都对应着特定的 Listener ，在本文实例中，我们期望当 author 的值被更新为空时，不保存变动纪录，我们可以通过自定义 PRE_UPDATE 和 POST_UPDATE 的Listener来实现。

因为框架提供了默认的Listener，因此自定义 Listener 只需要扩展默认的Listener，并加入我们自己的特有逻辑就可以。

MyEnversPostUpdateEventListenerImpl ：

public class MyEnversPreUpdateEventListenerImpl extends EnversPreUpdateEventListenerImpl {public MyEnversPreUpdateEventListenerImpl(EnversService enversService) {super(enversService);}@Overridepublic boolean onPreUpdate(PreUpdateEvent event) {if (event.getEntity() instanceof MyData&& ((MyData) event.getEntity()).getAuthor() == null) {return false;}return super.onPreUpdate(event);}}

MyEnversPostUpdateEventListenerImpl:

public class MyEnversPostUpdateEventListenerImpl extends EnversPostUpdateEventListenerImpl {public MyEnversPostUpdateEventListenerImpl(EnversService enversService) {super(enversService);}@Overridepublic void onPostUpdate(PostUpdateEvent event) {if (event.getEntity() instanceof MyData && ((MyData) event.getEntity()).getAuthor() == null) {return;}super.onPostUpdate(event);}
}

在自定义 Listener 中，我们增加了 对于 author 字段是否为空的判断逻辑。

四、自定义 Event Listener 注册到系统中

自定义 Event Listener 完成后，我们还需要让框架执行我们自定义的 Listener， 而不是用默认的 Listener。

框架通过 EnversIntegrator 类注册的 Listener, 我们要做的是重新实现 EnversIntegrator , 在本实例中重新实现的类为 MyEnversIntegrator :

public class MyEnversIntegrator implements Integrator {@Overridepublic void integrate(Metadata metadata,BootstrapContext bootstrapContext,SessionFactoryImplementor sessionFactory) {final ServiceRegistry serviceRegistry = sessionFactory.getServiceRegistry();final EnversService enversService = serviceRegistry.getService(EnversService.class);final EventListenerRegistry listenerRegistry = serviceRegistry.getService(EventListenerRegistry.class);listenerRegistry.addDuplicationStrategy(EnversListenerDuplicationStrategy.INSTANCE);if (enversService.getEntitiesConfigurations().hasAuditedEntities()) {listenerRegistry.appendListeners(EventType.POST_DELETE,new EnversPostDeleteEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.POST_INSERT,new EnversPostInsertEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.PRE_UPDATE,new MyEnversPreUpdateEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.POST_UPDATE,new MyEnversPostUpdateEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.POST_COLLECTION_RECREATE,new EnversPostCollectionRecreateEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.PRE_COLLECTION_REMOVE,new EnversPreCollectionRemoveEventListenerImpl(enversService));listenerRegistry.appendListeners(EventType.PRE_COLLECTION_UPDATE,new EnversPreCollectionUpdateEventListenerImpl(enversService));}}@Overridepublic void disintegrate(SessionFactoryImplementor sessionFactory, SessionFactoryServiceRegistry serviceRegistry) {// nothing to do}
}

通过代码可以发现，我们只是修改了 PRE_UPDATE 和 POST_UPDATE 注册的 Listener , 其它事件的 Listener 仍然用框架默认的。

最后我们需要把我们实现的 MyEnversIntegrator 放到 META-INF/services/org.hibernate.integrator.spi.Integrator 这个配置文件中。

cn.springcamp.springdata.envers.MyEnversIntegrator

五、确认有条件变动纪录的保存是否生效

最后我们修改控制台打印程序，将 author 字段更新为 null 并保存，查看变动纪录里是否有这个更新操作的纪录。

增加保存代码 :

// won't generate audit record when author is null
myData.setAuthor(null);
dbService.saveData(myData);
dbService.findRevisions(myData.getId()).forEach(r -> System.out.println("revision: " + r.toString()));

执行程序并观察控制台打印内容：

revision: Revision 1 of entity MyData(id=1, author=test) - Revision metadata DefaultRevisionMetadata{entity=DefaultRevisionEntity(id = 1, revisionDate = Oct 15, 2023, 11:41:15 AM), revisionType=INSERT}
revision: Revision 2 of entity MyData(id=1, author=newAuthor) - Revision metadata DefaultRevisionMetadata{entity=DefaultRevisionEntity(id = 2, revisionDate = Oct 15, 2023, 11:41:16 AM), revisionType=UPDATE}

通过打印内容可以确认，author 字段更新为 null 的变动纪录没有被纪录，说明我们的处理是生效的。

这篇关于Spring Data Envers 支持有条件变动纪录的保存和查询的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/218338。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Java中Redisson 的原理深度解析

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、
阅读更多...
SpringBoot基于注解实现数据库字段回填的完整方案

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代
阅读更多...
一篇文章彻底搞懂macOS如何决定java环境

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面：本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一：使用 which命令方法二：使用 Java_home工具（Apple 官方推荐）那问题来了，
阅读更多...
Java HashMap的底层实现原理深度解析

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述：HashMap的宏观结构二、核心数据结构解析1. 数组（桶数组）2. 链表节点（Node
阅读更多...
Java AOP面向切面编程的概念和实现方式

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点（如日志、事务）与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么？二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
Java中的.close()举例详解

Java中的.close()举例详解

《Java中的.close()举例详解》.close()方法只适用于通过window.open()打开的弹出窗口,对于浏览器的主窗口,如果没有得到用户允许是不能关闭的,：本文主要介绍Java中的.... 目录当你遇到以下三种情况时，一定要记得使用 .close()：用法作用举例如何判断代码中的 input
阅读更多...
Spring Gateway动态路由实现方案

Spring Gateway动态路由实现方案

《SpringGateway动态路由实现方案》本文主要介绍了SpringGateway动态路由实现方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随... 目录前沿何为路由RouteDefinitionRouteLocator工作流程动态路由实现尾巴前沿S
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2