diff --git a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulCatalogWatchAutoConfiguration.java b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulCatalogWatchAutoConfiguration.java new file mode 100644 index 00000000..dd21b831 --- /dev/null +++ b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulCatalogWatchAutoConfiguration.java @@ -0,0 +1,64 @@ +/* + * Copyright 2013-2019 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.cloud.consul.discovery; + +import com.ecwid.consul.v1.ConsulClient; + +import org.springframework.beans.factory.annotation.Qualifier; +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.cloud.client.ConditionalOnDiscoveryEnabled; +import org.springframework.cloud.consul.ConditionalOnConsulEnabled; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.scheduling.TaskScheduler; +import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; + +/** + * Auto configuration for the catalog watcher. + * + * @author Tim Ysewyn + */ +@Configuration +@ConditionalOnConsulEnabled +@ConditionalOnProperty( + value = "spring.cloud.consul.discovery.catalog-services-watch.enabled", + matchIfMissing = true) +@ConditionalOnDiscoveryEnabled +@AutoConfigureAfter({ ConsulDiscoveryClientConfiguration.class }) +public class ConsulCatalogWatchAutoConfiguration { + + /** + * Name of the catalog watch task scheduler bean. + */ + public static final String CATALOG_WATCH_TASK_SCHEDULER_NAME = "catalogWatchTaskScheduler"; + + @Bean + @ConditionalOnMissingBean + public ConsulCatalogWatch consulCatalogWatch( + ConsulDiscoveryProperties discoveryProperties, ConsulClient consulClient, + @Qualifier(CATALOG_WATCH_TASK_SCHEDULER_NAME) TaskScheduler taskScheduler) { + return new ConsulCatalogWatch(discoveryProperties, consulClient, taskScheduler); + } + + @Bean(name = CATALOG_WATCH_TASK_SCHEDULER_NAME) + public TaskScheduler catalogWatchTaskScheduler() { + return new ThreadPoolTaskScheduler(); + } + +} diff --git a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientConfiguration.java b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientConfiguration.java index 4fdc23f7..3bd1a52a 100644 --- a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientConfiguration.java +++ b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/discovery/ConsulDiscoveryClientConfiguration.java @@ -18,8 +18,6 @@ package org.springframework.cloud.consul.discovery; import com.ecwid.consul.v1.ConsulClient; -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Qualifier; import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; @@ -31,12 +29,11 @@ import org.springframework.cloud.commons.util.InetUtils; import org.springframework.cloud.consul.ConditionalOnConsulEnabled; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.scheduling.TaskScheduler; -import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler; /** * @author Spencer Gibb * @author Olga Maciaszek-Sharma + * @author Tim Ysewyn */ @Configuration @ConditionalOnConsulEnabled @@ -50,59 +47,22 @@ public class ConsulDiscoveryClientConfiguration { /** * Name of the catalog watch task scheduler bean. + * @Deprecated Moved to {@link ConsulCatalogWatchAutoConfiguration}. */ - public static final String CATALOG_WATCH_TASK_SCHEDULER_NAME = "catalogWatchTaskScheduler"; - - @Autowired - private ConsulClient consulClient; + @Deprecated + public static final String CATALOG_WATCH_TASK_SCHEDULER_NAME = ConsulCatalogWatchAutoConfiguration.CATALOG_WATCH_TASK_SCHEDULER_NAME; @Bean @ConditionalOnMissingBean - @ConditionalOnProperty("spring.cloud.consul.discovery.heartbeat.enabled") - // TODO: move to service-registry for Edgware - public TtlScheduler ttlScheduler(HeartbeatProperties heartbeatProperties) { - return new TtlScheduler(heartbeatProperties, this.consulClient); - } - - @Bean - @ConditionalOnMissingBean - // TODO: move to service-registry for Edgware - public HeartbeatProperties heartbeatProperties() { - return new HeartbeatProperties(); - } - - @Bean - @ConditionalOnMissingBean - // TODO: Split appropriate values to service-registry for Edgware public ConsulDiscoveryProperties consulDiscoveryProperties(InetUtils inetUtils) { return new ConsulDiscoveryProperties(inetUtils); } @Bean @ConditionalOnMissingBean - public ConsulDiscoveryClient consulDiscoveryClient( + public ConsulDiscoveryClient consulDiscoveryClient(ConsulClient consulClient, ConsulDiscoveryProperties discoveryProperties) { - return new ConsulDiscoveryClient(this.consulClient, discoveryProperties); - } - - @Bean - @ConditionalOnMissingBean - @ConditionalOnProperty( - name = "spring.cloud.consul.discovery.catalog-services-watch.enabled", - matchIfMissing = true) - public ConsulCatalogWatch consulCatalogWatch( - ConsulDiscoveryProperties discoveryProperties, - @Qualifier(CATALOG_WATCH_TASK_SCHEDULER_NAME) TaskScheduler taskScheduler) { - return new ConsulCatalogWatch(discoveryProperties, this.consulClient, - taskScheduler); - } - - @Bean(name = CATALOG_WATCH_TASK_SCHEDULER_NAME) - @ConditionalOnProperty( - name = "spring.cloud.consul.discovery.catalog-services-watch.enabled", - matchIfMissing = true) - public TaskScheduler catalogWatchTaskScheduler() { - return new ThreadPoolTaskScheduler(); + return new ConsulDiscoveryClient(consulClient, discoveryProperties); } } diff --git a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryAutoConfiguration.java b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryAutoConfiguration.java index 8e0f881e..c81e13bf 100644 --- a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryAutoConfiguration.java +++ b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryAutoConfiguration.java @@ -33,6 +33,7 @@ import org.springframework.context.annotation.Configuration; /** * @author Spencer Gibb + * @author Tim Ysewyn */ @Configuration @ConditionalOnConsulEnabled @@ -41,26 +42,15 @@ import org.springframework.context.annotation.Configuration; @AutoConfigureBefore(ServiceRegistryAutoConfiguration.class) public class ConsulServiceRegistryAutoConfiguration { - @Autowired(required = false) - private TtlScheduler ttlScheduler; - @Bean @ConditionalOnMissingBean public ConsulServiceRegistry consulServiceRegistry(ConsulClient consulClient, - ConsulDiscoveryProperties properties, - HeartbeatProperties heartbeatProperties) { - return new ConsulServiceRegistry(consulClient, properties, this.ttlScheduler, + ConsulDiscoveryProperties properties, HeartbeatProperties heartbeatProperties, + @Autowired(required = false) TtlScheduler ttlScheduler) { + return new ConsulServiceRegistry(consulClient, properties, ttlScheduler, heartbeatProperties); } - @Bean - @ConditionalOnMissingBean - @ConditionalOnProperty("spring.cloud.consul.discovery.heartbeat.enabled") - public TtlScheduler ttlScheduler(ConsulClient consulClient, - HeartbeatProperties heartbeatProperties) { - return new TtlScheduler(heartbeatProperties, consulClient); - } - @Bean @ConditionalOnMissingBean public HeartbeatProperties heartbeatProperties() { @@ -69,6 +59,7 @@ public class ConsulServiceRegistryAutoConfiguration { @Bean @ConditionalOnMissingBean + // TODO: Split appropriate values to service-registry for Edgware public ConsulDiscoveryProperties consulDiscoveryProperties(InetUtils inetUtils) { return new ConsulDiscoveryProperties(inetUtils); } diff --git a/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/support/ConsulHeartbeatAutoConfiguration.java b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/support/ConsulHeartbeatAutoConfiguration.java new file mode 100644 index 00000000..176adcdc --- /dev/null +++ b/spring-cloud-consul-discovery/src/main/java/org/springframework/cloud/consul/support/ConsulHeartbeatAutoConfiguration.java @@ -0,0 +1,60 @@ +/* + * Copyright 2013-2019 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.cloud.consul.support; + +import com.ecwid.consul.v1.ConsulClient; + +import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.autoconfigure.AutoConfigureBefore; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.cloud.client.ConditionalOnDiscoveryEnabled; +import org.springframework.cloud.consul.ConditionalOnConsulEnabled; +import org.springframework.cloud.consul.discovery.ConsulDiscoveryClientConfiguration; +import org.springframework.cloud.consul.discovery.HeartbeatProperties; +import org.springframework.cloud.consul.discovery.TtlScheduler; +import org.springframework.cloud.consul.serviceregistry.ConsulServiceRegistryAutoConfiguration; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +/** + * Auto configuration for the heartbeat. + * + * @author Tim Ysewyn + */ +@Configuration +@ConditionalOnConsulEnabled +@ConditionalOnProperty("spring.cloud.consul.discovery.heartbeat.enabled") +@ConditionalOnDiscoveryEnabled +@AutoConfigureBefore({ ConsulServiceRegistryAutoConfiguration.class }) +@AutoConfigureAfter({ ConsulDiscoveryClientConfiguration.class }) +public class ConsulHeartbeatAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public HeartbeatProperties heartbeatProperties() { + return new HeartbeatProperties(); + } + + @Bean + @ConditionalOnMissingBean + public TtlScheduler ttlScheduler(HeartbeatProperties heartbeatProperties, + ConsulClient consulClient) { + return new TtlScheduler(heartbeatProperties, consulClient); + } + +} diff --git a/spring-cloud-consul-discovery/src/main/resources/META-INF/spring.factories b/spring-cloud-consul-discovery/src/main/resources/META-INF/spring.factories index bb5f5e48..11abf200 100644 --- a/spring-cloud-consul-discovery/src/main/resources/META-INF/spring.factories +++ b/spring-cloud-consul-discovery/src/main/resources/META-INF/spring.factories @@ -3,7 +3,9 @@ org.springframework.cloud.consul.discovery.RibbonConsulAutoConfiguration,\ org.springframework.cloud.consul.discovery.configclient.ConsulConfigServerAutoConfiguration,\ org.springframework.cloud.consul.serviceregistry.ConsulAutoServiceRegistrationAutoConfiguration,\ org.springframework.cloud.consul.serviceregistry.ConsulServiceRegistryAutoConfiguration,\ -org.springframework.cloud.consul.discovery.ConsulDiscoveryClientConfiguration +org.springframework.cloud.consul.discovery.ConsulDiscoveryClientConfiguration,\ +org.springframework.cloud.consul.discovery.ConsulCatalogWatchAutoConfiguration, \ +org.springframework.cloud.consul.support.ConsulHeartbeatAutoConfiguration org.springframework.cloud.bootstrap.BootstrapConfiguration=\ org.springframework.cloud.consul.discovery.configclient.ConsulDiscoveryClientConfigServiceBootstrapConfiguration diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerRemoveTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerRemoveTests.java index e4300863..81f60403 100644 --- a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerRemoveTests.java +++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerRemoveTests.java @@ -30,6 +30,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.consul.ConsulAutoConfiguration; +import org.springframework.cloud.consul.support.ConsulHeartbeatAutoConfiguration; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.test.context.junit4.SpringRunner; @@ -84,7 +85,8 @@ public class TtlSchedulerRemoveTests { @Configuration @EnableAutoConfiguration @Import({ AutoServiceRegistrationConfiguration.class, ConsulAutoConfiguration.class, - ConsulDiscoveryClientConfiguration.class }) + ConsulDiscoveryClientConfiguration.class, + ConsulHeartbeatAutoConfiguration.class }) public static class TtlSchedulerRemoveTestConfig { } diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerTests.java index d28cf7b6..b123ee8c 100644 --- a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerTests.java +++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/discovery/TtlSchedulerTests.java @@ -30,6 +30,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.consul.ConsulAutoConfiguration; +import org.springframework.cloud.consul.support.ConsulHeartbeatAutoConfiguration; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Import; import org.springframework.test.context.junit4.SpringRunner; @@ -81,7 +82,8 @@ public class TtlSchedulerTests { @Configuration @EnableAutoConfiguration @Import({ AutoServiceRegistrationConfiguration.class, ConsulAutoConfiguration.class, - ConsulDiscoveryClientConfiguration.class }) + ConsulDiscoveryClientConfiguration.class, + ConsulHeartbeatAutoConfiguration.class }) public static class TtlSchedulerTestConfig { } diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulAutoRegistrationCheckTtlDeregisterCriticalServiceTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulAutoRegistrationCheckTtlDeregisterCriticalServiceTests.java index 8fcebad4..bf197275 100644 --- a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulAutoRegistrationCheckTtlDeregisterCriticalServiceTests.java +++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulAutoRegistrationCheckTtlDeregisterCriticalServiceTests.java @@ -26,6 +26,7 @@ import org.springframework.boot.autoconfigure.ImportAutoConfiguration; import org.springframework.boot.test.context.SpringBootTest; import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration; import org.springframework.cloud.consul.ConsulAutoConfiguration; +import org.springframework.cloud.consul.support.ConsulHeartbeatAutoConfiguration; import org.springframework.context.annotation.Configuration; import org.springframework.test.context.junit4.SpringRunner; @@ -59,7 +60,8 @@ public class ConsulAutoRegistrationCheckTtlDeregisterCriticalServiceTests { @EnableAutoConfiguration @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, ConsulAutoConfiguration.class, - ConsulAutoServiceRegistrationAutoConfiguration.class }) + ConsulAutoServiceRegistrationAutoConfiguration.class, + ConsulHeartbeatAutoConfiguration.class }) protected static class TestConfig { } diff --git a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryCheckTtlTests.java b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryCheckTtlTests.java index 824be1c2..63061e3d 100644 --- a/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryCheckTtlTests.java +++ b/spring-cloud-consul-discovery/src/test/java/org/springframework/cloud/consul/serviceregistry/ConsulServiceRegistryCheckTtlTests.java @@ -32,6 +32,7 @@ import org.springframework.cloud.client.serviceregistry.AutoServiceRegistrationC import org.springframework.cloud.consul.ConsulAutoConfiguration; import org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties; import org.springframework.cloud.consul.discovery.TtlScheduler; +import org.springframework.cloud.consul.support.ConsulHeartbeatAutoConfiguration; import org.springframework.context.annotation.Configuration; import org.springframework.test.context.junit4.SpringRunner; @@ -97,7 +98,8 @@ public class ConsulServiceRegistryCheckTtlTests { @EnableAutoConfiguration @ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class, ConsulAutoConfiguration.class, - ConsulAutoServiceRegistrationAutoConfiguration.class }) + ConsulAutoServiceRegistrationAutoConfiguration.class, + ConsulHeartbeatAutoConfiguration.class }) protected static class TestConfig { }