org.springframework.cache.annotation

Annotation Type Cacheable

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface Cacheable

Annotation indicating that a method (or all the methods on a class) can be cached.

Each time a targeted method is invoked, a caching behavior will be applied, checking whether the method has been already executed for the given arguments. A sensible default simply uses the method parameters to compute the key but a SpEL expression can be provided (key()) or a custom KeyGenerator implementation can replace the default one (keyGenerator()).

If no value is found in the cache for the computed key, the method is executed and the returned instance is used as the cache value.

Since:

3.1

Author:

Costin Leau, Phillip Webb, Stephane Nicoll

See Also:

CacheConfig

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	cacheManager The bean name of the custom CacheManager to use to create a default CacheResolver if none is set already.
String	cacheResolver The bean name of the custom CacheResolver to use.
String	condition Spring Expression Language (SpEL) attribute used for conditioning the method caching.
String	key Spring Expression Language (SpEL) attribute for computing the key dynamically.
String	keyGenerator The bean name of the custom KeyGenerator to use.
String	unless Spring Expression Language (SpEL) attribute used to veto method caching.
String[]	value Name of the caches in which the update takes place.

Element Detail

value

public abstract String[] value

Name of the caches in which the update takes place.

May be used to determine the target cache (or caches), matching the qualifier value (or the bean name(s)) of (a) specific bean definition.

Default:

{}

key

public abstract String key

Spring Expression Language (SpEL) attribute for computing the key dynamically.

Default is "", meaning all method parameters are considered as a key, unless a custom keyGenerator() has been set.

Default:

""

keyGenerator

public abstract String keyGenerator

The bean name of the custom KeyGenerator to use.

Mutually exclusive with the key() attribute.

Default:

""

cacheManager

public abstract String cacheManager

The bean name of the custom CacheManager to use to create a default CacheResolver if none is set already.

Mutually exclusive with the cacheResolver() attribute.

See Also:

SimpleCacheResolver

Default:

""

cacheResolver

public abstract String cacheResolver

The bean name of the custom CacheResolver to use.

Default:

""

condition

public abstract String condition

Spring Expression Language (SpEL) attribute used for conditioning the method caching.

Default is "", meaning the method is always cached.

Default:

""

unless

public abstract String unless

Spring Expression Language (SpEL) attribute used to veto method caching.

Unlike condition(), this expression is evaluated after the method has been called and can therefore refer to the result. Default is "", meaning that caching is never vetoed.

Since:

3.2

Default:

""