在 Hibernate Envers 中将附加数据传递给 Custom RevisionEntity 的方法？

Posted 2023-03-26

【中文标题】在 Hibernate Envers 中将附加数据传递给 Custom RevisionEntity 的方法？

【英文标题】：Ways to pass additional data to Custom RevisionEntity in Hibernate Envers?

【发布时间】：2016-10-15 09:20:54

【问题描述】：

它是 RESTful 网络应用程序。我正在使用 Hibernate Envers 来存储历史数据。除了修订号和时间戳，我还需要存储其他详细信息（例如：IP 地址和经过身份验证的用户）。 Envers 提供了多种方式来拥有一个很棒的自定义修订实体。我在修订实体上设置自定义数据时遇到问题。

@RevisionEntity( MyCustomRevisionListener.class )
public class MyCustomRevisionEntity extends DefaultRevisionEntity 
    private String userName;

    private String ip;

    //Accessors


public class MyCustomRevisionListener implements RevisionListener 
    public void newRevision( Object revisionEntity ) 
        MyCustomRevisionEntity customRevisionEntity = ( MyCustomRevisionEntity ) revisionEntity;
        //Here I need userName and Ip address passed as arguments somehow, so that I can set them on the revision entity. 
    

由于 newRevision() 方法不允许任何附加参数，我无法将自定义数据（如用户名和 ip）传递给它。我该怎么做？

Envers 还提供了另一种方法：

使用 org.hibernate.envers.RevisionListener 的另一种方法是调用 org.hibernate.envers.AuditReader 接口的 getCurrentRevision(Class revisionEntityClass, boolean persist) 方法来获取当前修订，并用想要的信息。

所以使用上述方法，我将不得不做这样的事情：

更改我当前的 dao 方法，例如：

public void persist(SomeEntity entity) 
     ...
     entityManager.persist(entity);
     ...

到

public void persist(SomeEntity entity, String userName, String ip) 
     ...
     //Do the intended work
     entityManager.persist(entity);
     //Do the additional work
     AuditReader reader = AuditReaderFactory.get(entityManager)
     MyCustomRevisionEntity revision = reader.getCurrentRevision(MyCustomRevisionEntity, false);
     revision.setUserName(userName);
     revision.setIp(ip);

我对这种方法不太满意，因为保留审计数据对我来说似乎是一个跨领域的问题。而我通过HTTP请求对象获取了userName和Ip等数据。因此，所有这些数据都需要从应用程序（控制器）的入口点向下流动到最低层（dao 层）。

还有其他方法可以实现吗？我正在使用弹簧。

我想像 Spring 这样的东西来保存有关特定方法调用所属的“堆栈”的信息。这样当newRevision() 被调用时，我就知道入口点的哪个特定调用导致了这个调用。而且，我可以以某种方式获取传递给调用堆栈的第一个方法的参数。

【参考方案1】：

这样做的一个好方法是利用ThreadLocal 变量。

例如，Spring Security 有一个过滤器，它初始化存储在SecurityContextHolder 中的线程局部变量，然后您可以通过执行以下操作从该特定线程访问这些数据：

SecurityContext ctx = SecurityContextHolder.getSecurityContext();
Authorization authorization = ctx.getAuthorization();

因此，想象一下您的 Web 框架调用的附加拦截器，它可以将附加信息添加到 Spring Security 上下文中，如果使用 Spring Security，可能在自定义用户详细信息对象中，或者创建您自己的持有者和上下文对象来保存侦听器所需的信息.

那么就变得很简单了：

public class MyRevisionEntityListener implements RevisionListener 
  @Override
  public void newRevision(Object revisionEntity) 
    // If you use spring security, you could use SpringSecurityContextHolder.
    final UserContext userContext = UserContextHolder.getUserContext();
    MyRevisionEntity mre = MyRevisionEntity.class.cast( revisionEntity );
    mre.setIpAddress( userContext.getIpAddress() );
    mre.setUserName( userContext.getUserName() );
   

这对我来说是最干净的方法。

值得注意的是，其他 API getCurrentRevision(Session,boolean) 在 Hibernate 5.2 中已被弃用，并计划在 6.0 中删除。虽然可能会引入另一种方法，但执行此类逻辑的预期方法是使用RevisionListener。

【讨论】：

太好了，谢谢！我会尝试实现它并发布更新。

ThreadLocal 是处理这种情况的好方法，这是我通常使用的。