类 TransactionAwareCacheDecorator
- java.lang.Object
- org.springframework.cache.transaction.TransactionAwareCacheDecorator
- 所有已实现的接口:
Cache
public class TransactionAwareCacheDecorator extends Object implements Cache
Cache decorator which synchronizes itsput(java.lang.Object, java.lang.Object)
,evict(java.lang.Object)
andclear()
operations with Spring-managed transactions (through Spring'sTransactionSynchronizationManager
, performing the actual cache put/evict/clear operation only in the after-commit phase of a successful transaction. If no transaction is active,put(java.lang.Object, java.lang.Object)
,evict(java.lang.Object)
andclear()
operations will be performed immediately, as usual.Note: Use of immediate operations such as
putIfAbsent(java.lang.Object, java.lang.Object)
andevictIfPresent(java.lang.Object)
cannot be deferred to the after-commit phase of a running transaction. Use these with care in a transactional environment.- 从以下版本开始:
- 3.2
- 作者:
- Juergen Hoeller, Stephane Nicoll, Stas Volsky
- 另请参阅:
TransactionAwareCacheManagerProxy
嵌套类概要
从接口继承的嵌套类/接口 org.springframework.cache.Cache
Cache.ValueRetrievalException, Cache.ValueWrapper
构造器概要
构造器 构造器 说明 TransactionAwareCacheDecorator(Cache targetCache)
Create a new TransactionAwareCache for the given target Cache.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
clear()
Clear the cache through removing all mappings.void
evict(Object key)
Evict the mapping for this key from this cache if it is present.boolean
evictIfPresent(Object key)
Evict the mapping for this key from this cache if it is present, expecting the key to be immediately invisible for subsequent lookups.Cache.ValueWrapper
get(Object key)
Return the value to which this cache maps the specified key.<T> T
get(Object key, Class<T> type)
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.<T> T
get(Object key, Callable<T> valueLoader)
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary.String
getName()
Return the cache name.Object
getNativeCache()
Return the underlying native cache provider.Cache
getTargetCache()
Return the target Cache that this Cache should delegate to.boolean
invalidate()
Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.void
put(Object key, Object value)
Associate the specified value with the specified key in this cache.Cache.ValueWrapper
putIfAbsent(Object key, Object value)
Atomically associate the specified value with the specified key in this cache if it is not set already.
构造器详细资料
TransactionAwareCacheDecorator
public TransactionAwareCacheDecorator(Cache targetCache)
Create a new TransactionAwareCache for the given target Cache.- 参数:
targetCache
- the target Cache to decorate
方法详细资料
getTargetCache
public Cache getTargetCache()
Return the target Cache that this Cache should delegate to.
getNativeCache
public Object getNativeCache()
从接口复制的说明:Cache
Return the underlying native cache provider.- 指定者:
getNativeCache
在接口中Cache
get
@Nullable public Cache.ValueWrapper get(Object key)
从接口复制的说明:Cache
Return the value to which this cache maps the specified key.Returns
null
if the cache contains no mapping for this key; otherwise, the cached value (which may benull
itself) will be returned in aCache.ValueWrapper
.- 指定者:
get
在接口中Cache
- 参数:
key
- the key whose associated value is to be returned- 返回:
- the value to which this cache maps the specified key, contained within a
Cache.ValueWrapper
which may also hold a cachednull
value. A straightnull
being returned means that the cache contains no mapping for this key. - 另请参阅:
Cache.get(Object, Class)
,Cache.get(Object, Callable)
get
public <T> T get(Object key, @Nullable Class<T> type)
从接口复制的说明:Cache
Return the value to which this cache maps the specified key, generically specifying a type that return value will be cast to.Note: This variant of
get
does not allow for differentiating between a cachednull
value and no cache entry found at all. Use the standardCache.get(Object)
variant for that purpose instead.- 指定者:
get
在接口中Cache
- 参数:
key
- the key whose associated value is to be returnedtype
- the required type of the returned value (may benull
to bypass a type check; in case of anull
value found in the cache, the specified type is irrelevant)- 返回:
- the value to which this cache maps the specified key (which may be
null
itself), or alsonull
if the cache contains no mapping for this key - 另请参阅:
Cache.get(Object)
get
@Nullable public <T> T get(Object key, Callable<T> valueLoader)
从接口复制的说明:Cache
Return the value to which this cache maps the specified key, obtaining that value fromvalueLoader
if necessary. This method provides a simple substitute for the conventional "if cached, return; otherwise create, cache and return" pattern.If possible, implementations should ensure that the loading operation is synchronized so that the specified
valueLoader
is only called once in case of concurrent access on the same key.If the
valueLoader
throws an exception, it is wrapped in aCache.ValueRetrievalException
- 指定者:
get
在接口中Cache
- 参数:
key
- the key whose associated value is to be returned- 返回:
- the value to which this cache maps the specified key
- 另请参阅:
Cache.get(Object)
put
public void put(Object key, @Nullable Object value)
从接口复制的说明:Cache
Associate the specified value with the specified key in this cache.If the cache previously contained a mapping for this key, the old value is replaced by the specified value.
Actual registration may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly not seeing the entry yet. This may for example be the case with transactional cache decorators. Use
Cache.putIfAbsent(java.lang.Object, java.lang.Object)
for guaranteed immediate registration.- 指定者:
put
在接口中Cache
- 参数:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- 另请参阅:
Cache.putIfAbsent(Object, Object)
putIfAbsent
@Nullable public Cache.ValueWrapper putIfAbsent(Object key, @Nullable Object value)
从接口复制的说明:Cache
Atomically associate the specified value with the specified key in this cache if it is not set already.This is equivalent to:
except that the action is performed atomically. While all out-of-the-boxValueWrapper existingValue = cache.get(key); if (existingValue == null) { cache.put(key, value); } return existingValue;
CacheManager
implementations are able to perform the put atomically, the operation may also be implemented in two steps, e.g. with a check for presence and a subsequent put, in a non-atomic way. Check the documentation of the native cache implementation that you are using for more details.The default implementation delegates to
Cache.get(Object)
andCache.put(Object, Object)
along the lines of the code snippet above.- 指定者:
putIfAbsent
在接口中Cache
- 参数:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key- 返回:
- the value to which this cache maps the specified key (which may be
null
itself), or alsonull
if the cache did not contain any mapping for that key prior to this call. Returningnull
is therefore an indicator that the givenvalue
has been associated with the key. - 另请参阅:
Cache.put(Object, Object)
evict
public void evict(Object key)
从接口复制的说明:Cache
Evict the mapping for this key from this cache if it is present.Actual eviction may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly still seeing the entry. This may for example be the case with transactional cache decorators. Use
Cache.evictIfPresent(java.lang.Object)
for guaranteed immediate removal.- 指定者:
evict
在接口中Cache
- 参数:
key
- the key whose mapping is to be removed from the cache- 另请参阅:
Cache.evictIfPresent(Object)
evictIfPresent
public boolean evictIfPresent(Object key)
从接口复制的说明:Cache
Evict the mapping for this key from this cache if it is present, expecting the key to be immediately invisible for subsequent lookups.The default implementation delegates to
Cache.evict(Object)
, returningfalse
for not-determined prior presence of the key. Cache providers and in particular cache decorators are encouraged to perform immediate eviction if possible (e.g. in case of generally deferred cache operations within a transaction) and to reliably determine prior presence of the given key.- 指定者:
evictIfPresent
在接口中Cache
- 参数:
key
- the key whose mapping is to be removed from the cache- 返回:
true
if the cache was known to have a mapping for this key before,false
if it did not (or if prior presence could not be determined)- 另请参阅:
Cache.evict(Object)
clear
public void clear()
从接口复制的说明:Cache
Clear the cache through removing all mappings.Actual clearing may be performed in an asynchronous or deferred fashion, with subsequent lookups possibly still seeing the entries. This may for example be the case with transactional cache decorators. Use
Cache.invalidate()
for guaranteed immediate removal of entries.- 指定者:
clear
在接口中Cache
- 另请参阅:
Cache.invalidate()
invalidate
public boolean invalidate()
从接口复制的说明:Cache
Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.- 指定者:
invalidate
在接口中Cache
- 返回:
true
if the cache was known to have mappings before,false
if it did not (or if prior presence of entries could not be determined)- 另请参阅:
Cache.clear()