Add support for configuring RestTemplate via RestTemplateBuilder (#4255…

…) (#4262)
spring-cloud · Mar 26, 2024 · 6b6173d · 6b6173d
1 parent 4536954
commit 6b6173d
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 13 deletions.
diff --git a/...springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java b/...springframework/cloud/netflix/eureka/config/DiscoveryClientOptionalArgsConfiguration.java
@@ -34,6 +34,7 @@
 import org.springframework.boot.autoconfigure.condition.SearchStrategy;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.cloud.configuration.SSLContextFactory;
 import org.springframework.cloud.configuration.TlsProperties;
 import org.springframework.cloud.netflix.eureka.RestTemplateTimeoutProperties;
@@ -69,11 +70,11 @@ public TlsProperties tlsProperties() {
 	@ConditionalOnProperty(prefix = "eureka.client", name = "webclient.enabled", matchIfMissing = true,
 			havingValue = "false")
 	public RestTemplateDiscoveryClientOptionalArgs restTemplateDiscoveryClientOptionalArgs(TlsProperties tlsProperties,
-			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier)
-			throws GeneralSecurityException, IOException {
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier,
+			ObjectProvider<RestTemplateBuilder> restTemplateBuilders) throws GeneralSecurityException, IOException {
 		logger.info("Eureka HTTP Client uses RestTemplate.");
 		RestTemplateDiscoveryClientOptionalArgs result = new RestTemplateDiscoveryClientOptionalArgs(
-				eurekaClientHttpRequestFactorySupplier);
+				eurekaClientHttpRequestFactorySupplier, restTemplateBuilders::getIfAvailable);
 		setupTLS(result, tlsProperties);
 		return result;
 	}

diff --git a/...springframework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfiguration.java b/...springframework/cloud/netflix/eureka/config/EurekaConfigServerBootstrapConfiguration.java
@@ -29,6 +29,7 @@
 import org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration;
 import org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.cloud.config.client.ConfigServerInstanceProvider;
 import org.springframework.cloud.config.client.ConfigServicePropertySourceLocator;
 import org.springframework.cloud.configuration.TlsProperties;
@@ -71,9 +72,10 @@ public EurekaClientConfigBean eurekaClientConfigBean() {
 			havingValue = "false")
 	public RestTemplateEurekaHttpClient configDiscoveryRestTemplateEurekaHttpClient(EurekaClientConfigBean config,
 			Environment env, @Nullable TlsProperties properties,
-			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier,
+			ObjectProvider<RestTemplateBuilder> restTemplateBuilders) {
 		return (RestTemplateEurekaHttpClient) new RestTemplateTransportClientFactory(properties,
-				eurekaClientHttpRequestFactorySupplier)
+				eurekaClientHttpRequestFactorySupplier, restTemplateBuilders::getIfAvailable)
 						.newClient(HostnameBasedUrlRandomizer.randomEndpoint(config, env));
 	}
 

diff --git a/...rg/springframework/cloud/netflix/eureka/http/RestTemplateDiscoveryClientOptionalArgs.java b/...rg/springframework/cloud/netflix/eureka/http/RestTemplateDiscoveryClientOptionalArgs.java
@@ -16,18 +16,31 @@
 
 package org.springframework.cloud.netflix.eureka.http;
 
+import java.util.function.Supplier;
+
 import com.netflix.discovery.AbstractDiscoveryClientOptionalArgs;
 
+import org.springframework.boot.web.client.RestTemplateBuilder;
+
 /**
  * @author Daniel Lavoie
  */
 public class RestTemplateDiscoveryClientOptionalArgs extends AbstractDiscoveryClientOptionalArgs<Void> {
 
 	protected final EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier;
 
+	protected final Supplier<RestTemplateBuilder> restTemplateBuilderSupplier;
+
 	public RestTemplateDiscoveryClientOptionalArgs(
 			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+		this(eurekaClientHttpRequestFactorySupplier, RestTemplateBuilder::new);
+	}
+
+	public RestTemplateDiscoveryClientOptionalArgs(
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier,
+			Supplier<RestTemplateBuilder> restTemplateBuilderSupplier) {
 		this.eurekaClientHttpRequestFactorySupplier = eurekaClientHttpRequestFactorySupplier;
+		this.restTemplateBuilderSupplier = restTemplateBuilderSupplier;
 	}
 
 }
