在 Tomcat 中使用 Spring 通过 JMX 公开 Hibernate（缓存）统计信息

Question

收集 Hibernate/Ehcache 统计信息并在基于 Spring 的设置中通过 JMX 公开它们似乎很容易。互联网上有很多资源可以提供帮助，例如 http://snippets.dzone.com/posts/show/ 11159

然而，所有这些文章都假设人们正在使用某种 Hibernate 会话工厂。我不是 - 我的实体是 JPA 注释的，并且我使用 javax.persistence.EntityManager。 如果我部署到 Java EE 容器，我可能能够通过 JNDI 获取 Hibernate 会话工厂，如下所述 http://internna.blogspot.com/2007/08/hibernate-statistics-in-enterprise-5.html 但我在 Tomcat 上...

该怎么办？我还没有想出解决办法。

如果我有对 Ehcache CacheManager 的引用，我可以尝试如下操作：

<context:mbean-server />
<bean class="net.sf.ehcache.management.ManagementService" init-method="init">
  <constructor-arg ref="..myCacheManager.."/>
  <constructor-arg ref="mbeanServer"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
</bean>

由于缓存管理器是由 Hibernate 创建的（即它不是 Spring bean），因此它不会工作。我尝试替换该引用，

<constructor-arg><bean id="cacheManager" class="net.sf.ehcache.CacheManager" factory-method="getInstance"/></constructor-arg>

希望我能以某种方式捕获正确的实例。也不起作用，因为这实际上会创建一个新的缓存管理器实例。

Answer 1

我最近构建了一个基于 Spring 的 Web 应用程序示例，它非常干净地为最新版本的 Spring、Hibernate 和 Ehcache 启用了 JMX。

它具有基于 EntityManager 的访问和 DAO 访问（包括事务！）的示例。它还展示了如何进行基于注释的注入，以避免必须使用 Spring 的 bean xml 配置。甚至还有一个使用注释的基于 SpringMVC 的示例 servlet。基本上，这是一个基于 Spring 的版本，是一个相当强大的应用程序服务器，运行在任何 servlet 引擎之上。

它还没有记录下来，但我很快就会记录下来。看一下配置文件和源码应该就很清楚了。

这背后的动机是，我厌倦了所有疯狂的博客文章以及 50 种不同的设置方式，并最终制作了一个人们可以使用的简单来源。它位于 github 上，因此您可以随意分叉该项目并用它做任何您想做的事情。

https://github.com/lookfirst/fallback

Answer 2

JPA EntityManager 公开了底层 Hibernate 会话，因此您可以获取其工厂：

   public static Session getHibernateSession(EntityManager entityManager) {
        Session session;
        if (entityManager.getDelegate() instanceof EntityManagerImpl) {
            EntityManagerImpl entityManagerImpl = (EntityManagerImpl) entityManager.getDelegate();
            session = entityManagerImpl.getSession();
        } else {
            session = (Session) entityManager.getDelegate();
        }

        return session;
    }

然后您可以使用此会话来 启用统计，就像我们在RHQ 项目中所做的那样

Answer 3

您实际上可以使用 公开任何 CacheManager Spring 表达式语言。

<bean id="hibernateCacheManagement" class="net.sf.ehcache.management.ManagementService" init-method="init" >
    <constructor-arg value="#{T(net.sf.ehcache.CacheManager).getCacheManager('CACHE_NAME')}"/>
    <constructor-arg><ref bean="mbeanServer"/></constructor-arg>
    <constructor-arg value="true"/>
    <constructor-arg value="true"/>
    <constructor-arg value="true"/>
    <constructor-arg value="true"/>
</bean>

其中 CACHE_NAME 是 ehcache.xml 文件中配置的缓存的名称。

<ehcache name="CACHE_NAME">
    ...
</ehcache>

Answer 4

我最终编写了以下类

HibernateStatisticsJmxRegistration

import javax.management.JMException;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.persistence.EntityManagerFactory;

