• Home
• org.springframework.data
• spring-data-redis
• 3.3.0
• source code
• RedisCacheConfiguration.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.springframework.data.redis.cache.RedisCacheConfiguration Maven / Gradle / Ivy

/*
 * Copyright 2017-2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.redis.cache;

import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.function.Consumer;

import org.springframework.cache.Cache;
import org.springframework.cache.interceptor.SimpleKey;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterRegistry;
import org.springframework.data.redis.cache.RedisCacheWriter.TtlFunction;
import org.springframework.data.redis.serializer.RedisSerializationContext.SerializationPair;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.format.support.DefaultFormattingConversionService;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

/**
 * Immutable {@link RedisCacheConfiguration} used to customize {@link RedisCache} behavior, such as caching
 * {@literal null} values, computing cache key prefixes and handling binary serialization.
 * 

 * Start with {@link RedisCacheConfiguration#defaultCacheConfig()} and customize {@link RedisCache} behavior
 * using the builder methods, such as {@link #entryTtl(Duration)}, {@link #serializeKeysWith(SerializationPair)}
 * and {@link #serializeValuesWith(SerializationPair)}.
 *
 * @author Christoph Strobl
 * @author Mark Paluch
 * @author John Blum
 * @since 2.0
 */
public class RedisCacheConfiguration {

	protected static final boolean DEFAULT_CACHE_NULL_VALUES = true;
	protected static final boolean DEFAULT_ENABLE_TIME_TO_IDLE_EXPIRATION = false;
	protected static final boolean DEFAULT_USE_PREFIX = true;
	protected static final boolean DO_NOT_CACHE_NULL_VALUES = false;
	protected static final boolean DO_NOT_USE_PREFIX = false;
	protected static final boolean USE_TIME_TO_IDLE_EXPIRATION = true;

	/**
	 * Default {@link RedisCacheConfiguration} using the following:
	 * 

	 * 
key expiration
	 * 
eternal
	 * 
cache null values
	 * 
yes
	 * 
prefix cache keys
	 * 
yes
	 * 
default prefix
	 * 
[the actual cache name]
	 * 
key serializer
	 * 
{@link org.springframework.data.redis.serializer.StringRedisSerializer}
	 * 
value serializer
	 * 
{@link org.springframework.data.redis.serializer.JdkSerializationRedisSerializer}
	 * 
conversion service
	 * 
{@link DefaultFormattingConversionService} with {@link #registerDefaultConverters(ConverterRegistry) default}
	 * cache key converters
	 * 
	 *
	 * @return new {@link RedisCacheConfiguration}.
	 */
	public static RedisCacheConfiguration defaultCacheConfig() {
		return defaultCacheConfig(null);
	}

	/**
	 * Create default {@link RedisCacheConfiguration} given {@link ClassLoader} using the following:
	 * 

	 * 
key expiration
	 * 
eternal
	 * 
cache null values
	 * 
yes
	 * 
prefix cache keys
	 * 
yes
	 * 
default prefix
	 * 
[the actual cache name]
	 * 
key serializer
	 * 
{@link org.springframework.data.redis.serializer.StringRedisSerializer}
	 * 
value serializer
	 * 
{@link org.springframework.data.redis.serializer.JdkSerializationRedisSerializer}
	 * 
conversion service
	 * 
{@link DefaultFormattingConversionService} with {@link #registerDefaultConverters(ConverterRegistry) default}
	 * cache key converters
	 * 
	 *
	 * @param classLoader the {@link ClassLoader} used for deserialization by the
	 *          {@link org.springframework.data.redis.serializer.JdkSerializationRedisSerializer}.
	 * @return new {@link RedisCacheConfiguration}.
	 * @since 2.1
	 */
	public static RedisCacheConfiguration defaultCacheConfig(@Nullable ClassLoader classLoader) {

		DefaultFormattingConversionService conversionService = new DefaultFormattingConversionService();

		registerDefaultConverters(conversionService);

		return new RedisCacheConfiguration(TtlFunction.persistent(),
				DEFAULT_CACHE_NULL_VALUES,
				DEFAULT_ENABLE_TIME_TO_IDLE_EXPIRATION,
				DEFAULT_USE_PREFIX,
				CacheKeyPrefix.simple(),
				SerializationPair.fromSerializer(RedisSerializer.string()),
				SerializationPair.fromSerializer(RedisSerializer.java(classLoader)),
				conversionService);
	}

	private final boolean cacheNullValues;
	private final boolean enableTimeToIdle;
	private final boolean usePrefix;

	private final CacheKeyPrefix keyPrefix;

	private final ConversionService conversionService;

	private final SerializationPair keySerializationPair;
	private final SerializationPair