diff --git a/...a/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactories.java b/...a/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactories.java
@@ -42,15 +42,15 @@ public RestTemplateTransportClientFactories(RestTemplateDiscoveryClientOptionalA
 	public TransportClientFactory newTransportClientFactory(EurekaClientConfig clientConfig,
 			Collection<Void> additionalFilters, InstanceInfo myInstanceInfo) {
 		return new RestTemplateTransportClientFactory(this.args.getSSLContext(), this.args.getHostnameVerifier(),
-				this.args.eurekaClientHttpRequestFactorySupplier);
+				this.args.eurekaClientHttpRequestFactorySupplier, this.args.restTemplateBuilderSupplier);
 	}
 
 	@Override
 	public TransportClientFactory newTransportClientFactory(final EurekaClientConfig clientConfig,
 			final Collection<Void> additionalFilters, final InstanceInfo myInstanceInfo,
 			final Optional<SSLContext> sslContext, final Optional<HostnameVerifier> hostnameVerifier) {
 		return new RestTemplateTransportClientFactory(this.args.getSSLContext(), this.args.getHostnameVerifier(),
-				this.args.eurekaClientHttpRequestFactorySupplier);
+				this.args.eurekaClientHttpRequestFactorySupplier, this.args.restTemplateBuilderSupplier);
 	}
 
 }
diff --git a/...ava/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactory.java b/...ava/org/springframework/cloud/netflix/eureka/http/RestTemplateTransportClientFactory.java
@@ -21,6 +21,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.Optional;
+import java.util.function.Supplier;
 
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
@@ -44,6 +45,7 @@
 import com.netflix.discovery.shared.transport.EurekaHttpClient;
 import com.netflix.discovery.shared.transport.TransportClientFactory;
 
+import org.springframework.boot.web.client.RestTemplateBuilder;
 import org.springframework.cloud.configuration.SSLContextFactory;
 import org.springframework.cloud.configuration.TlsProperties;
 import org.springframework.http.HttpHeaders;
@@ -72,11 +74,20 @@ public class RestTemplateTransportClientFactory implements TransportClientFactor
 
 	private final EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier;
 
+	private final Supplier<RestTemplateBuilder> restTemplateBuilderSupplier;
+
 	public RestTemplateTransportClientFactory(TlsProperties tlsProperties,
-			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier,
+			Supplier<RestTemplateBuilder> restTemplateBuilderSupplier) {
 		this.sslContext = context(tlsProperties);
 		this.hostnameVerifier = Optional.empty();
 		this.eurekaClientHttpRequestFactorySupplier = eurekaClientHttpRequestFactorySupplier;
+		this.restTemplateBuilderSupplier = restTemplateBuilderSupplier;
+	}
+
+	public RestTemplateTransportClientFactory(TlsProperties tlsProperties,
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+		this(tlsProperties, eurekaClientHttpRequestFactorySupplier, RestTemplateBuilder::new);
 	}
 
 	private Optional<SSLContext> context(TlsProperties properties) {
@@ -93,16 +104,23 @@ private Optional<SSLContext> context(TlsProperties properties) {
 
 	public RestTemplateTransportClientFactory(Optional<SSLContext> sslContext,
 			Optional<HostnameVerifier> hostnameVerifier,
-			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier,
+			Supplier<RestTemplateBuilder> restTemplateBuilderSupplier) {
 		this.sslContext = sslContext;
 		this.hostnameVerifier = hostnameVerifier;
 		this.eurekaClientHttpRequestFactorySupplier = eurekaClientHttpRequestFactorySupplier;
+		this.restTemplateBuilderSupplier = restTemplateBuilderSupplier;
+	}
+
+	public RestTemplateTransportClientFactory(Optional<SSLContext> sslContext,
+			Optional<HostnameVerifier> hostnameVerifier,
+			EurekaClientHttpRequestFactorySupplier eurekaClientHttpRequestFactorySupplier) {
+
+		this(sslContext, hostnameVerifier, eurekaClientHttpRequestFactorySupplier, RestTemplateBuilder::new);
 	}
 
 	public RestTemplateTransportClientFactory() {
-		this.sslContext = Optional.empty();
-		this.hostnameVerifier = Optional.empty();
-		this.eurekaClientHttpRequestFactorySupplier = new DefaultEurekaClientHttpRequestFactorySupplier();
+		this(Optional.empty(), Optional.empty(), new DefaultEurekaClientHttpRequestFactorySupplier());
 	}
 
 	@Override
@@ -120,7 +138,15 @@ private String stripUserInfo(String serviceUrl) {
 	private RestTemplate restTemplate(String serviceUrl) {
 		ClientHttpRequestFactory requestFactory = this.eurekaClientHttpRequestFactorySupplier
 				.get(this.sslContext.orElse(null), this.hostnameVerifier.orElse(null));
-		RestTemplate restTemplate = new RestTemplate(requestFactory);
+
+		RestTemplate restTemplate;
+
+		if (restTemplateBuilderSupplier != null && restTemplateBuilderSupplier.get() != null) {
+			restTemplate = restTemplateBuilderSupplier.get().requestFactory(() -> requestFactory).build();
+		}
+		else {
+			restTemplate = new RestTemplate(requestFactory);
+		}
 
 		try {
 			URI serviceURI = new URI(serviceUrl);