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

更新时间：2023年10月18日 10:54:02 作者：QiHY

通过spring-data-envers可以很容易的实现数据变动纪录的保存和查询,本文介绍支持有条件变动纪录的保存和查询的方法,通过spring-data-envers很容易的实现变动纪录的保存和查询,只需要增加几个注解就可以,感兴趣的朋友跟随小编一起看看吧

一、概述

可以通过 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
    @GeneratedValue
    private 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);
    }
    @Override
    public 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);
    }
    @Override
    public 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 {
    @Override
    public 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)
            );
        }
    }
    @Override
    public 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支持有条件变动纪录的保存和查询的方法的文章就介绍到这了,更多相关Spring Data Envers内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java日常练习题,每天进步一点点(18)
下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧，希望可以帮到你
2021-07-07
Java设计模式之迪米特原则精解
设计模式（Design pattern）代表了最佳的实践，通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。本篇介绍设计模式七大原则之一的迪米特原则
2022-02-02
几种JAVA细粒度锁的实现方式
这篇文章主要为大家详细介绍了几种JAVA细粒度锁的实现方式，感兴趣的小伙伴们可以参考一下
2016-05-05
java+MongoDB实现存图片、下载图片的方法示例
这篇文章主要介绍了java+MongoDB实现存图片、下载图片的方法,结合实例形式详细分析了java结合MongoDB实现图片的存储与下载相关操作技巧,需要的朋友可以参考下
2019-09-09
详细总结IDEA中打jar包的两种方式
发现有很多小伙伴都不会用IDEA打jar包,今天给大家详细总结了两种IDEA打jar包的方式,对正在学习IDEA使用的小伙伴很有帮助,需要的朋友可以参考下
2021-05-05
SSH框架网上商城项目第12战之添加和更新商品功能
这篇文章主要介绍了SSH框架网上商城项目第12战之添加和更新商品功能的实现代码，感兴趣的小伙伴们可以参考一下
2016-06-06
SpringCloud实现服务调用feign与熔断hystrix和网关gateway详细分析
这篇文章主要介绍了SpringCloud实现服务调用feign与熔断hystrix和网关gateway，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
2023-04-04
java分治思想之ForkJoin详解
这篇文章主要为大家介绍了java分治思想之ForkJoin使用详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
Java获得一个数组的指定长度排列组合算法示例
这篇文章主要介绍了Java获得一个数组的指定长度排列组合算法,结合实例形式分析了java排列组合相关数组遍历、运算操作技巧,需要的朋友可以参考下
2019-06-06
Java Excel透视表相关操作实现代码
这篇文章主要介绍了Java Excel透视表相关操作实现代码,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-08-08