Polish contribution

Closes gh-4903

spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CacheStatisticsAutoConfiguration.java

@@ -76,17 +76,6 @@ public class CacheStatisticsAutoConfiguration {
 
 	}
 
-	@Configuration
-	@ConditionalOnClass({ Caffeine.class, CaffeineCacheManager.class })
-	static class CaffeineCacheStatisticsProviderConfiguration {
-
-		@Bean
-		public CaffeineCacheStatisticsProvider caffeineCacheStatisticsProvider() {
-			return new CaffeineCacheStatisticsProvider();
-		}
-
-	}
-
 	@Configuration
 	@ConditionalOnClass({ EhCacheCache.class, Ehcache.class, StatisticsGateway.class })
 	static class EhCacheCacheStatisticsProviderConfiguration {
@@ -119,6 +108,17 @@ public class CacheStatisticsAutoConfiguration {
 
 	}
 
+	@Configuration
+	@ConditionalOnClass({ Caffeine.class, CaffeineCacheManager.class })
+	static class CaffeineCacheStatisticsProviderConfiguration {
+
+		@Bean
+		public CaffeineCacheStatisticsProvider caffeineCacheStatisticsProvider() {
+			return new CaffeineCacheStatisticsProvider();
+		}
+
+	}
+
 	@Configuration
 	@ConditionalOnClass({ com.google.common.cache.Cache.class, GuavaCache.class })
 	static class GuavaCacheStatisticsConfiguration {

spring-boot-actuator/src/test/java/org/springframework/boot/actuate/autoconfigure/CacheStatisticsAutoConfigurationTests.java

@@ -118,6 +118,14 @@ public class CacheStatisticsAutoConfigurationTests {
 		doTestCoreStatistics(provider, true);
 	}
 
+	@Test
+	public void baseCaffeineCacheStatistics() {
+		load(CaffeineCacheConfig.class);
+		CacheStatisticsProvider provider = this.context
+				.getBean("caffeineCacheStatisticsProvider", CacheStatisticsProvider.class);
+		doTestCoreStatistics(provider, true);
+	}
+
 	@Test
 	public void concurrentMapCacheStatistics() {
 		load(ConcurrentMapConfig.class);
@@ -148,14 +156,6 @@ public class CacheStatisticsAutoConfigurationTests {
 		assertCoreStatistics(updatedCacheStatistics, null, null, null);
 	}
 
-	@Test
-	public void caffeineCacheStatistics() {
-		load(CaffeineCacheConfig.class);
-		CacheStatisticsProvider provider = this.context
-				.getBean("caffeineCacheStatisticsProvider", CacheStatisticsProvider.class);
-		doTestCoreStatistics(provider, true);
-	}
-
 	private void doTestCoreStatistics(CacheStatisticsProvider provider,
 			boolean supportSize) {
 		Cache books = getCache("books");

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

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.autoconfigure.cache;
 
+import java.util.List;
+
 import com.github.benmanes.caffeine.cache.CacheLoader;
 import com.github.benmanes.caffeine.cache.Caffeine;
 import com.github.benmanes.caffeine.cache.CaffeineSpec;
@@ -23,10 +25,12 @@ import com.github.benmanes.caffeine.cache.CaffeineSpec;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.cache.CacheManager;
 import org.springframework.cache.caffeine.CaffeineCacheManager;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
 /**
@@ -37,13 +41,16 @@ import org.springframework.util.StringUtils;
  */
 @Configuration
 @ConditionalOnClass({ Caffeine.class, CaffeineCacheManager.class })
-@ConditionalOnMissingBean(org.springframework.cache.CacheManager.class)
+@ConditionalOnMissingBean(CacheManager.class)
 @Conditional({ CacheCondition.class })
 class CaffeineCacheConfiguration {
 
 	@Autowired
 	private CacheProperties cacheProperties;
 
+	@Autowired
+	private CacheManagerCustomizers customizers;
+
 	@Autowired(required = false)
 	private Caffeine<Object, Object> caffeine;
 
@@ -54,27 +61,34 @@ class CaffeineCacheConfiguration {
 	private CacheLoader<Object, Object> cacheLoader;
 
 	@Bean
-	@ConditionalOnMissingBean
 	public CaffeineCacheManager caffeineCacheManager() {
-		CaffeineCacheManager caffeineCacheManager = new CaffeineCacheManager();
-		setCacheBuilder(caffeineCacheManager);
+		CaffeineCacheManager cacheManager = createCacheManager();
+		List<String> cacheNames = this.cacheProperties.getCacheNames();
+		if (!CollectionUtils.isEmpty(cacheNames)) {
+			cacheManager.setCacheNames(cacheNames);
+		}
+		return this.customizers.customize(cacheManager);
+	}
+
+	private CaffeineCacheManager createCacheManager() {
+		CaffeineCacheManager cacheManager = new CaffeineCacheManager();
+		setCacheBuilder(cacheManager);
 		if (this.cacheLoader != null) {
-			caffeineCacheManager.setCacheLoader(this.cacheLoader);
+			cacheManager.setCacheLoader(this.cacheLoader);
 		}
-		caffeineCacheManager.setCacheNames(this.cacheProperties.getCacheNames());
-		return caffeineCacheManager;
+		return cacheManager;
 	}
 
-	private void setCacheBuilder(CaffeineCacheManager caffeineCacheManager) {
+	private void setCacheBuilder(CaffeineCacheManager cacheManager) {
 		String specification = this.cacheProperties.getCaffeine().getSpec();
 		if (StringUtils.hasText(specification)) {
-			caffeineCacheManager.setCaffeine(Caffeine.from(specification));
+			cacheManager.setCacheSpecification(specification);
 		}
 		else if (this.caffeineSpec != null) {
-			caffeineCacheManager.setCaffeine(Caffeine.from(this.caffeineSpec));
+			cacheManager.setCaffeineSpec(this.caffeineSpec);
 		}
 		else if (this.caffeine != null) {
-			caffeineCacheManager.setCaffeine(this.caffeine);
+			cacheManager.setCaffeine(this.caffeine);
 		}
 	}
 

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

@@ -584,45 +584,52 @@ public class CacheAutoConfigurationTests {
 		validateGuavaCacheWithStats();
 	}
 
+	private void validateGuavaCacheWithStats() {
+		GuavaCacheManager cacheManager = validateCacheManager(GuavaCacheManager.class);
+		assertThat(cacheManager.getCacheNames()).containsOnly("foo", "bar");
+		Cache foo = cacheManager.getCache("foo");
+		foo.get("1");
+		assertThat(((GuavaCache) foo).getNativeCache().stats().missCount()).isEqualTo(1L);
+	}
+
 	@Test
-	public void caffeineCacheWithCaches() {
+	public void caffeineCacheWithExplicitCaches() {
 		load(DefaultCacheConfiguration.class, "spring.cache.type=caffeine",
-				"spring.cache.cacheNames[0]=spring", "spring.cache.cacheNames[1]=boot");
+				"spring.cache.cacheNames=foo");
 		CaffeineCacheManager cacheManager = validateCacheManager(
 				CaffeineCacheManager.class);
-		assertThat(cacheManager.getCacheNames()).containsOnly("spring", "boot");
+		assertThat(cacheManager.getCacheNames()).containsOnly("foo");
+		Cache foo = cacheManager.getCache("foo");
+		foo.get("1");
+		// See next tests: no spec given so stats should be disabled
+		assertThat(((CaffeineCache) foo).getNativeCache().stats().missCount()).isEqualTo(0L);
 	}
 
 	@Test
-	public void caffeineCacheNotAllowNullValues() {
-		load(DefaultCacheConfiguration.class, "spring.cache.type=caffeine",
-				"spring.cache.caffeine.allow-null-values=false");
-		CaffeineCacheManager cacheManager = validateCacheManager(
-				CaffeineCacheManager.class);
-		assertThat(cacheManager.isAllowNullValues()).isFalse();
+	public void caffeineCacheWithCustomizers() {
+		testCustomizers(DefaultCacheAndCustomizersConfiguration.class, "caffeine",
+				"allCacheManagerCustomizer", "caffeineCacheManagerCustomizer");
 	}
 
 	@Test
-	public void caffeineCacheWithNullCaches() {
+	public void caffeineCacheWithExplicitCacheBuilder() {
 		load(CaffeineCacheBuilderConfiguration.class, "spring.cache.type=caffeine",
-				"spring.cache.cacheNames[0]=caffeine", "spring.cache.cacheNames[1]=cache");
-		CaffeineCacheManager cacheManager = validateCacheManager(
-				CaffeineCacheManager.class);
-		assertThat(cacheManager.isAllowNullValues()).isTrue();
+				"spring.cache.cacheNames=foo,bar");
+		validateCaffeineCacheWithStats();
 	}
 
 	@Test
 	public void caffeineCacheExplicitWithSpec() {
-		load(DefaultCacheConfiguration.class, "spring.cache.type=caffeine",
-				"spring.cache.caffeine.spec=recordStats", "spring.cache.cacheNames[0]=foo",
-				"spring.cache.cacheNames[1]=bar");
+		load(CaffeineCacheSpecConfiguration.class, "spring.cache.type=caffeine",
+				"spring.cache.cacheNames[0]=foo", "spring.cache.cacheNames[1]=bar");
 		validateCaffeineCacheWithStats();
 	}
 
 	@Test
-	public void caffeineCacheExplicitWithCacheBuilder() {
-		load(CaffeineCacheBuilderConfiguration2.class, "spring.cache.type=caffeine",
-				"spring.cache.cacheNames[0]=foo", "spring.cache.cacheNames[1]=bar");
+	public void caffeineCacheExplicitWithSpecString() {
+		load(DefaultCacheConfiguration.class, "spring.cache.type=caffeine",
+				"spring.cache.caffeine.spec=recordStats", "spring.cache.cacheNames[0]=foo",
+				"spring.cache.cacheNames[1]=bar");
 		validateCaffeineCacheWithStats();
 	}
 
@@ -634,14 +641,6 @@ public class CacheAutoConfigurationTests {
 		assertThat(((CaffeineCache) foo).getNativeCache().stats().missCount()).isEqualTo(1L);
 	}
 
-	private void validateGuavaCacheWithStats() {
-		GuavaCacheManager cacheManager = validateCacheManager(GuavaCacheManager.class);
-		assertThat(cacheManager.getCacheNames()).containsOnly("foo", "bar");
-		Cache foo = cacheManager.getCache("foo");
-		foo.get("1");
-		assertThat(((GuavaCache) foo).getNativeCache().stats().missCount()).isEqualTo(1L);
-	}
-
 	private <T extends CacheManager> T validateCacheManager(Class<T> type) {
 		CacheManager cacheManager = this.context.getBean(CacheManager.class);
 		assertThat(cacheManager).as("Wrong cache manager type").isInstanceOf(type);
@@ -897,14 +896,14 @@ public class CacheAutoConfigurationTests {
 
 		@Bean
 		Caffeine<Object, Object> cacheBuilder() {
-			return Caffeine.newBuilder().maximumSize(10);
+			return Caffeine.newBuilder().recordStats();
 		}
 
 	}
 
 	@Configuration
 	@EnableCaching
-	static class CaffeineCacheBuilderConfiguration2 {
+	static class CaffeineCacheSpecConfiguration {
 
 		@Bean
 		CaffeineSpec caffeineSpec() {
@@ -964,6 +963,12 @@ public class CacheAutoConfigurationTests {
 			};
 		}
 
+		@Bean
+		public CacheManagerCustomizer<CaffeineCacheManager> caffeineCacheManagerCustomizer() {
+			return new CacheManagerTestCustomizer<CaffeineCacheManager>() {
+			};
+		}
+
 	}
 
 	static abstract class CacheManagerTestCustomizer<T extends CacheManager>

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

@@ -3249,6 +3249,7 @@ Spring Boot tries to detect the following providers (in this order):
 * <<boot-features-caching-provider-hazelcast,Hazelcast>>
 * <<boot-features-caching-provider-infinispan,Infinispan>>
 * <<boot-features-caching-provider-redis,Redis>>
+* <<boot-features-caching-provider-caffeine,Caffeine>>
 * <<boot-features-caching-provider-guava,Guava>>
 * <<boot-features-caching-provider-simple,Simple>>
 
@@ -3384,6 +3385,31 @@ recommend to keep this setting enabled if you create your own `RedisCacheManager
 
 
 
+[[boot-features-caching-provider-caffeine]]
+==== Caffeine
+Caffeine is a Java 8 rewrite of Guava’s cache and will supersede the Guava support in
+Spring Boot 2.0. If Caffeine is present, a `CaffeineCacheManager` is auto-configured.
+Caches can be created on startup using the `spring.cache.cache-names` property and
+customized by one of the following (in this order):
+
+1. A cache spec defined by `spring.cache.caffeine.spec`
+2. A `com.github.benmanes.caffeine.cache.CaffeineSpec` bean is defined
+3. A `com.github.benmanes.caffeine.cache.Caffeine` bean is defined
+
+For instance, the following configuration creates a `foo` and `bar` caches with a maximum
+size of 500 and a _time to live_ of 10 minutes
+
+[source,properties,indent=0]
+----
+    spring.cache.cache-names=foo,bar
+	spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s
+----
+
+Besides, if a `com.github.benmanes.caffeine.cache.CacheLoader` bean is defined, it is
+automatically associated to the `CaffeineCacheManager`.
+
+
+
 [[boot-features-caching-provider-guava]]
 ==== Guava
 If Guava is present, a `GuavaCacheManager` is auto-configured. Caches can be created

spring-boot-samples/spring-boot-sample-cache/README.adoc

@@ -84,6 +84,13 @@ a redis instance with the default settings is expected on your local box).
 
 
 
+=== Caffeine
+Simply add the `com.github.ben-manes.caffeine:caffeine` dependency to enable support
+for Caffeine. You can customize how caches are created in different ways, see
+`application.properties` for an example and the documentation for more details.
+
+
+
 === Guava
 Spring Boot does not provide any dependency management for _Guava_ so you'll have to add
 the `com.google.guava:guava` dependency with a version. You can customize how caches are

spring-boot-samples/spring-boot-sample-cache/src/main/resources/application.properties

@@ -10,6 +10,12 @@
 #spring.cache.jcache.config=hazelcast.xml
 
 
+#
+# Caffeine configuration
+#
+#spring.cache.caffeine.spec=maximumSize=200,expireAfterAccess=600s
+
+
 #
 # Guava configuration
 #