Package org.springframework.data.redis.cache

Class RedisCacheConfiguration

java.lang.Object

org.springframework.data.redis.cache.RedisCacheConfiguration

public class RedisCacheConfiguration
extends Object

Immutable RedisCacheConfiguration helps customizing RedisCache behaviour such as caching null values, cache key prefixes and binary serialization.
Start with defaultCacheConfig() and customize RedisCache behaviour from there on.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method	Description
void	addCacheKeyConverter(Converter<?,String> cacheKeyConverter)	Add a Converter for extracting 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 conversion system 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	entryTtl(Duration ttl)	Set the ttl to apply for cache entries.
boolean	getAllowCacheNullValues()
ConversionService	getConversionService()
String	getKeyPrefixFor(String cacheName)	Get the computed key prefix for a given cacheName.
RedisSerializationContext.SerializationPair<String>	getKeySerializationPair()
Duration	getTtl()
RedisSerializationContext.SerializationPair<Object>	getValueSerializationPair()
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

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

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.

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.

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.

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.

getKeyPrefixFor

public String getKeyPrefixFor(String cacheName)

Get the computed key prefix for a given cacheName.

Returns:

never null.

Since:

2.0.4

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

getAllowCacheNullValues

public boolean getAllowCacheNullValues()

Returns:

true if caching null is allowed.

getKeySerializationPair

public RedisSerializationContext.SerializationPair<String> getKeySerializationPair()

Returns:

never null.

getValueSerializationPair

public RedisSerializationContext.SerializationPair<Object> getValueSerializationPair()

Returns:

never null.

getTtl

public Duration getTtl()

Returns:

The expiration time (ttl) for cache entries. Never null.

getConversionService

public ConversionService getConversionService()

Returns:

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

addCacheKeyConverter

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

Add a Converter for extracting the String representation of a cache key if no suitable Object.toString() method is present.

Parameters:

cacheKeyConverter -

Throws:

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

Since:

2.2

configureKeyConverters

public void configureKeyConverters(Consumer<ConverterRegistry> registryConsumer)

Configure the underlying conversion system used to extract the cache key.

Parameters:

registryConsumer - never null.

Throws:

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

Since:

2.2

registerDefaultConverters

public static void registerDefaultConverters(ConverterRegistry registry)

Registers default cache key converters. The following converters get registered:

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

Parameters:

registry - must not be null.