Rationalize HTTP client configuration properties

Simplify HTTP client configuration properties by sharing common
settings for both blocking and reactive clients.

The `ClientHttpRequestFactorySettings` and `ClientHttpConnectorSettings`
have been merged to a single `HttpClientSettings` class. Properties
to configure common settings are available under:

	`spring.http.clients`

Blocking and reactive settings have been moved to
`spring.http.clients.blocking` and `spring.http.clients.reactive`. With
currently only the factory/connector being configurable.

HTTP Service Client properties have also been rationalized under a
`spring.http.serviceclient.<group-name>`. Support for properties that
apply to all service clients and all Rest/Web Clients have been removed.

Support for `ApiVerionInserter` beans has also been removed in favor of
configuring the service group or builders directly.

Closes gh-47398

Author: philwebb

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/io/rest-client.adoc

@@ -55,29 +55,19 @@ You can learn more about the {url-spring-framework-docs}/web/webflux-webclient/c
 [[io.rest-client.webclient.configuration]]
 === Global HTTP Connector Configuration
 
-If the auto-detected javadoc:org.springframework.http.client.reactive.ClientHttpConnector[] does not meet your needs, you can use the configprop:spring.http.reactiveclient.connector[] property to pick a specific connector.
+If the auto-detected javadoc:org.springframework.http.client.reactive.ClientHttpConnector[] does not meet your needs, you can use the configprop:spring.http.clients.reactive.connector[] property to pick a specific connector.
 For example, if you have Reactor Netty on your classpath, but you prefer Jetty's javadoc:org.eclipse.jetty.client.HttpClient[] you can add the following:
 
 [configprops,yaml]
 ----
 spring:
   http:
-    reactiveclient:
-      connector: jetty
+    clients:
+      reactive:
+        connector: jetty
 ----
 
-You can also set properties to change defaults that will be applied to all reactive connectors.
-For example, you may want to change timeouts and if redirects are followed:
-
-[configprops,yaml]
-----
-spring:
-  http:
-    reactiveclient:
-      connect-timeout: 2s
-      read-timeout: 1s
-      redirects: dont-follow
-----
+TIP: You can also use xref:io/rest-client.adoc#io.rest-client.global-configuration[global configuration properties] which apply to all HTTP clients.
 
 For more complex customizations, you can use javadoc:org.springframework.boot.http.client.autoconfigure.reactive.ClientHttpConnectorBuilderCustomizer[] or declare your own javadoc:org.springframework.boot.http.client.reactive.ClientHttpConnectorBuilder[] bean which will cause auto-configuration to back off.
 This can be useful when you need to customize some of the internals of the underlying HTTP library.
@@ -88,7 +78,6 @@ include-code::MyConnectorHttpConfiguration[]
 
 
 
-
 [[io.rest-client.webclient.customization]]
 === WebClient Customization
 
@@ -246,29 +235,19 @@ If multiple clients are available on the classpath, and not global configuration
 [[io.rest-client.clienthttprequestfactory.configuration]]
 === Global HTTP Client Configuration
 
-If the auto-detected HTTP client does not meet your needs, you can use the configprop:spring.http.client.factory[] property to pick a specific factory.
+If the auto-detected HTTP client does not meet your needs, you can use the configprop:spring.http.clients.blocking.factory[] property to pick a specific factory.
 For example, if you have Apache HttpClient on your classpath, but you prefer Jetty's javadoc:org.eclipse.jetty.client.HttpClient[] you can add the following:
 
 [configprops,yaml]
 ----
 spring:
   http:
-    client:
-      factory: jetty
+    clients:
+      blocking:
+        factory: jetty
 ----
 
-You can also set properties to change defaults that will be applied to all clients.
-For example, you may want to change timeouts and if redirects are followed:
-
-[configprops,yaml]
-----
-spring:
-  http:
-    client:
-      connect-timeout: 2s
-      read-timeout: 1s
-      redirects: dont-follow
-----
+TIP: You can also use xref:io/rest-client.adoc#io.rest-client.global-configuration[global configuration properties] which apply to all HTTP clients.
 
 For more complex customizations, you can use javadoc:org.springframework.boot.http.client.autoconfigure.ClientHttpRequestFactoryBuilderCustomizer[] or declare your own javadoc:org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder[] bean which will cause auto-configuration to back off.
 This can be useful when you need to customize some of the internals of the underlying HTTP library.
