程序包 cn.taketoday.cache.support

类 CaffeineCache

java.lang.Object
cn.taketoday.cache.support.AbstractValueAdaptingCache
cn.taketoday.cache.support.CaffeineCache
所有已实现的接口:
Cache
public class CaffeineCache extends AbstractValueAdaptingCache
Framework Cache adapter implementation on top of a Caffeine Cache instance.

Requires Caffeine 2.1 or higher.

从以下版本开始:
3.0
作者:
Ben Manes, Juergen Hoeller, Stephane Nicoll, TODAY 2020-08-15 19:50
另请参阅:

  • 构造器详细资料

    • 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
      另请参阅:

    • 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
      另请参阅:

    • 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.
      另请参阅:

    • 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
      另请参阅:

    • 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)
      另请参阅:

    • 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.

      另请参阅:

    • 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)
      另请参阅: