Second-level caching in Hibernate using eh-cache

[ricardobocchi]

Issue description

Hi, I'm trying to configure second-level caching in Hibernate using eh-cache on Grails 7, but any combination I use, whether with eh-cache or jcache, results in a different error. Is there any documentation on how to configure this?

[jdaugherty]

There is a note about hibernate ehcache in the documentation and the required configuration. At a high level, ehcache is moving away from it's specific API to using the JCache API. Ehcache is simply an implementation of the JCache API.

Looking at my local project, here's what I did to enable the cache though:

1. use ehcache & hibernate-jcache:

       runtimeOnly "org.hibernate:hibernate-jcache:5.6.15.Final", {
           exclude group: 'org.hibernate', module: 'hibernate-core'
       }
       api 'org.ehcache:ehcache', {
           capabilities {
               requireCapability('org.ehcache:ehcache-jakarta')
           }
       }
   

Note: earlier versions of spring security required excluding the wrong version of ehcache. The latest versions no longer have this problem

2. be sure to configure cache in hibernate config path:

       hibernate.cache.region.factory_class = 'jcache'
       hibernate.javax.cache.uri = 'classpath://grails-ehcache.xml'
       hibernate.javax.cache.missing_cache_strategy = 'create'
   

3. Note: in my case, we extend the JCacheCacheManager and initialize it as a bean like so:

       grailsCacheManager(MyCacheManager, Caching.cachingProvider.getCacheManager(
                new ClassPathResource("grails-ehcache.xml").getURI(),
                Caching.cachingProvider.defaultClassLoader
            ))
   

[jdaugherty]

My grails-ehcache.xml looks something like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <config xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
            xmlns:jsr107='http://www.ehcache.org/v3/jsr107'
            xmlns='http://www.ehcache.org/v3'
            xsi:schemaLocation="
            http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core-3.1.xsd
            http://www.ehcache.org/v3/jsr107 http://www.ehcache.org/schema/ehcache-107-ext-3.1.xsd">

        <service>
            <jsr107:defaults enable-management="true" enable-statistics="true" default-template="defaultTemplate"/>
        </service>

        <cache-template name="defaultTemplate">
            <expiry>
                <ttl>120</ttl>
            </expiry>
            <heap>1000</heap>
        </cache-template>

        <cache alias="grailsBlocksCache" uses-template="defaultTemplate"/>
        <cache alias="grailsTemplatesCache" uses-template="defaultTemplate"/>
        <!-- other cache configuration -->
    </config>

[ricardobocchi]

It worked using this documentation: https://grails.apache.org/docs/latest/guide/upgrading.html#_12_5_hibernate_ehcache. I couldn't get the jcache version to work; first it gave a conflict error with the artifact org.ehcache:ehcache, and then it gave an error saying that the cache 'jcache' is not a valid cache.

 * What went wrong:

Configuration cache state could not be cached: field `collection` of `org.gradle.internal.serialize.codecs.core.FilteredFileCollectionSpec` bean found in field `classpath` of `org.gradle.process.internal.DefaultJavaExecSpec_Decorated` bean found in field `javaExecSpec` of task `:gym-app:bootRun` of type `org.springframework.boot.gradle.tasks.run.BootRun`: error writing value of type 'org.gradle.api.internal.file.UnionFileCollection'

> Could not resolve all files for configuration ':gym-app:runtimeClasspath'.

   > Could not resolve org.ehcache:ehcache:3.10.9.

     Required by:

         project :gym-app

      > Module 'org.ehcache:ehcache' has been rejected:

           Cannot select module with conflict on capability 'org.ehcache.modules:ehcache-api:3.10.9' also provided by ['org.ehcache:ehcache:3.10.9' (jakartaRuntimeElements), 'org.ehcache:ehcache:3.10.9' (runtimeElements)]

> There are 2 more failures with identical causes. 

and

Could not load requested class : jcache

[jdaugherty]

@ricardobocchi From your error:

         Cannot select module with conflict on capability 'org.ehcache.modules:ehcache-api:3.10.9' also provided by ['org.ehcache:ehcache:3.10.9' (jakartaRuntimeElements), 'org.ehcache:ehcache:3.10.9' (runtimeElements)]

This tells me that the ehcache-api version you are selecting isn't the jakarta version. Hence, the error by Gradle. If you correct your selection (I'm assuming its a transitive dependency) using Jcache should work.