@@ -286,23 +265,6 @@ Both `WebClient` and `RestClient` support making versioned remote HTTP calls so
 Commonly this involves sending an HTTP header, a query parameter or URL path segment that indicates the version of the API that should be used.
 
 You can configure API versioning using methods on `WebClient.Builder` or `RestClient.Builder`.
-You can also the `spring.http.reactiveclient.webclient.apiversion` or `spring.http.client.restclient.apiversion` properties if you want to apply the same configuration to all builders.
-
-For example, the following adds an `X-Version` HTTP header to all calls from the `RestClient` and uses the version `1.0.0` unless overridden for specific requests:
-
-[configprops,yaml]
-----
-spring:
-  http:
-    client:
-      restclient:
-        apiversion:
-          default: 1.0.0
-          insert:
-            header: X-Version
-----
-
-You can also define javadoc:org.springframework.web.client.ApiVersionInserter[] and javadoc:org.springframework.web.client.ApiVersionFormatter[] beans if you need more control of the way that version information should be inserted and formatted.
 
 TIP: API versioning is also supported on the server-side.
 See the xref:web/servlet.adoc#web.servlet.spring-mvc.api-versioning[Spring MVC] and xref:web/reactive.adoc#web.reactive.webflux.api-versioning[Spring WebFlux] sections for details.
@@ -363,32 +325,15 @@ We can then write:
 
 include-code::MyApplication[]
 
-And finally we can then use a `base-url` property to link the `echo` group to an actual URL.
-
-For a `RestClient` backed HTTP Service client this would be:
+And finally we can then use a `base-url` property to link the `echo` group to an actual URL:
 
 [configprops,yaml]
 ----
 spring:
   http:
-    client:
-      service:
-        group:
-          echo:
-            base-url: "https://echo.zuplo.io"
-----
-
-For a `WebClient` backed HTTP Service client, we'd use the reactive variant:
-
-[configprops,yaml]
-----
-spring:
-  http:
-    reactiveclient:
-      service:
-        group:
-          echo:
-            base-url: "https://echo.zuplo.io"
+    serviceclient:
+      echo:
+        base-url: "https://echo.zuplo.io"
 ----
 
 TIP: HTTP Service clients will be associated with a group named "`default`" if you don't specify a group.
@@ -408,7 +353,7 @@ include-code::repeat/MyApplication[]
 [[io.rest-client.httpservice.properties]]
 === Configuration Properties
 
-Configuration properties for HTTP Services can be specified under `spring.http.client.service` for `RestClient` backed clients and `spring.http.reactiveclient.service` for `WebClient` backed clients.
+Configuration properties for HTTP Services can be specified under `spring.http.serviceclient.<group-name>`:
 
 You can use properties to configure aspects such as:
 
@@ -419,26 +364,30 @@ You can use properties to configure aspects such as:
 * Connection and read timeouts.
 * SSL bundles to use.
 
-Properties are hierarchical and can be specified per-group, or for all HTTP Service clients.
-Some properties can also be specified as xref:/io/rest-client.adoc#io.rest-client.clienthttprequestfactory.configuration[global client configuration], so that they are considered for both HTTP Service clients and direct use of `RestClient` or `WebClient`.
+TIP: You can also use xref:io/rest-client.adoc#io.rest-client.global-configuration[global configuration properties] which apply to all HTTP clients.
 
 For example, the properties below will:
 
-* Configure all HTTP Service client and `RestClient` beans to use a one second connect timeout (unless otherwise overridden).
-* Configure all HTTP Service clients to use a two second read timeout (unless otherwise overridden).
-* Configure HTTP Service clients in the "`echo`" group to use a specific base URL.
+* Configure all HTTP clients to use a one second connect timeout (unless otherwise overridden).
+* Configure HTTP Service clients in the "`echo`" group to:
+** Use a specific base URL.
+** Have a two second read timeout.
+** Insert API version information using an `X-Version` header.
 
 [configprops,yaml]
 ----
 spring:
   http:
-    client:
+    clients:
       connect-timeout: 1s
-      service:
+    serviceclient:
+      echo:
+        base-url: "https://echo.zuplo.io"
         read-timeout: 2s;
