Package org.springframework.data.redis.cache

Class RedisCacheConfiguration

java.lang.Object

org.springframework.data.redis.cache.RedisCacheConfiguration

public class RedisCacheConfiguration
extends Object

Immutable RedisCacheConfiguration used to customize RedisCache behavior, such as caching null values, computing cache key prefixes and handling binary serialization.

Start with defaultCacheConfig() and customize RedisCache behavior using the builder methods, such as entryTtl(Duration), serializeKeysWith(SerializationPair) and serializeValuesWith(SerializationPair).

Since:

2.0

Author:

Christoph Strobl, Mark Paluch, John Blum

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	DEFAULT_CACHE_NULL_VALUES
protected static final boolean	DEFAULT_ENABLE_TIME_TO_IDLE_EXPIRATION
protected static final boolean	DEFAULT_USE_PREFIX
protected static final boolean	DO_NOT_CACHE_NULL_VALUES
protected static final boolean	DO_NOT_USE_PREFIX
protected static final boolean	USE_TIME_TO_IDLE_EXPIRATION

Method Summary

Modifier and Type	Method	Description
void	addCacheKeyConverter(Converter<?,String> cacheKeyConverter)	Adds a Converter to extract the String representation of a cache key if no suitable Object.toString() method is present.
RedisCacheConfiguration	computePrefixWith(CacheKeyPrefix cacheKeyPrefix)	Use the given CacheKeyPrefix to compute the prefix for the actual Redis key given the cache name as function input.
void	configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)	Configure the underlying ConversionService used to extract the cache key.
static RedisCacheConfiguration	defaultCacheConfig()	Default RedisCacheConfiguration using the following: key expiration eternal cache null values yes prefix cache keys yes default prefix [the actual cache name] key serializer StringRedisSerializer value serializer JdkSerializationRedisSerializer conversion service DefaultFormattingConversionService with default cache key converters
static RedisCacheConfiguration	defaultCacheConfig(ClassLoader classLoader)	Create default RedisCacheConfiguration given ClassLoader using the following: key expiration eternal cache null values yes prefix cache keys yes default prefix [the actual cache name] key serializer StringRedisSerializer value serializer JdkSerializationRedisSerializer conversion service DefaultFormattingConversionService with default cache key converters
RedisCacheConfiguration	disableCachingNullValues()	Disable caching null values.
RedisCacheConfiguration	disableKeyPrefix()	Disable using cache key prefixes.
RedisCacheConfiguration	enableTimeToIdle()	Enables time-to-idle (TTI) expiration on Cache read operations, such as Cache.get(Object).
RedisCacheConfiguration	entryTtl(Duration ttl)	Set the ttl to apply for cache entries.
RedisCacheConfiguration	entryTtl(RedisCacheWriter.TtlFunction ttlFunction)	Set the TTL function to compute the time to live for cache entries.
boolean	getAllowCacheNullValues()
ConversionService	getConversionService()
CacheKeyPrefix	getKeyPrefix()	Gets the configured CacheKeyPrefix.
String	getKeyPrefixFor(String cacheName)	Get the computed key prefix for a given cacheName.
RedisSerializationContext.SerializationPair<String>	getKeySerializationPair()
Duration	getTtl()	Deprecated. since 3.2.
RedisCacheWriter.TtlFunction	getTtlFunction()	Gets the RedisCacheWriter.TtlFunction used to compute a cache key time-to-live (TTL) expiration.
RedisSerializationContext.SerializationPair<Object>	getValueSerializationPair()
boolean	isTimeToIdleEnabled()	Determines whether time-to-idle (TTI) expiration has been enabled for caching.
RedisCacheConfiguration	prefixCacheNameWith(String prefix)	Prefix the cache name with the given value.
static void	registerDefaultConverters(ConverterRegistry registry)	Registers default cache key converters.
RedisCacheConfiguration	serializeKeysWith(RedisSerializationContext.SerializationPair<String> keySerializationPair)	Define the RedisSerializationContext.SerializationPair used for de-/serializing cache keys.
RedisCacheConfiguration	serializeValuesWith(RedisSerializationContext.SerializationPair<?> valueSerializationPair)	Define the RedisSerializationContext.SerializationPair used for de-/serializing cache values.
boolean	usePrefix()
RedisCacheConfiguration	withConversionService(ConversionService conversionService)	Define the ConversionService used for cache key to String conversion.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CACHE_NULL_VALUES

