Skip to content

io microsphere spring cache annotation TTLCachePut

github-actions[bot] edited this page Jul 11, 2026 · 25 revisions

TTLCachePut

Type: Annotation | Module: microsphere-spring-context | Package: io.microsphere.spring.cache.annotation | Since: 1.0.0

Source: microsphere-spring-context/src/main/java/io/microsphere/spring/cache/annotation/TTLCachePut.java

Overview

A variant of CachePut that supports time-to-live (TTL) settings for cache entries.

This annotation can be used on types and methods to indicate that the result of invoking a method should be cached with a specific time-to-live duration. Unlike the standard CachePut, this annotation allows specifying an expiration time after which the cached value will be automatically invalidated.

Example Usage

{@code

### Declaration

```java
public @interface TTLCachePut
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.36-SNAPSHOT`

## Version Compatibility

This component is tested and compatible with the following Java versions:

| Java Version | Status |
|:---:|:---:|
| Java 17 | ✅ Compatible |
| Java 21 | ✅ Compatible |
| Java 25 | ✅ Compatible |

## Examples

```java
@TTLCachePut(cacheNames = "userCache", expire = 10, timeUnit = TimeUnit.SECONDS)
public User getUser(String id) {
    return findUserById(id);
}
```

## Usage

### Maven Dependency

Add the following dependency to your `pom.xml`:

```xml

    io.github.microsphere-projects
    microsphere-spring-context
    ${microsphere-spring.version}

```

> **Tip:** Use the BOM (`microsphere-spring-dependencies`) for consistent version management. See the [Getting Started](https://github.com/microsphere-projects/microsphere-spring#getting-started) guide.

### Import

```java
import io.microsphere.spring.cache.annotation.TTLCachePut;
```

---

*This documentation was auto-generated from the source code of [microsphere-spring](https://github.com/microsphere-projects/microsphere-spring).*

Home

spring-context

spring-guice

spring-jdbc

spring-test

spring-web

spring-webflux

spring-webmvc

Clone this wiki locally