spring data jpa bug分析—初始化时EntityManager不关闭原因

环境

spring 3.2.3 RELEASE

spring data jpa 1.3.1.RELEASE

hibernate core  4.2.2.Final

 

问题

周末没事想把hibernate二级缓存监控集成到应用中，之前hibernate3.6的时候集成过（之前没用spring data jpa，所以怀疑是它的问题），不过为了和现有风格的统一，重新写了一遍，在写的过程中遇到一个问题：

hibernate Session打开的次数 比 Session关闭的次数 多很多次。而且这个比例是固定的，打开以前的hibernate3.6的发现没什么问题。打开和关闭次数是相等的才对。

 

经过源码跟踪，发现是spring data jpa，打开hibernate会话后没有关闭造成的。原因是spring data jpa在生成接口的QL时，需要去验证QL是否正确，此时它创建了Query但没有执行也没有释放造成的。

这是一个bug。已提交：https://jira.springsource.org/browse/DATAJPA-350

 

分析：

1、用过spring data jpa的朋友都应该知道，我们只需要写一些约定的接口并声称QL，或者在接口上使用如@Query指定QL，它能自动创建实现类并帮我们执行QL。此处不分析具体的步骤了。

2、在找到这些接口和@Qeury后，spring data jpa会验证这些QL是否正确。

3、最简单的是是使用SimpleQuery

org.springframework.data.jpa.repository.query.SimpleJpaQuery：

 

SimpleJpaQuery(JpaQueryMethod method, EntityManager em, String queryString) {
……

        // Try to create a Query object already to fail fast
        if (!method.isNativeQuery()) {
            try {
                em.createQuery(query.getQuery());
            } catch (RuntimeException e) {
                // Needed as there's ambiguities in how an invalid query string shall be expressed by the persistence provider
                // http://java.net/projects/jpa-spec/lists/jsr338-experts/archive/2012-07/message/17
                throw e instanceof IllegalArgumentException ? e : new IllegalArgumentException(e);
            }
        }
……
}

 大家已经注意到了，em.createQuery(query.getQuery()); 创建了Query 但没有执行，也没有关闭它。

 

 

4、因为我们spring data jpa 和spring集成了，所以注入的EntityManager是通过：

org.springframework.orm.jpa.SharedEntityManagerCreator创建的EntityManager代理对象；具体去参考源码；

5、当我们执行创建Query时：

 

// Regular EntityManager operations.
			boolean isNewEm = false;
			if (target == null) {
				logger.debug("Creating new EntityManager for shared EntityManager invocation");
				target = (!CollectionUtils.isEmpty(this.properties) ?
						this.targetFactory.createEntityManager(this.properties) :
						this.targetFactory.createEntityManager());
				isNewEm = true;
			}

			// Invoke method on current EntityManager.
			try {
				Object result = method.invoke(target, args);
				if (result instanceof Query) {
					Query query = (Query) result;
					if (isNewEm) {
						Class[] ifcs = ClassUtils.getAllInterfacesForClass(query.getClass(), this.proxyClassLoader);
						result = Proxy.newProxyInstance(this.proxyClassLoader, ifcs,
								new DeferredQueryInvocationHandler(query, target));
						isNewEm = false;
					}
					else {
						EntityManagerFactoryUtils.applyTransactionTimeout(query, this.targetFactory);
					}
				}
				return result;
			}
			catch (InvocationTargetException ex) {
				throw ex.getTargetException();
			}
			finally {
				if (isNewEm) {
					EntityManagerFactoryUtils.closeEntityManager(target);
				}
			}

 

此时大家注意到了，如果创建的是Query，isNewEm=false；而且Query也被代理了，那么finally不会关闭；

6、Query会执行完毕后执行关闭：

 

if (method.getName().equals("getResultList") || method.getName().equals("getSingleResult") ||
						method.getName().equals("executeUpdate")) {
					EntityManagerFactoryUtils.closeEntityManager(this.em);
				}

 

7、问题就出在这，我们第【3】步创建了Query但没有执行，造成Session一直不释放，所以造成二级缓存查到的关闭的Session数量比打开的少很多。

 

解决方案：

自己获取EntityManager执行并关闭，这样就不会有问题了。

 

        EntityManager target = null;
        // Try to create a Query object already to fail fast
        if (!method.isNativeQuery()) {
            try {
                target = em.getEntityManagerFactory().createEntityManager();
                target.createQuery(query.getQuery());
            } catch (RuntimeException e) {
                // Needed as there's ambiguities in how an invalid query string shall be expressed by the persistence provider
                // http://java.net/projects/jpa-spec/lists/jsr338-experts/archive/2012-07/message/17
                throw e instanceof IllegalArgumentException ? e : new IllegalArgumentException(e);
            } finally {
                EntityManagerFactoryUtils.closeEntityManager(target);
            }

 

看了一下spring data jpa 1.4版本，没有修复，下午提交下bug。 

 

 

另外使用hibernate 4做二级缓存监控的注意了：

 

hibernate4没有记录close Statement，即查看二级缓存的close Statement永远是0。也是个bug。

https://hibernate.atlassian.net/browse/HHH-8287