protected static final boolean DEFAULT_CACHE_NULL_VALUES

See Also:

• Constant Field Values

DEFAULT_ENABLE_TIME_TO_IDLE_EXPIRATION

protected static final boolean DEFAULT_ENABLE_TIME_TO_IDLE_EXPIRATION

See Also:

• Constant Field Values

DEFAULT_USE_PREFIX

protected static final boolean DEFAULT_USE_PREFIX

See Also:

• Constant Field Values

DO_NOT_CACHE_NULL_VALUES

protected static final boolean DO_NOT_CACHE_NULL_VALUES

See Also:

• Constant Field Values

DO_NOT_USE_PREFIX

protected static final boolean DO_NOT_USE_PREFIX

See Also:

• Constant Field Values

USE_TIME_TO_IDLE_EXPIRATION

protected static final boolean USE_TIME_TO_IDLE_EXPIRATION

See Also:

• Constant Field Values

Method Details

defaultCacheConfig

public static RedisCacheConfiguration defaultCacheConfig()

Default RedisCacheConfiguration using the following:

key expiration

eternal

cache null values

yes

prefix cache keys

yes

default prefix

[the actual cache name]

key serializer

StringRedisSerializer

value serializer

JdkSerializationRedisSerializer

conversion service

DefaultFormattingConversionService with default cache key converters

Returns:

new RedisCacheConfiguration.

defaultCacheConfig

public static RedisCacheConfiguration defaultCacheConfig(@Nullable
 ClassLoader classLoader)

Create default RedisCacheConfiguration given ClassLoader using the following:

key expiration

eternal

cache null values

yes

prefix cache keys

yes

default prefix

[the actual cache name]

key serializer

StringRedisSerializer

value serializer

JdkSerializationRedisSerializer

conversion service

DefaultFormattingConversionService with default cache key converters

Parameters:

classLoader - the ClassLoader used for deserialization by the JdkSerializationRedisSerializer.

Returns:

new RedisCacheConfiguration.

Since:

2.1

prefixCacheNameWith

public RedisCacheConfiguration prefixCacheNameWith(String prefix)

Prefix the cache name with the given value.
The generated cache key will be: prefix + cache name + "::" + cache entry key.

Parameters:

prefix - the prefix to prepend to the cache name.

Returns:

new RedisCacheConfiguration.

Since:

2.3

See Also:

• computePrefixWith(CacheKeyPrefix)
• CacheKeyPrefix.prefixed(String)

computePrefixWith

public RedisCacheConfiguration computePrefixWith(CacheKeyPrefix cacheKeyPrefix)

Use the given CacheKeyPrefix to compute the prefix for the actual Redis key given the cache name as function input.

Parameters:

cacheKeyPrefix - must not be null.

Returns:

new RedisCacheConfiguration.

Since:

2.0.4

See Also:

• CacheKeyPrefix

disableCachingNullValues

public RedisCacheConfiguration disableCachingNullValues()

Disable caching null values.
NOTE any Cache.put(Object, Object) operation involving null value will error. Nothing will be written to Redis, nothing will be removed. An already existing key will still be there afterwards with the very same value as before.

Returns:

new RedisCacheConfiguration.

disableKeyPrefix

public RedisCacheConfiguration disableKeyPrefix()

Disable using cache key prefixes.
NOTE: Cache.clear() might result in unintended removal of keys in Redis. Make sure to use a dedicated Redis instance when disabling prefixes.

Returns:

new RedisCacheConfiguration.

enableTimeToIdle

public RedisCacheConfiguration enableTimeToIdle()

Enables time-to-idle (TTI) expiration on Cache read operations, such as Cache.get(Object).

Enabling this option applies the same TTL expiration policy to Cache read operations as it does for Cache write operations. In effect, this will invoke the Redis GETEX command in place of GET.

Redis does not support the concept of TTI, only TTL. However, if TTL expiration is applied to all Cache operations, both read and write alike, and Cache operations passed with expiration are used consistently across the application, then in effect, an application can achieve TTI expiration-like behavior.

Requires Redis 6.2.0 or newer.

Returns:

this RedisCacheConfiguration.

Since:

3.2.0

See Also:

• GETEX

entryTtl

public RedisCacheConfiguration entryTtl(Duration ttl)

Set the ttl to apply for cache entries. Use Duration.ZERO to declare an eternal cache.

Parameters:

ttl - must not be null.

Returns:

new RedisCacheConfiguration.

entryTtl

