io microsphere spring cache annotation TTLCacheable

TTLCacheable

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/TTLCacheable.java

Overview

A variation of Cacheable @Cacheable that supports Time-To-Live (TTL) settings for cached entries.

This annotation allows the specification of an expiration time for cache entries, making it possible to control how long values should be kept in the cache before being considered stale and evicted.

Example Usage

{@code

### Declaration

```java
public @interface TTLCacheable
```

**Author:** Mercy

## Version Information

- **Introduced in:** `1.0.0`
- **Current Project Version:** `0.2.27-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
@TTLCacheable(cacheNames = "userCache", expire = 10, timeUnit = TimeUnit.SECONDS)
    public User getUser(String userId) {
        // Method implementation
    }
```

## 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.TTLCacheable;
```

---

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