@Target(value={TYPE,METHOD}) @Retention(value=RUNTIME) @Inherited @Documented public @interface CacheEvict
cache evict
operation.
This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.
CacheConfig
Modifier and Type | Optional Element and Description |
---|---|
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 custom
CacheManager to use to
create a default CacheResolver 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 custom
CacheResolver
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 custom
KeyGenerator
to use. |
String[] |
value
Alias for
cacheNames() . |
@AliasFor(value="cacheNames") public abstract String[] value
cacheNames()
.@AliasFor(value="value") public abstract String[] cacheNames
Names may be used to determine the target cache (or caches), matching the qualifier value or bean name of a specific bean definition.
value()
,
CacheConfig.cacheNames()
public abstract String key
Default is ""
, meaning all method parameters are considered as a key,
unless a custom keyGenerator()
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 if beforeInvocation()
is false
. For supported
wrappers such as Optional
, #result
refers to the actual object,
not the wrapper#root.method
, #root.target
, and #root.caches
for
references to the method
, target object, and
affected cache(s) respectively.#root.methodName
) and target class
(#root.targetClass
) are also available.
#root.args[1]
, #p1
or #a1
. Arguments
can also be accessed by name if that information is available.public abstract String keyGenerator
KeyGenerator
to use.
Mutually exclusive with the key()
attribute.
CacheConfig.keyGenerator()
public abstract String cacheManager
CacheManager
to use to
create a default CacheResolver
if none
is set already.
Mutually exclusive with the cacheResolver()
attribute.
SimpleCacheResolver
,
CacheConfig.cacheManager()
public abstract String cacheResolver
CacheResolver
to use.CacheConfig.cacheResolver()
public abstract String condition
true
.
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 the method
, target object, and
affected cache(s) respectively.#root.methodName
) and target class
(#root.targetClass
) are also available.
#root.args[1]
, #p1
or #a1
. Arguments
can also be accessed by name if that information is available.public abstract boolean allEntries
By default, only the value under the associated key is removed.
Note that setting this parameter to true
and specifying a
key()
is not allowed.
public abstract boolean beforeInvocation
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).