Annotation Type CachePut
@Target({METHOD,TYPE}) @Retention(RUNTIME) @Inherited @Documented public @interface CachePut
Annotation indicating that a method (or all methods on a class) triggers acache putoperation.In contrast to the
@Cacheableannotation, this annotation does not cause the advised method to be skipped. Rather, it always causes the method to be invoked and its result to be stored in the associated cache. Note that Java8'sOptionalreturn types are automatically handled and its content is stored in the cache if present.This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.
- Since:
- 3.1
- Author:
- Costin Leau, Phillip Webb, Stephane Nicoll, Sam Brannen
- See Also:
CacheConfig
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description StringcacheManagerThe bean name of the customCacheManagerto use to create a defaultCacheResolverif none is set already.String[]cacheNamesNames of the caches to use for the cache put operation.StringcacheResolverThe bean name of the customCacheResolverto use.StringconditionSpring Expression Language (SpEL) expression used for making the cache put operation conditional.StringkeySpring Expression Language (SpEL) expression for computing the key dynamically.StringkeyGeneratorThe bean name of the customKeyGeneratorto use.StringunlessSpring Expression Language (SpEL) expression used to veto the cache put operation.String[]valueAlias forcacheNames().
Element Detail
value
@AliasFor("cacheNames") String[] value
Alias forcacheNames().- Default:
- {}
cacheNames
@AliasFor("value") String[] cacheNames
Names of the caches to use for the cache put operation.Names may be used to determine the target cache (or caches), matching the qualifier value or bean name of a specific bean definition.
- Since:
- 4.2
- See Also:
value(),CacheConfig.cacheNames()
- Default:
- {}
key
String key
Spring Expression Language (SpEL) expression for computing the key dynamically.Default is
"", meaning all method parameters are considered as a key, unless a customkeyGenerator()has been set.The SpEL expression evaluates against a dedicated context that provides the following meta-data:
#resultfor a reference to the result of the method invocation. For supported wrappers such asOptional,#resultrefers to the actual object, not the wrapper#root.method,#root.target, and#root.cachesfor references to themethod, target object, and affected cache(s) respectively.- Shortcuts for the method name (
#root.methodName) and target class (#root.targetClass) are also available. - Method arguments can be accessed by index. For instance the second argument can be accessed via
#root.args[1],#p1or#a1. Arguments can also be accessed by name if that information is available.
- Default:
- ""
keyGenerator
String keyGenerator
The bean name of the customKeyGeneratorto use.Mutually exclusive with the
key()attribute.- See Also:
CacheConfig.keyGenerator()
- Default:
- ""
cacheManager
String cacheManager
The bean name of the customCacheManagerto use to create a defaultCacheResolverif none is set already.Mutually exclusive with the
cacheResolver()attribute.- Default:
- ""
cacheResolver
String cacheResolver
The bean name of the customCacheResolverto use.- See Also:
CacheConfig.cacheResolver()
- Default:
- ""
condition
String condition
Spring Expression Language (SpEL) expression used for making the cache put operation conditional.Default is
"", meaning the method result is always cached.The SpEL expression evaluates against a dedicated context that provides the following meta-data:
#root.method,#root.target, and#root.cachesfor references to themethod, target object, and affected cache(s) respectively.- Shortcuts for the method name (
#root.methodName) and target class (#root.targetClass) are also available. - Method arguments can be accessed by index. For instance the second argument can be accessed via
#root.args[1],#p1or#a1. Arguments can also be accessed by name if that information is available.
- Default:
- ""
unless
String unless
Spring Expression Language (SpEL) expression used to veto the cache put operation.Unlike
condition(), this expression is evaluated after the method has been called and can therefore refer to theresult.Default is
"", meaning that caching is never vetoed.The SpEL expression evaluates against a dedicated context that provides the following meta-data:
#resultfor a reference to the result of the method invocation. For supported wrappers such asOptional,#resultrefers to the actual object, not the wrapper#root.method,#root.target, and#root.cachesfor references to themethod, target object, and affected cache(s) respectively.- Shortcuts for the method name (
#root.methodName) and target class (#root.targetClass) are also available. - Method arguments can be accessed by index. For instance the second argument can be accessed via
#root.args[1],#p1or#a1. Arguments can also be accessed by name if that information is available.
- Since:
- 3.2
- Default:
- ""