Polish "Improve cache auto-configuration for Redis"

Closes gh-10944

Author: snicoll

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java

@@ -16,7 +16,6 @@
 
 package org.springframework.boot.autoconfigure.cache;
 
-import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
@@ -242,25 +241,22 @@ public void setConfig(Resource config) {
 	}
 
 	/**
-	 * Redis-specific cache properties. Properties set will be used as the defaults for
-	 * all Redis caches.
+	 * Redis-specific cache properties.
 	 */
 	public static class Redis {
 
 		/**
-		 * Specifies the TTL (ultimately converted to seconds) for keys written to Redis.
-		 * By default, entries do not expire, and a value of {@link Duration#ZERO} disables the TTL.
+		 * Entry expiration in milliseconds. By default the entries never expire.
 		 */
-		private Duration ttl = Duration.ZERO;
+		private long timeToLive = 0;
 
 		/**
-		 * Whether to allow caching of {@literal null} values.
+		 * Allow caching null values.
 		 */
 		private boolean cacheNullValues = true;
 
 		/**
-		 * Specifies an override for the default Redis key prefix. A value of {@literal null} results
-		 * in usage of the default key prefix.
+		 * Key prefix.
 		 */
 		private String keyPrefix;
 
@@ -269,41 +265,38 @@ public static class Redis {
 		 */
 		private boolean useKeyPrefix = true;
 
-		public Duration getTtl() {
-			return this.ttl;
+		public long getTimeToLive() {
+			return this.timeToLive;
 		}
 
-		public Redis setTtl(Duration ttl) {
-			this.ttl = ttl;
-			return this;
+		public void setTimeToLive(long timeToLive) {
+			this.timeToLive = timeToLive;
 		}
 
 		public boolean isCacheNullValues() {
 			return this.cacheNullValues;
 		}
 
-		public Redis setCacheNullValues(boolean cacheNullValues) {
+		public void setCacheNullValues(boolean cacheNullValues) {
 			this.cacheNullValues = cacheNullValues;
-			return this;
 		}
 
 		public String getKeyPrefix() {
 			return this.keyPrefix;
 		}
 
-		public Redis setKeyPrefix(String keyPrefix) {
+		public void setKeyPrefix(String keyPrefix) {
 			this.keyPrefix = keyPrefix;
-			return this;
 		}
 
 		public boolean isUseKeyPrefix() {
 			return this.useKeyPrefix;
 		}
 
-		public Redis setUseKeyPrefix(boolean useKeyPrefix) {
+		public void setUseKeyPrefix(boolean useKeyPrefix) {
 			this.useKeyPrefix = useKeyPrefix;
-			return this;
 		}
+
 	}
 
 }

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/RedisCacheConfiguration.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.autoconfigure.cache;
 
+import java.time.Duration;
 import java.util.LinkedHashSet;
 import java.util.List;
 
@@ -69,24 +70,19 @@ public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFact
 	}
 
 	private org.springframework.data.redis.cache.RedisCacheConfiguration getConfiguration() {
-
 		Redis redisProperties = this.cacheProperties.getRedis();
-
 		org.springframework.data.redis.cache.RedisCacheConfiguration config = org.springframework.data.redis.cache.RedisCacheConfiguration
-				.defaultCacheConfig().entryTtl(redisProperties.getTtl());
-
+				.defaultCacheConfig();
+		config = config.entryTtl(Duration.ofMillis(redisProperties.getTimeToLive()));
 		if (redisProperties.getKeyPrefix() != null) {
 			config = config.prefixKeysWith(redisProperties.getKeyPrefix());
 		}
-
 		if (!redisProperties.isCacheNullValues()) {
 			config = config.disableCachingNullValues();
 		}
-
 		if (!redisProperties.isUseKeyPrefix()) {
 			config = config.disableKeyPrefix();
 		}
-
 		return config;
 	}
 

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfigurationTests.java

@@ -282,24 +282,22 @@ public void couchbaseCacheExplicitWithTtl() {
 	public void redisCacheExplicit() {
 		this.contextRunner.withUserConfiguration(RedisCacheConfiguration.class)
 				.withPropertyValues("spring.cache.type=redis",
-						"spring.cache.redis.ttl=PT15M",
+						"spring.cache.redis.time-to-live=15000",
+						"spring.cache.redis.cacheNullValues=false",
 						"spring.cache.redis.keyPrefix=foo",
-						"spring.cache.redis.useKeyPrefix=false",
-						"spring.cache.redis.cacheNullValues=false")
+						"spring.cache.redis.useKeyPrefix=false")
 				.run((context) -> {
 					RedisCacheManager cacheManager = getCacheManager(context,
 							RedisCacheManager.class);
 					assertThat(cacheManager.getCacheNames()).isEmpty();
-
 					org.springframework.data.redis.cache.RedisCacheConfiguration redisCacheConfiguration = (org.springframework.data.redis.cache.RedisCacheConfiguration) new DirectFieldAccessor(
 							cacheManager).getPropertyValue("defaultCacheConfig");
-
-					assertThat(redisCacheConfiguration.usePrefix()).isFalse();
-					assertThat(redisCacheConfiguration.getKeyPrefix()).contains("foo");
 					assertThat(redisCacheConfiguration.getTtl())
-							.isEqualTo(java.time.Duration.ofMinutes(15));
+							.isEqualTo(java.time.Duration.ofSeconds(15));
 					assertThat(redisCacheConfiguration.getAllowCacheNullValues())
 							.isFalse();
+					assertThat(redisCacheConfiguration.getKeyPrefix()).contains("foo");
+					assertThat(redisCacheConfiguration.usePrefix()).isFalse();
 				});
 	}
 
@@ -321,15 +319,14 @@ public void redisCacheExplicitWithCaches() {
 					RedisCacheManager cacheManager = getCacheManager(context,
 							RedisCacheManager.class);
 					assertThat(cacheManager.getCacheNames()).containsOnly("foo", "bar");
-
 					org.springframework.data.redis.cache.RedisCacheConfiguration redisCacheConfiguration = (org.springframework.data.redis.cache.RedisCacheConfiguration) new DirectFieldAccessor(
 							cacheManager).getPropertyValue("defaultCacheConfig");
-					assertThat(redisCacheConfiguration.usePrefix()).isTrue();
-					assertThat(redisCacheConfiguration.getKeyPrefix()).isEmpty();
 					assertThat(redisCacheConfiguration.getTtl())
 							.isEqualTo(java.time.Duration.ofMinutes(0));
 					assertThat(redisCacheConfiguration.getAllowCacheNullValues())
 							.isTrue();
+					assertThat(redisCacheConfiguration.getKeyPrefix()).isEmpty();
+					assertThat(redisCacheConfiguration.usePrefix()).isTrue();
 				});
 	}
 

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -77,6 +77,10 @@ content into your application; rather pick only the properties that you need.
 	spring.cache.infinispan.config= # The location of the configuration file to use to initialize Infinispan.
 	spring.cache.jcache.config= # The location of the configuration file to use to initialize the cache manager.
 	spring.cache.jcache.provider= # Fully qualified name of the CachingProvider implementation to use to retrieve the JSR-107 compliant cache manager. Only needed if more than one JSR-107 implementation is available on the classpath.
+	spring.cache.redis.cache-null-values=true # Allow caching null values.
+	spring.cache.redis.key-prefix= # Key prefix.
+	spring.cache.redis.time-to-live=0 # Entry expiration in milliseconds. By default the entries never expire.
+	spring.cache.redis.use-key-prefix=true # Whether to use the key prefix when writing to Redis.
 	spring.cache.type= # Cache type, auto-detected according to the environment by default.
 
 	# SPRING CONFIG - using environment property only ({sc-spring-boot}/context/config/ConfigFileApplicationListener.{sc-ext}[ConfigFileApplicationListener])

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

@@ -4546,9 +4546,17 @@ This sample configuration reuses the `Cluster` that was created via auto-configu
 
 [[boot-features-caching-provider-redis]]
 ==== Redis
-If Redis is available and configured, the `RedisCacheManager` is auto-configured. It is
-also possible to create additional caches on startup by setting the
-`spring.cache.cache-names` property.
+If Redis is available and configured, a `RedisCacheManager` is auto-configured. It is
+possible to create additional caches on startup by setting the
+`spring.cache.cache-names` property and cache defaults can be configured using
+`spring.redis.cache.*` properties. For instance, the following configuration creates
+`cache1` and `cache2` caches with a _time to live_ of 10 minutes:
+
+[source,properties,indent=0]
+----
+    spring.cache.cache-names=cache1,cache2
+	spring.cache.redis.time-to-live=600000
+----
 
 [NOTE]
 ====