public RedisCacheConfiguration entryTtl(RedisCacheWriter.TtlFunction ttlFunction)

Set the TTL function to compute the time to live for cache entries.

Parameters:

ttlFunction - the RedisCacheWriter.TtlFunction to compute the time to live for cache entries, must not be null.

Returns:

new RedisCacheConfiguration.

Since:

3.2

serializeKeysWith

public RedisCacheConfiguration serializeKeysWith(RedisSerializationContext.SerializationPair<String> keySerializationPair)

Define the RedisSerializationContext.SerializationPair used for de-/serializing cache keys.

Parameters:

keySerializationPair - must not be null.

Returns:

new RedisCacheConfiguration.

serializeValuesWith

public RedisCacheConfiguration serializeValuesWith(RedisSerializationContext.SerializationPair<?> valueSerializationPair)

Define the RedisSerializationContext.SerializationPair used for de-/serializing cache values.

Parameters:

valueSerializationPair - must not be null.

Returns:

new RedisCacheConfiguration.

withConversionService

public RedisCacheConfiguration withConversionService(ConversionService conversionService)

Define the ConversionService used for cache key to String conversion.

Parameters:

conversionService - must not be null.

Returns:

new RedisCacheConfiguration.

getAllowCacheNullValues

public boolean getAllowCacheNullValues()

Returns:

true if caching null is allowed.

isTimeToIdleEnabled

public boolean isTimeToIdleEnabled()

Determines whether time-to-idle (TTI) expiration has been enabled for caching.

Use enableTimeToIdle() to opt-in and enable time-to-idle (TTI) expiration for caching.

Returns:

true if time-to-idle (TTI) expiration was configured and enabled for caching. Defaults to false.

Since:

3.2.0

See Also:

• GETEX

usePrefix

public boolean usePrefix()

Returns:

true if cache keys need to be prefixed with the getKeyPrefixFor(String) if present or the default which resolves to Cache.getName().

getConversionService

public ConversionService getConversionService()

Returns:

The ConversionService used for cache key to String conversion. Never null.

getKeyPrefix

public CacheKeyPrefix getKeyPrefix()

Gets the configured CacheKeyPrefix.

Returns:

the configured CacheKeyPrefix.

getKeyPrefixFor

public String getKeyPrefixFor(String cacheName)

Get the computed key prefix for a given cacheName.

Returns:

never null.

Since:

2.0.4

getKeySerializationPair

public RedisSerializationContext.SerializationPair<String> getKeySerializationPair()

Returns:

never null.

getValueSerializationPair

public RedisSerializationContext.SerializationPair<Object> getValueSerializationPair()

Returns:

never null.

getTtl

@Deprecated(since="3.2")
public Duration getTtl()

Deprecated.

since 3.2. Use getTtlFunction() instead.

Returns a computed TTL expiration timeout based on cache entry key/value if a RedisCacheWriter.TtlFunction was confiugred using entryTtl(TtlFunction).

Otherwise, returns the user-provided, fixed Duration if entryTtl(Duration) was called during cache configuration.

Returns:

the configured TTL expiration.

getTtlFunction

public RedisCacheWriter.TtlFunction getTtlFunction()

Gets the RedisCacheWriter.TtlFunction used to compute a cache key time-to-live (TTL) expiration.

Returns:

the RedisCacheWriter.TtlFunction used to compute expiration time (TTL) for cache entries; never null.

addCacheKeyConverter

public void addCacheKeyConverter(Converter<?,String> cacheKeyConverter)

Adds a Converter to extract the String representation of a cache key if no suitable Object.toString() method is present.

Parameters:

cacheKeyConverter - Converter used to convert a cache key into a String.

Throws:

IllegalStateException - if getConversionService() does not allow Converter registration.

Since:

2.2

See Also:

• Converter

configureKeyConverters

public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)

Configure the underlying ConversionService used to extract the cache key.

Parameters:

registryConsumer - Consumer used to register a Converter with the configured ConverterRegistry; never null.

Throws:

IllegalStateException - if getConversionService() does not allow Converter registration.

Since:

2.2

See Also:

• ConverterRegistry

registerDefaultConverters

public static void registerDefaultConverters(ConverterRegistry registry)

Registers default cache key converters.

The following converters get registered:

• String to byte byte[] using UTF-8 encoding.
• SimpleKey to String

Parameters:

registry - ConverterRegistry in which the key converters are registered; must not be null.

See Also:

• ConverterRegistry