Expiry time @cacheable spring boot

Question

I have implemented a cache and now I want to add an expiry time.

How can I set an expiry time in spring boot with @Cacheable?

This is a code snippet:

@Cacheable(value="forecast",unless="#result == null")

score 36 · Answer 1 · edited Aug 15 '22 at 18:49

36

I use life hacking like this:

@Configuration
@EnableCaching
@EnableScheduling
public class CachingConfig {

  public static final String GAMES = "GAMES";

  @Bean
  public CacheManager cacheManager() {
    ConcurrentMapCacheManager cacheManager = new ConcurrentMapCacheManager(GAMES);
    return cacheManager;
  }

  @CacheEvict(allEntries = true, value = {GAMES})
  @Scheduled(fixedDelay = 10 * 60 * 1000 ,  initialDelay = 500)
  public void reportCacheEvict() {
    System.out.println("Flush Cache " + dateFormat.format(new Date()));
  }

}

edited Aug 15 '22 at 18:49

ℛɑƒæĿᴿᴹᴿ

4,983
4
38
58

answered Jul 08 '16 at 07:55

Atum

1,211
1
12
14

20

Nice but this will evict all entries, old or new ones. – Adrian Sep 09 '19 at 09:01

score 16 · Answer 2 · edited Jan 03 '18 at 08:47

Note that this answer uses ehcache, which is one of supported Spring Boot cache managers, and arguably one of the most popular.

First you need to add to pom.xml:

<!-- Spring Framework Caching Support -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>

In src/main/resources/ehcache.xml:

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>
    <defaultCache eternal="true" maxElementsInMemory="100" overflowToDisk="false" />
    <cache name="forecast" 
           maxElementsInMemory="1000" 
           timeToIdleSeconds="120"
           timeToLiveSeconds="120"
           overflowToDisk="false"
           memoryStoreEvictionPolicy="LRU" />
</ehcache>

Oh yes there is! :) This is the default location for the EHCache configuration. Other caching libraries will presumably expect different locations. — Steve, Jan 15 '15 at 16:39

score 15 · Answer 3 · answered Jan 15 '15 at 16:45

15

From the reference documentation

Directly through your cache provider. The cache abstraction is… well, an abstraction not a cache implementation. The solution you are using might support various data policies and different topologies which other solutions do not (take for example the JDK ConcurrentHashMap) - exposing that in the cache abstraction would be useless simply because there would no backing support. Such functionality should be controlled directly through the backing cache, when configuring it or through its native API.

answered Jan 15 '15 at 16:45

Stephane Nicoll

31,977
9
97
89

1

Thank you. Finally I have added this in my application.yml: spring.resources.cache-period – nole Jan 15 '15 at 16:58
3

Sorry, I don't see the link with your example. Sounds like totally unrelated to me. That property is to configure the cache period of the web resources. – Stephane Nicoll Jan 16 '15 at 09:29

score 10 · Answer 4 · answered Jan 25 '15 at 18:37

You cannot specify expiry time with @cacheable notation, since @cacheable does not provide any such configurable option.

However different caching vendors providing spring caching have provided this feature through their own configurations. For example NCache / TayzGrid allows you to create different cache regions with configurable expiration time.

If you have implemented your own cache, you will need to define a way to specify expiration in you cache provider and will also need to incorporate expiration logic in your solution.

score 9 · Answer 5 · answered Jul 12 '18 at 16:34

9

I use caffeine-caching, with this configuration for a 60 minute expiration:

spring.cache.cache-names=forecast
spring.cache.caffeine.spec=expireAfterWrite=60m

answered Jul 12 '18 at 16:34

slartidan

20,403
15
83
131

If I use caffeine cache.how to fill `hibernate.cache.region.factory_class` in `spring.properties` – 袁文涛 Nov 08 '21 at 10:07
For others finding this answer, note that more information for these settings is in the [Spring Boot Documentation](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#io.caching.provider.caffeine). – Garret Wilson Aug 31 '23 at 17:03

score 4 · Answer 6 · answered Oct 19 '20 at 18:47

4

You can achieve this kind of eviction strategy by making use of @Scheduled annotation. It is possible to schedule with a fixedRate or even with a cron expression.

@Autowired
CacheManager cacheManager;

public void evictAllCaches() {
        cacheManager.getCacheNames().stream()
          .forEach(cacheName -> cacheManager.getCache(cacheName).clear());
}

@Scheduled(fixedRate = 6000)
public void evictAllcachesAtIntervals() {
        evictAllCaches();
}

answered Oct 19 '20 at 18:47

talhature

2,246
1
14
28

1

This should be considered as a workaround as this clears the whole cache (contrary to the notion of expiration which is different for each cached element). – Julien Kronegg Jun 14 '22 at 15:03
@JulienKronegg you can create such schedules for each cache separately. I agree that it muat be not the most convenient way though. – havryliuk Feb 22 '23 at 08:37

score 2 · Answer 7 · answered Jan 01 '22 at 07:08

2

Found this Spring cache: Set expiry time to a cache entry.

It uses the spring-boot-starter-cache dependency and works as expected . You can configure the expiry time for cached objects as well as the max number of cached values.

answered Jan 01 '22 at 07:08

Amritansh

172
2
6

score 1 · Answer 8 · answered Apr 28 '21 at 03:55

1

If you are using Caffeine than you can add the following line in your application.properties file:

spring.cache.caffeine.spec=expireAfterAccess=300s

answered Apr 28 '21 at 03:55

Bu Saeed

1,173
1
16
27

If I use caffeine cache.how to fill `hibernate.cache.region.factory_class` in `spring.properties` – 袁文涛 Nov 08 '21 at 10:07

Expiry time @cacheable spring boot

8 Answers8

Linked