如何拦截JTA事务事件并获取对与事务关联的当前EntityManager的引用

Question

简而言之：我们开发和维护一个可以在其他项目中使用JavaEE7 / CDI / JPA的库。 应用程序将在Glassfish-4.0下运行，并使用Hibernate的JPA实现来实现底层PostgreSQL持久性。 这是将Spring / Struts / Hibernate中编写的旧应用程序重写为JavaEE7 / CDI / JTA新世界的长期迁移工作的一部分。

问题：出于审计目的，我们的库需要拦截所有数据库事务，并在执行用户语句之前包含自定义SQL语句。 此时，需要将当前用户名和IP地址插入临时数据库变量（供应商特定功能），以便数据库触发器可以读取它们以创建任何行修改的审计跟踪。 这篇特别的帖子对提供替代方案非常有帮助 ，而且我们的团队因先前建立的遗产而走上了触发之路。

但是：我们对 JTA如何处理交易事件深感失望。 有许多方法可以拦截交易，但这种特殊情况似乎是不可能的。 在旧架构中，使用Spring的事务管理器，我们只使用了一个实现Interceptor.afterTransactionBegin（...）的Hibernate Interceptor 。 阅读官方JTA-1.2规范 ，我们发现它确实支持Synchronization.beforeCompletion和Synchronization.afterCompletion 。 经过几个小时的调试会议后，我们清楚地注意到Hibernate的JTA实现正在使用这些工具。 但是JTA似乎缺少像beforeBegin和afterBegin （IMHO似乎缺乏常识）之类的事件。 由于没有设施拦截这些设施，Hibernate完全符合JTA，它根本不会。 期。

无论我们做什么，我们都找不到办法。 例如，我们尝试拦截@Transactional注释并在容器的JTA impl完成其工作以打开事务之后运行我们的代码。 但是我们缺乏动态获取与该特定事务关联的EntityManager的能力。 请记住：这是一个库，而不是Web应用程序本身。 它不能对应用程序声明和使用哪些持久性单元做出任何假设。 而且，据我们所知，我们需要知道将哪个特定的持久单元名称注入到我们的代码中。 我们正在努力为其他temas提供尽可能透明的审计工具。

所以我们谦卑地寻求帮助。 如果有人有解决方案，解决方法，无论什么意见，我们都会很高兴听到它。

Answer 1

我自己在这篇文章中很快回答了这个问题，但是我们花了两周时间尝试不同的策略来克服这个问题。 所以，这是我们决定使用的最终实现。

基本思想：通过扩展Hibernate给出的一个来创建自己的javax.persistence.spi.PersistenceProvider实现。 对于所有效果，这是您的代码与Hibernate或任何其他供应商特定实现相关联的唯一点。

public class MyHibernatePersistenceProvider extends org.hibernate.jpa.HibernatePersistenceProvider {

    @Override
    public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info, Map properties) {
        return new EntityManagerFactoryWrapper(super.createContainerEntityManagerFactory(info, properties));
    }

}

我们的想法是使用您自己的实现来包装hibernate的EntityManagerFactory和EntityManager版本。 因此，您需要创建实现这些接口的类，并将供应商特定的实现保留在其中。

这是EntityManagerFactoryWrapper

public class EntityManagerFactoryWrapper implements EntityManagerFactory {

    private EntityManagerFactory emf;

    public EntityManagerFactoryWrapper(EntityManagerFactory originalEMF) {
        emf = originalEMF;
    }

    public EntityManager createEntityManager() {
        return new EntityManagerWrapper(emf.createEntityManager());
    }

    // Implement all other methods for the interface
    // providing a callback to the original emf.

EntityManagerWrapper是我们的拦截点。 您需要从界面实现所有方法。 在可以修改实体的每个方法中，我们都包含对自定义查询的调用，以在数据库中设置局部变量。

public class EntityManagerWrapper implements EntityManager {

    private EntityManager em;
    private Principal principal;

    public EntityManagerWrapper(EntityManager originalEM) {
        em = originalEM;
    }

    public void setAuditVariables() {
        String userid = getUserId();
        String ipaddr = getUserAddr();
        String sql = "SET LOCAL application.userid='"+userid+"'; SET LOCAL application.ipaddr='"+ipaddr+"'";
        em.createNativeQuery(sql).executeUpdate();
    }

    protected String getUserAddr() {
        HttpServletRequest httprequest = CDIBeanUtils.getBean(HttpServletRequest.class);
        String ipaddr = "";
        if ( httprequest != null ) {
            ipaddr = httprequest.getRemoteAddr();
        }
        return ipaddr;
    }

    protected String getUserId() {
        String userid = "";
        // Try to look up a contextual reference
        if ( principal == null ) {
            principal = CDIBeanUtils.getBean(Principal.class);
        }

        // Try to assert it from CAS authentication
        if (principal == null || "anonymous".equalsIgnoreCase(principal.getName())) {
            if (AssertionHolder.getAssertion() != null) {
                principal = AssertionHolder.getAssertion().getPrincipal();
            }
        }
        if ( principal != null ) {
            userid = principal.getName();
        }
        return userid;
    }

    @Override
    public void persist(Object entity) {
        if ( em.isJoinedToTransaction() ) {
            setAuditVariables();
        }
        em.persist(entity);
    }

    @Override
    public <T> T merge(T entity) {
        if ( em.isJoinedToTransaction() ) {
            setAuditVariables();
        }
        return em.merge(entity);
    }

    @Override
    public void remove(Object entity) {
        if ( em.isJoinedToTransaction() ) {
            setAuditVariables();
        }
        em.remove(entity);
    }

    // Keep implementing all methods that can change
    // entities so you can setAuditVariables() before
    // the changes are applied.
    @Override
    public void createNamedQuery(.....

缺点：拦截查询（SET LOCAL）可能会在单个事务中运行多次，特别是如果在单个服务调用上有多个语句。 鉴于这种情况，我们决定保持这种方式，因为它是一个简单的SET LOCAL内存调用PostgreSQL。 由于没有涉及表，我们可以忍受性能损失。

现在只需在persistence.xml中替换Hibernate的持久性提供程序：

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://xmlns.jcp.org/xml/ns/persistence"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_1.xsd"
             version="2.1">
<persistence-unit name="petstore" transaction-type="JTA">
        <provider>my.package.HibernatePersistenceProvider</provider>
        <jta-data-source>java:app/jdbc/exemplo</jta-data-source>
        <properties>
            <property name="hibernate.transaction.jta.platform" value="org.hibernate.service.jta.platform.internal.SunOneJtaPlatform" />
            <property name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect"/>
        </properties>
</persistence-unit>

作为旁注，这是CDIBeanUtils，我们必须在某些特殊场合帮助bean管理器。 在这种情况下，我们使用它来查找对HttpServletRequest和Principal的引用。

public class CDIBeanUtils {

    public static <T> T getBean(Class<T> beanClass) {

        BeanManager bm = CDI.current().getBeanManager();

        Iterator<Bean<?>> ite = bm.getBeans(beanClass).iterator();
        if (!ite.hasNext()) {
            return null;
        }
        final Bean<T> bean = (Bean<T>) ite.next();
        final CreationalContext<T> ctx = bm.createCreationalContext(bean);
        final T t = (T) bm.getReference(bean, beanClass, ctx);
        return t;
    }

}

公平地说，这并不是完全拦截交易事件。 但是我们能够在事务中包含我们需要的自定义查询。

希望这可以帮助其他人避免我们经历的痛苦。