Package org.springframework.data.redis.cache

Class RedisCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.data.redis.cache.RedisCache

All Implemented Interfaces:

Cache

public class RedisCache
extends AbstractValueAdaptingCache

Cache implementation using Redis as the underlying store for cache data.

Use RedisCacheManager to create RedisCache instances.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, Piotr Mionskowski, Jos Roseboom, John Blum

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

Cache.ValueRetrievalException, Cache.ValueWrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RedisCache(String name, RedisCacheWriter cacheWriter, RedisCacheConfiguration cacheConfiguration)	Create a new RedisCache with the given name and RedisCacheConfiguration, using the RedisCacheWriter to execute Redis commands supporting the cache operations.

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clear(String keyPattern)	Clear keys that match the given keyPattern.
void	clearStatistics()	Reset all statistics counters and gauges for this cache.
protected String	convertKey(Object key)	Convert key to a String used in cache key creation.
protected String	createCacheKey(Object key)	Customization hook for creating cache key before it gets serialized.
protected Object	deserializeCacheValue(byte[] value)	Deserialize the given the array of bytes to the actual cache value.
void	evict(Object key)
<T> T	get(Object key, Callable<T> valueLoader)
RedisCacheConfiguration	getCacheConfiguration()	Get the RedisCacheConfiguration used to configure this RedisCache on initialization.
protected RedisCacheWriter	getCacheWriter()	Gets the configured RedisCacheWriter used to adapt Redis for cache operations.
protected ConversionService	getConversionService()	Gets the configured ConversionService used to convert cache keys to a String when accessing entries in the cache.
String	getName()
RedisCacheWriter	getNativeCache()
CacheStatistics	getStatistics()	Return the CacheStatistics snapshot for this cache instance.
protected <T> T	loadCacheValue(Object key, Callable<T> valueLoader)	Loads the Object using the given valueLoader and puts the loaded value in the cache.
protected Object	lookup(Object key)
protected Object	preProcessCacheValue(Object value)	Customization hook called before passing object to RedisSerializer.
void	put(Object key, Object value)
Cache.ValueWrapper	putIfAbsent(Object key, Object value)
CompletableFuture<Cache.ValueWrapper>	retrieve(Object key)
<T> CompletableFuture<T>	retrieve(Object key, Supplier<CompletableFuture<T>> valueLoader)
protected byte[]	serializeCacheKey(String cacheKey)	Serialize the given cache key.
protected byte[]	serializeCacheValue(Object value)	Serialize the value to cache as an array of bytes.

Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache

fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cache.Cache

evictIfPresent, invalidate

Constructor Details

RedisCache

protected RedisCache(String name,
 RedisCacheWriter cacheWriter,
 RedisCacheConfiguration cacheConfiguration)

Create a new RedisCache with the given name and RedisCacheConfiguration, using the RedisCacheWriter to execute Redis commands supporting the cache operations.

Parameters:

name - name for this Cache; must not be null.

cacheWriter - RedisCacheWriter used to perform RedisCache operations by executing the necessary Redis commands; must not be null.

cacheConfiguration - RedisCacheConfiguration applied to this RedisCache on creation; must not be null.

Throws:

IllegalArgumentException - if either the given RedisCacheWriter or RedisCacheConfiguration are null or the given String name for this RedisCache is null.

Method Details

getCacheConfiguration

public RedisCacheConfiguration getCacheConfiguration()

Get the RedisCacheConfiguration used to configure this RedisCache on initialization.

Returns:

an immutable RedisCacheConfiguration used to configure this RedisCache on initialization.

getCacheWriter

protected RedisCacheWriter getCacheWriter()

Gets the configured RedisCacheWriter used to adapt Redis for cache operations.

Returns:

the configured RedisCacheWriter used to adapt Redis for cache operations.

getConversionService

protected ConversionService getConversionService()

Gets the configured ConversionService used to convert cache keys to a String when accessing entries in the cache.

Returns:

the configured ConversionService used to convert cache keys to a String when accessing entries in the cache.

See Also:

• RedisCacheConfiguration.getConversionService()
• getCacheConfiguration()

getName

public String getName()

getNativeCache

public RedisCacheWriter getNativeCache()

getStatistics

public CacheStatistics getStatistics()

Return the CacheStatistics snapshot for this cache instance.

Statistics are accumulated per cache instance and not from the backing Redis data store.

Returns:

CacheStatistics object for this RedisCache.

Since:

2.4

get

public <T> T get(Object key,
 Callable<T> valueLoader)

loadCacheValue

protected <T> T loadCacheValue(Object key,
 Callable<T> valueLoader)

Loads the Object using the given valueLoader and puts the loaded value in the cache.

Type Parameters:

T - type of the loaded cache value.

Parameters:

key - key mapped to the loaded cache value.

valueLoader - Callable object used to load the value for the given key.

Returns:

the loaded value.

lookup

protected Object lookup(Object key)

Specified by:

lookup in class AbstractValueAdaptingCache

put

public void put(Object key,
 @Nullable
 Object value)

putIfAbsent

public Cache.ValueWrapper putIfAbsent(Object key,
 @Nullable
 Object value)

clear

public void clear()

clear

public void clear(String keyPattern)

Clear keys that match the given keyPattern.

Useful when cache keys are formatted in a style where Redis patterns can be used for matching these.

Parameters:

keyPattern - pattern used to match Redis keys to clear.

Since:

3.0

clearStatistics

public void clearStatistics()

Reset all statistics counters and gauges for this cache.

Since:

2.4

evict

public void evict(Object key)

retrieve

public CompletableFuture<Cache.ValueWrapper> retrieve(Object key)

retrieve

public <T> CompletableFuture<T> retrieve(Object key,
 Supplier<CompletableFuture<T>> valueLoader)

preProcessCacheValue

@Nullable
protected Object preProcessCacheValue(@Nullable
 Object value)

Customization hook called before passing object to RedisSerializer.

Parameters:

value - can be null.

Returns:

preprocessed value. Can be null.

serializeCacheKey

protected byte[] serializeCacheKey(String cacheKey)

Serialize the given cache key.

Parameters:

cacheKey - cache key to serialize; must not be null.

Returns:

an array of bytes from the given, serialized cache key; never null.

See Also:

• RedisCacheConfiguration.getKeySerializationPair()

serializeCacheValue

protected byte[] serializeCacheValue(Object value)

Serialize the value to cache as an array of bytes.

Parameters:

value - Object to serialize and cache; must not be null.

Returns:

an array of bytes from the serialized value; never null.

See Also:

• RedisCacheConfiguration.getValueSerializationPair()

deserializeCacheValue

@Nullable
protected Object deserializeCacheValue(byte[] value)

Deserialize the given the array of bytes to the actual cache value.

Parameters:

value - array of bytes to deserialize; must not be null.

Returns:

an Object deserialized from the array of bytes using the configured value RedisSerializationContext.SerializationPair; can be null.

See Also:

• RedisCacheConfiguration.getValueSerializationPair()

createCacheKey

protected String createCacheKey(Object key)

Customization hook for creating cache key before it gets serialized.

Parameters:

key - will never be null.

Returns:

never null.

convertKey

protected String convertKey(Object key)

Convert key to a String used in cache key creation.

Parameters:

key - will never be null.

Returns:

never null.

Throws:

IllegalStateException - if key cannot be converted to String.