hibernate3与ehcache-2.8.3配合使用，在多个SessionFactory实例的情况下出现“Another unnamed CacheManager already ex

Posted 2020-06-18

不想看分析过程的，直接拉到最下面看第4部分

1. 问题背景

由于某些原因，项目中使用了hibernate3与ehcache-2.8.3在配合使用，又由于某些原因，需要使用多个SessionFactory实例。在这个背景下，启动项目报错，具体异常如下：

Caused by: net.sf.ehcache.CacheException: Another unnamed CacheManager already exists in the same VM. Please provide unique names for each CacheManager in the config or do one of following:
1. Use one of the CacheManager.create() static factory methods to reuse same CacheManager with same name or create one if necessary
2. Shutdown the earlier cacheManager before creating new one with same name.
The source of the existing CacheManager is: DefaultConfigurationSource [ ehcache.xml or ehcache-failsafe.xml ]
    at net.sf.ehcache.CacheManager.assertNoCacheManagerExistsWithSameName(CacheManager.java:591)
    at net.sf.ehcache.CacheManager.init(CacheManager.java:385)
    at net.sf.ehcache.CacheManager.<init>(CacheManager.java:369)
    at org.hibernate.cache.EhCacheProvider.start(EhCacheProvider.java:124)
    at org.hibernate.impl.SessionFactoryImpl.<init>(SessionFactoryImpl.java:183)
    at org.hibernate.cfg.Configuration.buildSessionFactory(Configuration.java:1294)
    at org.springframework.orm.hibernate3.LocalSessionFactoryBean.newSessionFactory(LocalSessionFactoryBean.java:860)

大意就是同一个vm中有两个未命名的CacheManager存。具体代码细节可以根据上面的报错堆栈很容易发现：

private void assertNoCacheManagerExistsWithSameName(Configuration configuration) {
        synchronized (CacheManager.class) {
            final String name;
            final boolean isNamed;
            if (configuration.getName() != null) {
                name = configuration.getName();
                isNamed = true;
            } else {
                name = DEFAULT_NAME;
                isNamed = false;
            }
            CacheManager cacheManager = CACHE_MANAGERS_MAP.get(name);
            if (cacheManager == null) {
                CACHE_MANAGERS_MAP.put(name, this);
                CACHE_MANAGERS_REVERSE_MAP.put(this, name);
            } else {
                ConfigurationSource configurationSource = cacheManager.getConfiguration().getConfigurationSource();
                final String msg = "Another "
                        + (isNamed ? "CacheManager with same name ‘" + name + "‘" : "unnamed CacheManager")
                        + " already exists in the same VM. Please provide unique names for each CacheManager in the config or do one of following:\n"
                        + "1. Use one of the CacheManager.create() static factory methods to reuse same CacheManager with same name"
                        + " or create one if necessary\n"
                        + "2. Shutdown the earlier cacheManager before creating new one with same name.\n"
                        + "The source of the existing CacheManager is: "
                        + (configurationSource == null ? "[Programmatically configured]" : configurationSource);
                throw new CacheException(msg);
            }
        }
    }

2. 通过hibernate的配置项”hibernate.cache.provider_configuration_file_resource_path”单独指定SessionFactory每个实例的ehcache配置文件

hibernate与ehcahe对接的地方能发现些什么？

观察堆栈：

at org.hibernate.cache.EhCacheProvider.start(EhCacheProvider.java:124)
    at org.hibernate.impl.SessionFactoryImpl.<init>(SessionFactoryImpl.java:183)

发先如下代码：

String configurationResourceName = null;
            if (properties != null) {
                configurationResourceName = (String) properties.get( Environment.CACHE_PROVIDER_CONFIG );
            }
            if ( StringHelper.isEmpty( configurationResourceName ) ) {
                manager = new CacheManager();
            } else {
                URL url = loadResource(configurationResourceName);
                manager = new CacheManager(url);
            }

这里有重要的一个发现：

初始化SessionFactory实例时启动EhCacheProvider

启动EhCacheProvider时创建CacheManager实例，

创建CacheManager实例时可以通过hibernate的配置项hibernate.cache.provider_configuration_file_resource_path来决定CacheManager的配置

hibernate.cache.provider_configuration_file_resource_path这个配置项的值是什么形式？

分析org.hibernate.util.ConfigHelper.locateConfig(String)代码：

public static final URL locateConfig(final String path) {
        try {
            return new URL(path);
        }
        catch(MalformedURLException e) {
            return findAsResource(path);
        }
    }

不难发现：

1).优先用标准的url形式查找。

2).失败后用classpath的方式查找。

3. 如何在ehcache的xml配置文件中指定CacheManager实例的名字

分析1中的assertNoCacheManagerExistsWithSameName代码发现cacheManager的name是从net.sf.ehcache.config.Configuration获取的。

net.sf.ehcache.config.Configuration实例又是依赖SAX解析配置文件xml实现的。

SAX解析需要配合handler使用，这里是net.sf.ehcache.config.BeanHandler这个类。

调试BeanHandler后发现，Configuration实例的cacheManagerName就是配置文件中ehcache xml配置文件中ehcache标签的name属性的值。

<ehcache name="jbpmEhcacheManager">

4. 总结解决办法：

1). 在classpath下放置多个ehcachexxx.xml配置文件(有多少个SessionFactory实例就放置多少个，文件名不同)，每个配置文件中ehcache标签的name属性值要唯一。

2). 在每个SessionFactory实例装配时(如果编程式的就用api指定)，指定hibernate.cache.provider_configuration_file_resource_path的值为相应的ehcache配置名

<prop key="hibernate.cache.provider_class">
                    org.hibernate.cache.EhCacheProvider
                </prop>
                
                <!-- hibernate3 配合ehcache2.5之后的版本使用,对于多个SessionFactory实例,需要为每个SessionFactory实例指定独立的ehcache的配置文件 -->
                <!-- hibernate3对这一配置项的路径寻找方式为：1.优先用标准的url形式查找。2.失败后用classpath的方式查找。此处使用2方式。 -->
                <prop key="hibernate.cache.provider_configuration_file_resource_path">ehcache4common.xml</prop>

--EOF--