注释类型 CacheEvict
@Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited @Documented public @interface CacheEvict
Annotation indicating that a method (or all methods on a class) triggers acache evict
operation.This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.
- 从以下版本开始:
- 3.1
- 作者:
- Costin Leau, Stephane Nicoll, Sam Brannen
- 另请参阅:
CacheConfig
可选元素概要
可选元素 修饰符和类型 可选元素 说明 boolean
allEntries
Whether all the entries inside the cache(s) are removed.boolean
beforeInvocation
Whether the eviction should occur before the method is invoked.String
cacheManager
The bean name of the customCacheManager
to use to create a defaultCacheResolver
if none is set already.String[]
cacheNames
Names of the caches to use for the cache eviction operation.String
cacheResolver
The bean name of the customCacheResolver
to use.String
condition
Spring Expression Language (SpEL) expression used for making the cache eviction operation conditional.String
key
Spring Expression Language (SpEL) expression for computing the key dynamically.String
keyGenerator
The bean name of the customKeyGenerator
to use.String[]
value
Alias forcacheNames()
.
元素详细资料
value
@AliasFor("cacheNames") String[] value
Alias forcacheNames()
.- 默认值:
- {}
cacheNames
@AliasFor("value") String[] cacheNames
Names of the caches to use for the cache eviction operation.Names may be used to determine the target cache (or caches), matching the qualifier value or bean name of a specific bean definition.
- 从以下版本开始:
- 4.2
- 另请参阅:
value()
,CacheConfig.cacheNames()
- 默认值:
- {}
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:
#result
for a reference to the result of the method invocation, which can only be used ifbeforeInvocation()
isfalse
. For supported wrappers such asOptional
,#result
refers to the actual object, not the wrapper#root.method
,#root.target
, and#root.caches
for 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]
,#p1
or#a1
. Arguments can also be accessed by name if that information is available.
- 默认值:
- ""
keyGenerator
String keyGenerator
The bean name of the customKeyGenerator
to use.Mutually exclusive with the
key()
attribute.- 默认值:
- ""
cacheManager
String cacheManager
The bean name of the customCacheManager
to use to create a defaultCacheResolver
if none is set already.Mutually exclusive with the
cacheResolver()
attribute.- 默认值:
- ""
cacheResolver
String cacheResolver
The bean name of the customCacheResolver
to use.- 默认值:
- ""
condition
String condition
Spring Expression Language (SpEL) expression used for making the cache eviction operation conditional.Default is
""
, meaning the cache eviction is always performed.The SpEL expression evaluates against a dedicated context that provides the following meta-data:
#root.method
,#root.target
, and#root.caches
for 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]
,#p1
or#a1
. Arguments can also be accessed by name if that information is available.
- 默认值:
- ""
allEntries
boolean allEntries
Whether all the entries inside the cache(s) are removed.By default, only the value under the associated key is removed.
Note that setting this parameter to
true
and specifying akey()
is not allowed.- 默认值:
- false
beforeInvocation
boolean beforeInvocation
Whether the eviction should occur before the method is invoked.Setting this attribute to
true
, causes the eviction to occur irrespective of the method outcome (i.e., whether it threw an exception or not).Defaults to
false
, meaning that the cache eviction operation will occur after the advised method is invoked successfully (i.e. only if the invocation did not throw an exception).- 默认值:
- false