Java – Disable spring method caching through external property

ehcachejavaspring

I configured spring method caching with ehcache and annotation driven configuration.

I would like however to be able to disable it from a configuration file we use in the application.

My first idea was to call net.sf.ehcache.CacheManager.CacheManager() with no arguments if method caching is disabled. This throws exception:

java.lang.IllegalArgumentException: loadCaches must not return an empty Collection
at org.springframework.util.Assert.notEmpty(Assert.java:268)
at org.springframework.cache.support.AbstractCacheManager.afterPropertiesSet(AbstractCacheManager.java:49)

My second idea was to configure the net.sf.ehcache.CacheManager.CacheManager() with default data so that the cache is not used (maxElementsInMemory 0 etc.). But then the cache is still used, which is not what I want.

There is a property net.sf.ehcache.disabled but I do not want do disable hibernate caching that also uses ehcache.

Q How can I configure everything to have spring method caching but disable it from my external configuration file? I do not want to modify the application-context nor the code to enable/disable method caching. Only the configuration file we use in the application can be modified.

Best Answer

What I was looking for was NoOpCacheManager:

To make it work I switched from xml bean creation to a factory

I did something as follows:

@Bean
public CacheManager cacheManager() {
    final CacheManager cacheManager;        
    if (this.methodCacheManager != null) {
        final EhCacheCacheManager ehCacheCacheManager = new EhCacheCacheManager();
        ehCacheCacheManager.setCacheManager(this.methodCacheManager);
        cacheManager = ehCacheCacheManager;
    } else {
        cacheManager = new NoOpCacheManager();
    }

    return cacheManager;
}

Related Solutions

Spring – Caching with Hibernate + Spring – some Questions

Hibernate supports the following Caches: 1st Level Cache, 2nd Level Cache, Query Cache

Yes.

Spring itself supports the following Caching possibilities: just Method Caching

Spring 3.1 introduces the new caching abstraction based on annotations around methods, yes.

The 1st Level Cache is part of EVERY Hibernate application.

Yes.

The 1st Level Cache is created for EVERY hibernate-session.

Yes, although you can manually clear it at any given moment.

What is saved in the 1st Level Cache? Objects or just the values of their properties? queries and their results?

It's a map of all objects fetched during the life of a session, if you load the same object by id for the second time, it will be loaded from L1.

I found out: the 2nd Level Cache is used ONCE per application. isn't that false? isn't it used ONCE per sessionfactory? and: multiple sessionfactorys = multiple 2nd level caches possible?

You are right, typically there is just one session factory per application (database), hence the shortcut.

what is saved in the 2nd Level Cache: in my opinion just the values belonging to one record, not the objects itself.

The same things as in L1, but they live longer. L2 is typically backed by some industrial-strength cache, while L1 is just a map (it doesn't even have to be thread-safe). It stores full entities, including lazily loaded relationships.

when storing values from one record in 2nd Level Cache, its possible to store related values (from objects connected over a foreign key) with it too?

You do not manage L2 manually, it happens automatically.

when updating the values of one object in the 2nd level cache, its possible to update the values of objects connected with it in the cache too?

See above.

when values of an object are changing, how can I update the 2nd level cache? flush? can I just update a part of the cache or must the whole cache be updated?

See above - Hibernate will figure this out for you. You never interact with L2 directly.

where does the 2nd level cache make sense and where doesnt it?

Measure. In application that read a lot of data by primary key and read-to-write factor is very high, L2 has a significant impact on your performance.

the Cache Mode: does each cache mode provide a different strategy of caching? for example with cache mode "read only" no synchronization of database and cache is ever necessary? do other cache modes provide synchronization? I thought synchronization must be done by the developer himself?

Cache mode helps Hibernate to choose best strategy for caching and invalidating. For instance if cache is read only, Hibernate won't bother invalidating it (or it won't do this that often). But read only cache (read only entity) will of course forbid any updates.

what is the difference between the Query Cache and the 2nd Level Cache? in my opinion: in the Query Cache result sets are saved, but not with their values, just with their ids. when the query is used again and the result set is still "correct", the values belonging to the ids are queried from the 2nd Level Cache.

Exactly, but this is a very broad topic. Especially the result set is still "correct" part.

For the Query Cache a 2nd Level Cache MUST be used?

Yes, without the L2 cache, the query cache has no sense and will slow down the application dramatically.

where does the Query Cache make sense and where doesnt it?

Hard question, typically when you are executing the same query a lot of times and the universe of query parameters is low (for each set of query parameters new query cache is created with all ids of records being the results).

Does Spring provide more Caching possibilities than method caching?

No, Spring is more-or-less just a glue for your own code.

method caching is not linked to hibernate caching.

Spring is not linked to Hibernate, so...

but: for method caching a 2nd level is necessary, like ehcache (which can be used by hibernate too)

L2 is Hibernate concept. If you want to cache methods, you need some underlying cache. Let it be EhCache, never mind. of course it must be thread-safe.

can method caching be used without database queries?

Spring has nothing to do with Hibernate. You may cache computations that have nothing to do with database.

if using ehcache for hibernate as 2nd level cache and ehcache for spring for method caching, can I use the same ehcache-instance? is there a chance that something gets mixed up?

You may use the same CacheManager and cache configuration as Hibernate to ease deployment. As long as cache names do not overlap, they are completely independent, even thought working within the same manager.

when using 1st level cache and 2nd level cache, can they get mixed up? when querying the database, where does the result then come from, the 1st or 2nd level cache? does the 1st level cache work with the 2nd level cache?

They just work, as long as some abstraction does not leak :-). When you query by primary key, first L1 is examined (it is faster), then L2.

anything else that can get mixed up by using the caches I mentioned? :-)

See above, abstractions tend to leak. But the worst problems come when you change the database and Hibernate does not know about it. Also clustering without proper replication will cause you a headache. And the biggest problem - very often incorrect caching actually slows down the application (query cache is the most dangerous here).

Java – How to disable ehcache using an external property in spring

As of Spring 3.1 it is possible to use bean profiles which can read a property from a external property. You could wrap the declared bean inside a beans element:

<beans profile="cache-enabled"> 
  <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean" p:configLocation="classpath:ehcache.xml"/> 
</beans>

And then activate that using an external property as mentioned in this blog post.

Best Answer

Related Solutions

Spring – Caching with Hibernate + Spring – some Questions

Java – How to disable ehcache using an external property in spring

Related Topic