-        group:
-          echo:
-            base-url: "https://echo.zuplo.io"
+        apiversion:
+          default: 1.0.0
+          insert:
+            header: X-Version
 ----
 
 
@@ -466,3 +415,31 @@ You can javadoc:org.springframework.context.annotation.Import[format=annotation]
 For more details, see {url-spring-framework-docs}/integration/rest-clients.html#rest-http-service-client-group-config[Spring Framework reference documentation].
 
 Regardless of which method you use to register HTTP Service clients, Spring Boot's support remains the same.
+
+
+
+[[io.rest-client.global-configuration]]
+== Applying Global Configuration to All HTTP Clients
+
+Regardless of the underlying technology being used, all HTTP clients have common settings that can be configured.
+
+These include:
+
+* Connection Timeouts.
+* Read Timeouts.
+* How HTTP redirects should be handled.
+* Which SSL bundle should be used when connecting.
+
+These common settings are represented by the javadoc:org.springframework.boot.http.client.HttpClientSettings[] class which can be passed into the `build(...)` methods of javadoc:org.springframework.boot.http.client.reactive.ClientHttpConnectorBuilder[] and javadoc:org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder[].
+
+If you want to apply the same configuration to all auto-configured clients, you can use `spring.http.clients` properties to do so:
+
+[configprops,yaml]
+----
+spring:
+  http:
+    clients:
+      connect-timeout: 2s
+      read-timeout: 1s
+      redirects: dont-follow
+----

documentation/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/restclient/restclient/ssl/settings/MyService.java

@@ -19,7 +19,7 @@
 import java.time.Duration;
 
 import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder;
-import org.springframework.boot.http.client.ClientHttpRequestFactorySettings;
+import org.springframework.boot.http.client.HttpClientSettings;
 import org.springframework.boot.ssl.SslBundles;
 import org.springframework.http.client.ClientHttpRequestFactory;
 import org.springframework.stereotype.Service;
@@ -31,8 +31,7 @@ public class MyService {
 	private final RestClient restClient;
 
 	public MyService(RestClient.Builder restClientBuilder, SslBundles sslBundles) {
-		ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings
-			.ofSslBundle(sslBundles.getBundle("mybundle"))
+		HttpClientSettings settings = HttpClientSettings.ofSslBundle(sslBundles.getBundle("mybundle"))
 			.withReadTimeout(Duration.ofMinutes(2));
 		ClientHttpRequestFactory requestFactory = ClientHttpRequestFactoryBuilder.detect().build(settings);
 		this.restClient = restClientBuilder.baseUrl("https://example.org").requestFactory(requestFactory).build();

documentation/spring-boot-docs/src/main/java/org/springframework/boot/docs/io/webservices/template/MyWebServiceTemplateConfiguration.java

@@ -18,7 +18,7 @@
 
 import java.time.Duration;
 
-import org.springframework.boot.http.client.ClientHttpRequestFactorySettings;
+import org.springframework.boot.http.client.HttpClientSettings;
 import org.springframework.boot.webservices.client.WebServiceMessageSenderFactory;
 import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
 import org.springframework.context.annotation.Bean;
@@ -30,7 +30,7 @@ public class MyWebServiceTemplateConfiguration {
 
 	@Bean
 	public WebServiceTemplate webServiceTemplate(WebServiceTemplateBuilder builder) {
-		ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings.defaults()
+		HttpClientSettings settings = HttpClientSettings.defaults()
 			.withConnectTimeout(Duration.ofSeconds(2))
 			.withReadTimeout(Duration.ofSeconds(2));
 		builder.httpMessageSenderFactory(WebServiceMessageSenderFactory.http(settings));

documentation/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/restclient/restclient/ssl/settings/MyService.kt

@@ -17,7 +17,7 @@
 package org.springframework.boot.docs.io.restclient.restclient.ssl.settings
 
 import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder;
-import org.springframework.boot.http.client.ClientHttpRequestFactorySettings;
+import org.springframework.boot.http.client.HttpClientSettings
 import org.springframework.boot.ssl.SslBundles
 import org.springframework.stereotype.Service
 import org.springframework.web.client.RestClient
@@ -29,7 +29,7 @@ class MyService(restClientBuilder: RestClient.Builder, sslBundles: SslBundles) {
 	private val restClient: RestClient
 
 	init {
-		val settings = ClientHttpRequestFactorySettings.defaults()
+		val settings = HttpClientSettings.defaults()
 				.withReadTimeout(Duration.ofMinutes(2))
 				.withSslBundle(sslBundles.getBundle("mybundle"))
 		val requestFactory = ClientHttpRequestFactoryBuilder.detect().build(settings);

documentation/spring-boot-docs/src/main/kotlin/org/springframework/boot/docs/io/webservices/template/MyWebServiceTemplateConfiguration.kt

@@ -16,7 +16,7 @@
 
 package org.springframework.boot.docs.io.webservices.template
 
-import org.springframework.boot.http.client.ClientHttpRequestFactorySettings
+import org.springframework.boot.http.client.HttpClientSettings
 import org.springframework.boot.webservices.client.WebServiceMessageSenderFactory
 import org.springframework.boot.webservices.client.WebServiceTemplateBuilder
 import org.springframework.context.annotation.Bean
@@ -29,7 +29,7 @@ class MyWebServiceTemplateConfiguration {
 
 	@Bean
 	fun webServiceTemplate(builder: WebServiceTemplateBuilder): WebServiceTemplate {
-		val settings = ClientHttpRequestFactorySettings.defaults()
+		val settings = HttpClientSettings.defaults()
 				.withConnectTimeout(Duration.ofSeconds(2))
 				.withReadTimeout(Duration.ofSeconds(2))
 		builder.httpMessageSenderFactory(WebServiceMessageSenderFactory.http(settings))

module/spring-boot-http-client/src/main/java/org/springframework/boot/http/client/AbstractClientHttpRequestFactoryBuilder.java

@@ -26,7 +26,6 @@
 
 import org.springframework.boot.util.LambdaSafe;
 import org.springframework.http.client.ClientHttpRequestFactory;
-import org.springframework.lang.Contract;
 import org.springframework.util.Assert;
 
 /**
@@ -67,20 +66,12 @@ private <E> List<E> merge(Collection<E> list, Collection<? extends E> additional
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public final T build(@Nullable ClientHttpRequestFactorySettings settings) {
-		T factory = createClientHttpRequestFactory(
-				(settings != null) ? settings : ClientHttpRequestFactorySettings.defaults());
+	public final T build(@Nullable HttpClientSettings settings) {
+		T factory = createClientHttpRequestFactory((settings != null) ? settings : HttpClientSettings.defaults());
 		LambdaSafe.callbacks(Consumer.class, this.customizers, factory).invoke((consumer) -> consumer.accept(factory));
 		return factory;
 	}
 
-	protected abstract T createClientHttpRequestFactory(ClientHttpRequestFactorySettings settings);
-
-	@Contract("!null -> !null")
-	protected final @Nullable HttpClientSettings asHttpClientSettings(
-			@Nullable ClientHttpRequestFactorySettings settings) {
-		return (settings != null) ? new HttpClientSettings(settings.redirects(), settings.connectTimeout(),
-				settings.readTimeout(), settings.sslBundle()) : null;
-	}
+	protected abstract T createClientHttpRequestFactory(HttpClientSettings settings);
 
 }

module/spring-boot-http-client/src/main/java/org/springframework/boot/http/client/ClientHttpRequestFactoryBuilder.java

@@ -61,7 +61,7 @@ default T build() {
 	 * @param settings the settings to apply or {@code null}
 	 * @return a fully configured {@link ClientHttpRequestFactory}.
 	 */
-	T build(@Nullable ClientHttpRequestFactorySettings settings);
+	T build(@Nullable HttpClientSettings settings);
 
 	/**
 	 * Return a new {@link ClientHttpRequestFactoryBuilder} that applies the given
@@ -175,7 +175,7 @@ static <T extends ClientHttpRequestFactory> ClientHttpRequestFactoryBuilder<T> o
 
 	/**
 	 * Return a new {@link ClientHttpRequestFactoryBuilder} from the given supplier, using
-	 * reflection to ultimately apply the {@link ClientHttpRequestFactorySettings}.
+	 * reflection to ultimately apply the {@link HttpClientSettings}.
 	 * @param <T> the {@link ClientHttpRequestFactory} type
 	 * @param requestFactorySupplier the {@link ClientHttpRequestFactory} supplier
 	 * @return a new {@link ClientHttpRequestFactoryBuilder}