类 CaffeineCache
- java.lang.Object
- org.springframework.cache.support.AbstractValueAdaptingCache
- org.springframework.cache.caffeine.CaffeineCache
- 所有已实现的接口:
Cache
@UsesJava8 public class CaffeineCache extends AbstractValueAdaptingCache
SpringCache
adapter implementation on top of a CaffeineCache
instance.Requires Caffeine 2.1 or higher.
- 从以下版本开始:
- 4.3
- 作者:
- Ben Manes, Juergen Hoeller, Stephane Nicoll
- 另请参阅:
CaffeineCacheManager
嵌套类概要
从接口继承的嵌套类/接口 org.springframework.cache.Cache
Cache.ValueRetrievalException, Cache.ValueWrapper
构造器概要
构造器 构造器 说明 CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache)
Create aCaffeineCache
instance with the specified name and the given internalCache
to use.CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache, boolean allowNullValues)
Create aCaffeineCache
instance with the specified name and the given internalCache
to use.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
clear()
Remove all mappings from the cache.void
evict(Object key)
Evict the mapping for this key from this cache if it is present.Cache.ValueWrapper
get(Object key)
Return the value to which this cache maps the specified key.<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.com.github.benmanes.caffeine.cache.Cache<Object,Object>
getNativeCache()
Return the underlying native cache provider.protected Object
lookup(Object key)
Perform an actual lookup in the underlying store.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.从类继承的方法 org.springframework.cache.support.AbstractValueAdaptingCache
fromStoreValue, get, isAllowNullValues, toStoreValue, toValueWrapper
构造器详细资料
CaffeineCache
public CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache)
Create aCaffeineCache
instance with the specified name and the given internalCache
to use.- 参数:
name
- the name of the cachecache
- the backing Caffeine Cache instance
CaffeineCache
public CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache, boolean allowNullValues)
Create aCaffeineCache
instance with the specified name and the given internalCache
to use.- 参数:
name
- the name of the cachecache
- the backing Caffeine Cache instanceallowNullValues
- whether to accept and convertnull
values for this cache
方法详细资料
getNativeCache
public final com.github.benmanes.caffeine.cache.Cache<Object,Object> getNativeCache()
从接口复制的说明:Cache
Return the underlying native cache provider.
get
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
- 覆盖:
get
在类中AbstractValueAdaptingCache
- 参数:
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)
get
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
- 参数:
key
- the key whose associated value is to be returned- 返回:
- the value to which this cache maps the specified key
lookup
protected Object lookup(Object key)
从类复制的说明:AbstractValueAdaptingCache
Perform an actual lookup in the underlying store.- 指定者:
lookup
在类中AbstractValueAdaptingCache
- 参数:
key
- the key whose associated value is to be returned- 返回:
- the raw store value for the key, or
null
if none
put
public void put(Object key, 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.
- 参数:
key
- the key with which the specified value is to be associatedvalue
- the value to be associated with the specified key
putIfAbsent
public Cache.ValueWrapper putIfAbsent(Object key, 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-boxObject existingValue = cache.get(key); if (existingValue == null) { cache.put(key, value); return null; } else { 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.- 参数:
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.
evict
public void evict(Object key)
从接口复制的说明:Cache
Evict the mapping for this key from this cache if it is present.- 参数:
key
- the key whose mapping is to be removed from the cache