https://github.com/philkes/spring-cache-refresh-annotation
@CacheableAutoRefreshed to combine Spring's @Cacheable and @Scheduled to automatically refresh cashes
https://github.com/philkes/spring-cache-refresh-annotation
caffeine spring-boot spring-cache spring-scheduling
Last synced: 2 months ago
JSON representation
@CacheableAutoRefreshed to combine Spring's @Cacheable and @Scheduled to automatically refresh cashes
- Host: GitHub
- URL: https://github.com/philkes/spring-cache-refresh-annotation
- Owner: PhilKes
- License: apache-2.0
- Created: 2023-09-30T08:31:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-07T11:11:17.000Z (over 1 year ago)
- Last Synced: 2025-02-01T04:31:48.160Z (4 months ago)
- Topics: caffeine, spring-boot, spring-cache, spring-scheduling
- Homepage:
- Size: 97.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spring Cache-refresh Annotation
[](https://maven-badges.herokuapp.com/maven-central/io.github.philkes/spring-cache-refresh-annotation)
[](./LICENSE)
This Spring library provides the [CacheableAutoRefreshed](./src/main/java/io/github/philkes/spring/cache/annotation/CacheableAutoRefreshed.java) annotation which extends the functionality of Spring's [Cacheable](https://www.baeldung.com/spring-cache-tutorial#1-cacheable) annotation, to automatically refresh the cache at a specified point/interval in time.
## Usage
1. Scheduling has to be enabled (see [Enable Support for Scheduling](https://www.baeldung.com/spring-scheduled-tasks#enable-support-for-scheduling))
2. Caching has to be enabled (see [Enable Caching](https://www.baeldung.com/spring-cache-tutorial#enable-caching))
3. Add the dependency to your `pom.xml`:
```xml
io.github.philkes
spring-cache-refresh-annotation
1.0.0
```
_Note: The needed Spring Beans are autoconfigured by [CacheableAutoRefreshedConfiguration](./src/main/java/io/github/philkes/spring/cache/CacheableAutoRefreshedConfiguration.java)_
4. Annotate a method with the `@CacheableAutoRefreshed` annotation (see e.g. [TestBean](./src/test/java/io/github/philkes/spring/cache/annotation/TestBean.java)):
```java
@CacheableAutoRefreshed(cacheNames = "someCache", fixedDelay = 10000)
public String fetchSomeData(String parameter) {
return someService.fetchData(parameter);
}
```
In this example `fetchSomeData` return values will be cached with the default behaviour of `@Cacheable` and the cached values will be refreshed every 10 seconds.
The cache stays stable even while refreshing.
## Supported Caches
* Spring's [Simple Caching](https://docs.spring.io/spring-boot/docs/current/reference/html/io.html#io.caching.provider.simple) with `ConcurrentHashMap` (synchronously reloads all cached entries)
* [Caffeine](https://docs.spring.io/spring-boot/docs/current/reference/html/io.html#io.caching.provider.caffeine) (utilizes the async reloading of all cache entries via [LoadingCache.refreshAll()](https://javadoc.io/doc/com.github.ben-manes.caffeine/caffeine/latest/com.github.benmanes.caffeine/com/github/benmanes/caffeine/cache/LoadingCache.html))
* TODO: Redis
* TODO: JCache
### Configuration
To configure the caching itself, the `@CacheableAutoRefresh` provides the same annotation parameters as `@Cacheable` (see [Spring/Cacheable](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/cache/annotation/Cacheable.html)) as well as all the parameters from the `@Scheduled` annotation (see [Spring/Scheduled](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/scheduling/annotation/Scheduled.html)), to specify when the cache should be refreshed (e.g. via a duration interval, cron expression)
## Dependencies
- Built with Java 17
- [Spring-Framework](https://docs.spring.io/spring-framework/reference/overview.html) for `spring-context`, `spring-boot-autoconfigure`
- [Mockito](https://site.mockito.org/) for mocking tests
- [Awaitility](https://github.com/awaitility/awaitility) for testing spring scheduled tasks
This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.txt).