org.springframework.cache.caffeine

类 CaffeineCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.cache.caffeine.CaffeineCache

所有已实现的接口:

Cache

public class CaffeineCache
extends AbstractValueAdaptingCache

Spring Cache adapter implementation on top of a Caffeine Cache 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 a CaffeineCache instance with the specified name and the given internal Cache to use.
CaffeineCache(String name, com.github.benmanes.caffeine.cache.Cache<Object,Object> cache, boolean allowNullValues) Create a CaffeineCache instance with the specified name and the given internal Cache to use.

方法概要

限定符和类型	方法和说明
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.
<T> T	get(Object key, Callable<T> valueLoader) Return the value to which this cache maps the specified key, obtaining that value from valueLoader if necessary.
String	getName() Return the cache name.
com.github.benmanes.caffeine.cache.Cache<Object,Object>	getNativeCache() Return the underlying native cache provider.
boolean	invalidate() Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.
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, get, isAllowNullValues, toStoreValue, toValueWrapper

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CaffeineCache

public CaffeineCache(String name,
                     com.github.benmanes.caffeine.cache.Cache<Object,Object> cache)

Create a CaffeineCache instance with the specified name and the given internal Cache to use.

参数:

name - the name of the cache

cache - the backing Caffeine Cache instance

CaffeineCache

public CaffeineCache(String name,
                     com.github.benmanes.caffeine.cache.Cache<Object,Object> cache,
                     boolean allowNullValues)

Create a CaffeineCache instance with the specified name and the given internal Cache to use.

参数:

name - the name of the cache

cache - the backing Caffeine Cache instance

allowNullValues - whether to accept and convert null values for this cache

方法详细资料

getName

public final String getName()

从接口复制的说明: Cache

Return the cache name.

getNativeCache

public final com.github.benmanes.caffeine.cache.Cache<Object,Object> getNativeCache()

从接口复制的说明: Cache

Return the underlying native cache provider.

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 from valueLoader 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 a Cache.ValueRetrievalException

参数:

key - the key whose associated value is to be returned

返回:

the value to which this cache maps the specified key

另请参阅:

Cache.get(Object)

lookup

@Nullable
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,
                @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.

参数:

key - the key with which the specified value is to be associated

value - 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:

 ValueWrapper existingValue = cache.get(key);
 if (existingValue == null) {
     cache.put(key, value);
 }
 return existingValue;
 

except that the action is performed atomically. While all out-of-the-box 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) and Cache.put(Object, Object) along the lines of the code snippet above.

参数:

key - the key with which the specified value is to be associated

value - 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 also null if the cache did not contain any mapping for that key prior to this call. Returning null is therefore an indicator that the given value 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.

参数:

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), returning false 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.

参数:

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.

另请参阅:

Cache.invalidate()

invalidate

public boolean invalidate()

从接口复制的说明: Cache

Invalidate the cache through removing all mappings, expecting all entries to be immediately invisible for subsequent lookups.

返回:

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()