Polish CacheManagerCustomizers

philwebb · philwebb · commit 4fd778fed8ff · 2016-02-25T20:05:16.000-08:00
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -66,7 +66,7 @@
 @EnableConfigurationProperties(CacheProperties.class)
 @AutoConfigureBefore(HibernateJpaAutoConfiguration.class)
 @AutoConfigureAfter({ HazelcastAutoConfiguration.class, RedisAutoConfiguration.class })
-@Import({ CacheManagerCustomizerInvoker.class, CacheConfigurationImportSelector.class })
+@Import({ CacheManagerCustomizers.class, CacheConfigurationImportSelector.class })
 public class CacheAutoConfiguration {
 
 	static final String VALIDATOR_BEAN_NAME = "cacheAutoConfigurationValidator";
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizer.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizer.java
@@ -22,16 +22,16 @@
  * Callback interface that can be implemented by beans wishing to customize the cache
  * manager before it is fully initialized, in particular to tune its configuration.
  *
- * @param <C> The type of the {@link CacheManager}
+ * @param <T> The type of the {@link CacheManager}
  * @author Stephane Nicoll
  * @since 1.3.3
  */
-public interface CacheManagerCustomizer<C extends CacheManager> {
+public interface CacheManagerCustomizer<T extends CacheManager> {
 
 	/**
 	 * Customize the cache manager.
 	 * @param cacheManager the {@code CacheManager} to customize
 	 */
-	void customize(C cacheManager);
+	void customize(T cacheManager);
 
 }
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizers.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizers.java
@@ -17,9 +17,9 @@
 package org.springframework.boot.autoconfigure.cache;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanFactoryUtils;
@@ -31,12 +31,12 @@
 import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 
 /**
- * Invoke the available {@link CacheManagerCustomizer} instances in the context for a
+ * Invokes the available {@link CacheManagerCustomizer} instances in the context for a
  * given {@link CacheManager}.
  *
  * @author Stephane Nicoll
  */
-class CacheManagerCustomizerInvoker implements ApplicationContextAware {
+class CacheManagerCustomizers implements ApplicationContextAware {
 
 	private ConfigurableApplicationContext applicationContext;
 
@@ -45,14 +45,16 @@ class CacheManagerCustomizerInvoker implements ApplicationContextAware {
 	 * {@link CacheManagerCustomizer} beans able to handle the specified instance and
 	 * invoke {@link CacheManagerCustomizer#customize(CacheManager)} on them.
 	 * @param cacheManager the cache manager to customize
+	 * @return the cache manager
 	 */
-	public void customize(CacheManager cacheManager) {
+	public <T extends CacheManager> T customize(T cacheManager) {
 		List<CacheManagerCustomizer<CacheManager>> customizers = findCustomizers(
 				cacheManager);
 		AnnotationAwareOrderComparator.sort(customizers);
 		for (CacheManagerCustomizer<CacheManager> customizer : customizers) {
 			customizer.customize(cacheManager);
 		}
+		return cacheManager;
 	}
 
 	@SuppressWarnings({ "unchecked", "rawtypes" })
@@ -61,20 +63,28 @@ private List<CacheManagerCustomizer<CacheManager>> findCustomizers(
 		if (this.applicationContext == null) {
 			return Collections.emptyList();
 		}
-		Map<String, CacheManagerCustomizer> map = BeanFactoryUtils
-				.beansOfTypeIncludingAncestors(this.applicationContext.getBeanFactory(),
-						CacheManagerCustomizer.class);
+		Class<?> cacheManagerClass = cacheManager.getClass();
 		List<CacheManagerCustomizer<CacheManager>> customizers = new ArrayList<CacheManagerCustomizer<CacheManager>>();
-		for (CacheManagerCustomizer customizer : map.values()) {
-			Class<?> target = GenericTypeResolver.resolveTypeArgument(
-					customizer.getClass(), CacheManagerCustomizer.class);
-			if (target == null || target.isAssignableFrom(cacheManager.getClass())) {
+		for (CacheManagerCustomizer customizer : getBeans(CacheManagerCustomizer.class)) {
+			if (canCustomize(customizer, cacheManagerClass)) {
 				customizers.add(customizer);
 			}
 		}
 		return customizers;
 	}
 
+	private <T> Collection<T> getBeans(Class<T> type) {
+		return BeanFactoryUtils.beansOfTypeIncludingAncestors(
+				this.applicationContext.getBeanFactory(), type).values();
+	}
+
+	private boolean canCustomize(CacheManagerCustomizer<?> customizer,
+			Class<?> cacheManagerClass) {
+		Class<?> target = GenericTypeResolver.resolveTypeArgument(customizer.getClass(),
+				CacheManagerCustomizer.class);
+		return (target == null || target.isAssignableFrom(cacheManagerClass));
+	}
+
 	@Override
 	public void setApplicationContext(ApplicationContext applicationContext)
 			throws BeansException {
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/EhCacheCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/EhCacheCacheConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -49,13 +49,11 @@ class EhCacheCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizers;
 
 	@Bean
 	public EhCacheCacheManager cacheManager(CacheManager ehCacheCacheManager) {
-		EhCacheCacheManager cacheManager = new EhCacheCacheManager(ehCacheCacheManager);
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizers.customize(new EhCacheCacheManager(ehCacheCacheManager));
 	}
 
 	@Bean
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GenericCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GenericCacheConfiguration.java
@@ -42,14 +42,13 @@
 class GenericCacheConfiguration {
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizers;
 
 	@Bean
 	public SimpleCacheManager cacheManager(Collection<Cache> caches) {
 		SimpleCacheManager cacheManager = new SimpleCacheManager();
 		cacheManager.setCaches(caches);
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizers.customize(cacheManager);
 	}
 
 }
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GuavaCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/GuavaCacheConfiguration.java
@@ -49,7 +49,7 @@ class GuavaCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizers;
 
 	@Autowired(required = false)
 	private CacheBuilder<Object, Object> cacheBuilder;
@@ -67,8 +67,7 @@ public GuavaCacheManager cacheManager() {
 		if (!CollectionUtils.isEmpty(cacheNames)) {
 			cacheManager.setCacheNames(cacheNames);
 		}
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizers.customize(cacheManager);
 	}
 
 	private GuavaCacheManager createCacheManager() {
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/HazelcastInstanceConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/HazelcastInstanceConfiguration.java
@@ -49,7 +49,7 @@ static class Existing {
 		private CacheProperties cacheProperties;
 
 		@Autowired
-		CacheManagerCustomizerInvoker customizerInvoker;
+		private CacheManagerCustomizers customizers;
 
 		@Bean
 		public HazelcastCacheManager cacheManager(
@@ -63,8 +63,7 @@ public HazelcastCacheManager cacheManager(
 			}
 			HazelcastCacheManager cacheManager = new HazelcastCacheManager(
 					existingHazelcastInstance);
-			this.customizerInvoker.customize(cacheManager);
-			return cacheManager;
+			return this.customizers.customize(cacheManager);
 		}
 	}
 
@@ -77,7 +76,7 @@ static class Specific {
 		private CacheProperties cacheProperties;
 
 		@Autowired
-		CacheManagerCustomizerInvoker customizerInvoker;
+		private CacheManagerCustomizers customizers;
 
 		@Bean
 		public HazelcastInstance hazelcastInstance() throws IOException {
@@ -93,8 +92,7 @@ public HazelcastInstance hazelcastInstance() throws IOException {
 		public HazelcastCacheManager cacheManager() throws IOException {
 			HazelcastCacheManager cacheManager = new HazelcastCacheManager(
 					hazelcastInstance());
-			this.customizerInvoker.customize(cacheManager);
-			return cacheManager;
+			return this.customizers.customize(cacheManager);
 		}
 
 	}
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/InfinispanCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/InfinispanCacheConfiguration.java
@@ -52,7 +52,7 @@ public class InfinispanCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizers;
 
 	@Autowired(required = false)
 	private ConfigurationBuilder defaultConfigurationBuilder;
@@ -62,8 +62,7 @@ public SpringEmbeddedCacheManager cacheManager(
 			EmbeddedCacheManager embeddedCacheManager) {
 		SpringEmbeddedCacheManager cacheManager = new SpringEmbeddedCacheManager(
 				embeddedCacheManager);
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizers.customize(cacheManager);
 	}
 
 	@Bean(destroyMethod = "stop")
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/JCacheCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/JCacheCacheConfiguration.java
@@ -64,7 +64,7 @@ class JCacheCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizers;
 
 	@Autowired(required = false)
 	private javax.cache.configuration.Configuration<?, ?> defaultCacheConfiguration;
@@ -75,8 +75,7 @@ class JCacheCacheConfiguration {
 	@Bean
 	public JCacheCacheManager cacheManager(CacheManager jCacheCacheManager) {
 		JCacheCacheManager cacheManager = new JCacheCacheManager(jCacheCacheManager);
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizers.customize(cacheManager);
 	}
 
 	@Bean
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/RedisCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/RedisCacheConfiguration.java
@@ -47,7 +47,7 @@ class RedisCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizerInvoker;
 
 	@Bean
 	public RedisCacheManager cacheManager(RedisTemplate<Object, Object> redisTemplate) {
@@ -56,8 +56,7 @@ public RedisCacheManager cacheManager(RedisTemplate<Object, Object> redisTemplat
 		if (!cacheNames.isEmpty()) {
 			cacheManager.setCacheNames(cacheNames);
 		}
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizerInvoker.customize(cacheManager);
 	}
 
 }
diff --git a/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/SimpleCacheConfiguration.java b/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/SimpleCacheConfiguration.java
@@ -41,7 +41,7 @@ class SimpleCacheConfiguration {
 	private CacheProperties cacheProperties;
 
 	@Autowired
-	CacheManagerCustomizerInvoker customizerInvoker;
+	private CacheManagerCustomizers customizerInvoker;
 
 	@Bean
 	public ConcurrentMapCacheManager cacheManager() {
@@ -50,8 +50,7 @@ public ConcurrentMapCacheManager cacheManager() {
 		if (!cacheNames.isEmpty()) {
 			cacheManager.setCacheNames(cacheNames);
 		}
-		this.customizerInvoker.customize(cacheManager);
-		return cacheManager;
+		return this.customizerInvoker.customize(cacheManager);
 	}
 
 }
diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfigurationTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfigurationTests.java
@@ -473,7 +473,8 @@ public void hazelcastAsJCacheWithCaches() {
 			load(DefaultCacheConfiguration.class, "spring.cache.type=jcache",
 					"spring.cache.jcache.provider=" + cachingProviderFqn,
 					"spring.cache.cacheNames[0]=foo", "spring.cache.cacheNames[1]=bar");
-			JCacheCacheManager cacheManager = validateCacheManager(JCacheCacheManager.class);
+			JCacheCacheManager cacheManager = validateCacheManager(
+					JCacheCacheManager.class);
 			assertThat(cacheManager.getCacheNames(), containsInAnyOrder("foo", "bar"));
 			assertThat(cacheManager.getCacheNames(), hasSize(2));
 		}
@@ -921,18 +922,19 @@ public CacheManagerCustomizer<GuavaCacheManager> guavaCacheManagerCustomizer() {
 
 	}
 
-	static abstract class CacheManagerTestCustomizer<C extends CacheManager>
-			implements CacheManagerCustomizer<C> {
+	static abstract class CacheManagerTestCustomizer<T extends CacheManager>
+			implements CacheManagerCustomizer<T> {
 
-		private C cacheManager;
+		private T cacheManager;
 
 		@Override
-		public void customize(C cacheManager) {
+		public void customize(T cacheManager) {
 			if (this.cacheManager != null) {
 				throw new IllegalStateException("Customized invoked twice");
 			}
 			this.cacheManager = cacheManager;
 		}
+
 	}
 
 }
diff --git a/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizersTests.java b/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/cache/CacheManagerCustomizersTests.java
@@ -40,7 +40,7 @@
  *
  * @author Stephane Nicoll
  */
-public class CacheManagerCustomizerInvokerTests {
+public class CacheManagerCustomizersTests {
 
 	private AnnotationConfigApplicationContext context;
 
@@ -62,7 +62,7 @@ public void customizeSimpleCacheManager() {
 
 	@Test
 	public void customizeNoConfigurableApplicationContext() {
-		CacheManagerCustomizerInvoker invoker = new CacheManagerCustomizerInvoker();
+		CacheManagerCustomizers invoker = new CacheManagerCustomizers();
 		ApplicationContext context = mock(ApplicationContext.class);
 		invoker.setApplicationContext(context);
 		invoker.customize(mock(CacheManager.class));
@@ -85,11 +85,14 @@ static class SimpleConfiguration {
 		@Bean
 		public CacheManagerCustomizer<ConcurrentMapCacheManager> cacheManagerCustomizer() {
 			return new CacheManagerCustomizer<ConcurrentMapCacheManager>() {
+
 				@Override
 				public void customize(ConcurrentMapCacheManager cacheManager) {
 					cacheManager.setCacheNames(Arrays.asList("one", "two"));
 				}
+
 			};
 		}
+
 	}
 }
diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
@@ -3209,6 +3209,7 @@ as you want and you can also order them as usual using `@Order` or `Ordered`.
 ===
 
 
+
 [[boot-features-caching-provider-generic]]
 ==== Generic
 Generic caching is used if the context defines _at least_ one

Original file line number	Diff line number	Diff line change
`@@ -42,14 +42,13 @@`
`42`	`42`	`class GenericCacheConfiguration {`
`43`	`43`
`44`	`44`	`@Autowired`
`45`		`- CacheManagerCustomizerInvoker customizerInvoker;`
	`45`	`+ private CacheManagerCustomizers customizers;`
`46`	`46`
`47`	`47`	`@Bean`
`48`	`48`	`public SimpleCacheManager cacheManager(Collection<Cache> caches) {`
`49`	`49`	`SimpleCacheManager cacheManager = new SimpleCacheManager();`
`50`	`50`	`cacheManager.setCaches(caches);`
`51`		`- this.customizerInvoker.customize(cacheManager);`
`52`		`- return cacheManager;`
	`51`	`+ return this.customizers.customize(cacheManager);`
`53`	`52`	`}`
`54`	`53`
`55`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ static class Existing {`
`49`	`49`	`private CacheProperties cacheProperties;`
`50`	`50`
`51`	`51`	`@Autowired`
`52`		`- CacheManagerCustomizerInvoker customizerInvoker;`
	`52`	`+ private CacheManagerCustomizers customizers;`
`53`	`53`
`54`	`54`	`@Bean`
`55`	`55`	`public HazelcastCacheManager cacheManager(`
`@@ -63,8 +63,7 @@ public HazelcastCacheManager cacheManager(`
`63`	`63`	`}`
`64`	`64`	`HazelcastCacheManager cacheManager = new HazelcastCacheManager(`
`65`	`65`	`existingHazelcastInstance);`
`66`		`- this.customizerInvoker.customize(cacheManager);`
`67`		`- return cacheManager;`
	`66`	`+ return this.customizers.customize(cacheManager);`
`68`	`67`	`}`
`69`	`68`	`}`
`70`	`69`
`@@ -77,7 +76,7 @@ static class Specific {`
`77`	`76`	`private CacheProperties cacheProperties;`
`78`	`77`
`79`	`78`	`@Autowired`
`80`		`- CacheManagerCustomizerInvoker customizerInvoker;`
	`79`	`+ private CacheManagerCustomizers customizers;`
`81`	`80`
`82`	`81`	`@Bean`
`83`	`82`	`public HazelcastInstance hazelcastInstance() throws IOException {`
`@@ -93,8 +92,7 @@ public HazelcastInstance hazelcastInstance() throws IOException {`
`93`	`92`	`public HazelcastCacheManager cacheManager() throws IOException {`
`94`	`93`	`HazelcastCacheManager cacheManager = new HazelcastCacheManager(`
`95`	`94`	`hazelcastInstance());`
`96`		`- this.customizerInvoker.customize(cacheManager);`
`97`		`- return cacheManager;`
	`95`	`+ return this.customizers.customize(cacheManager);`
`98`	`96`	`}`
`99`	`97`
`100`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class RedisCacheConfiguration {`
`47`	`47`	`private CacheProperties cacheProperties;`
`48`	`48`
`49`	`49`	`@Autowired`
`50`		`- CacheManagerCustomizerInvoker customizerInvoker;`
	`50`	`+ private CacheManagerCustomizers customizerInvoker;`
`51`	`51`
`52`	`52`	`@Bean`
`53`	`53`	`public RedisCacheManager cacheManager(RedisTemplate<Object, Object> redisTemplate) {`
`@@ -56,8 +56,7 @@ public RedisCacheManager cacheManager(RedisTemplate<Object, Object> redisTemplat`
`56`	`56`	`if (!cacheNames.isEmpty()) {`
`57`	`57`	`cacheManager.setCacheNames(cacheNames);`
`58`	`58`	`}`
`59`		`- this.customizerInvoker.customize(cacheManager);`
`60`		`- return cacheManager;`
	`59`	`+ return this.customizerInvoker.customize(cacheManager);`
`61`	`60`	`}`
`62`	`61`
`63`	`62`	`}`