import org.hibernate.SessionFactory;
import org.hibernate.ejb.HibernateEntityManagerFactory;
import org.hibernate.jmx.StatisticsService;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * Provides code to register Hibernate's statistics bean with a JMX MBean server. Assumes that both
 * the MBeanServer and the EntityManagerFactory are available as Spring-managed beans. Note that
 * while registering this class enables the collection of statistics even if that was previously
 * disabled.
 * <p>
 * May become obsolete once <a href="https://hibernate.onjira.com/browse/HHH-6034">HHH-6034</a> is
 * implemented. Even if not the confusing situation abround the meanwhile deprecated
 * {@link StatisticsService} should be clear then.
 */
@SuppressWarnings({"deprecation", "javadoc" })
public class HibernateStatisticsJmxRegistration {

  @Autowired
  private EntityManagerFactory entityManagerFactory;

  @Autowired
  private MBeanServer mbeanServer;

  private ObjectName objectName;

  private String jmxObjectName = "org.hibernate:name=HibernateStatistics";

  /**
   * Registers the statistics MBean that wraps a Hibernate session factory. The bean is registered
   * under the name provided by {@link HibernateStatisticsJmxRegistration#getJmxObjectName()}.
   *
   * @throws JMException if anything fails..
   * @see HibernateStatisticsJmxRegistration#unregister()
   */
  public void register() throws JMException {
    final SessionFactory sessionFactory = ((HibernateEntityManagerFactory) entityManagerFactory).getSessionFactory();

    objectName = new ObjectName(jmxObjectName);

    final StatisticsService statsMBean = new StatisticsService();
    statsMBean.setSessionFactory(sessionFactory);
    statsMBean.setStatisticsEnabled(true);
    mbeanServer.registerMBean(statsMBean, objectName);
  }

  /**
   * Unregisters the MBean that was registered.
   *
   * @throws JMException if the de-registration fails
   * @see HibernateStatisticsJmxRegistration#register()
   */
  public void unregister() throws JMException {
    mbeanServer.unregisterMBean(objectName);
  }

  /**
   * Override the default JMX object name. Obviously you need to call this method before
   * registration for it to have any effect. The string must comply to the rules described in
   * {@link ObjectName}. Suggested is {@code <domain>:name=<name>}.
   *
   * @param jmxObjectName the name to use during registration
   */
  public void setJmxObjectName(String jmxObjectName) {
    this.jmxObjectName = jmxObjectName;
  }
}

Spring 配置

<!-- Setting up Ehcache manager for various caches (offer facade, images). -->
<bean id="ehCacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
  <property name="configLocation" value="classpath:ehcache.xml" />
</bean>  
<ehcache:annotation-driven cache-manager="ehCacheManager" />

<!-- Exposing cache statistics through JMX. -->
<context:mbean-server />
<bean class="net.sf.ehcache.management.ManagementService" init-method="init">
  <constructor-arg ref="ehCacheManager"/>
  <constructor-arg ref="mbeanServer"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
  <constructor-arg value="true"/>
</bean>    
<bean class="HibernateStatisticsJmxRegistration"
      init-method="register" destroy-method="unregister" />

Answer 5

非常糟糕，但这也有效，其中（猜猜是什么）mbeanServer 是 MBean Server 的 bean 名称，entityManagerFactory 是 EntityManagerFactory 的 bean 名称：

<bean id="managementService-ehcache-hibernate"
    class="net.sf.ehcache.management.ManagementService"
    init-method="init"
    destroy-method="dispose">

    <constructor-arg value="#{T(org.springframework.security.util.FieldUtils).getFieldValue(@entityManagerFactory.cache.unwrap(T(org.hibernate.cache.spi.RegionFactory)),'manager')}"/>
    <constructor-arg ref="mbeanServer"/>
    <constructor-arg index="2" value="true"/>
    <constructor-arg index="3" value="true"/>
    <constructor-arg index="4" value="true"/>
    <constructor-arg index="5" value="true"/>
</bean>

Answer 6

Spring 仅在 JMX 上公开其 bean，但您可以通过 MBeanExporter 以编程方式导出资源。