Harmonize Reactor client class names within the http.client package

Closes gh-33382

Author: jhoeller

spring-web/src/main/java/org/springframework/http/client/ReactorNettyClientRequest.java renamed to spring-web/src/main/java/org/springframework/http/client/ReactorClientHttpRequest.java

@@ -39,13 +39,13 @@
 
 /**
  * {@link ClientHttpRequest} implementation for the Reactor-Netty HTTP client.
- * Created via the {@link ReactorNettyClientRequestFactory}.
+ * Created via the {@link ReactorClientHttpRequestFactory}.
  *
  * @author Arjen Poutsma
  * @author Juergen Hoeller
  * @since 6.1
  */
-final class ReactorNettyClientRequest extends AbstractStreamingClientHttpRequest {
+final class ReactorClientHttpRequest extends AbstractStreamingClientHttpRequest {
 
 	private final HttpClient httpClient;
 
@@ -58,8 +58,8 @@ final class ReactorNettyClientRequest extends AbstractStreamingClientHttpRequest
 	private final Duration readTimeout;
 
 
-	public ReactorNettyClientRequest(HttpClient httpClient, URI uri, HttpMethod method,
-			Duration exchangeTimeout, Duration readTimeout) {
+	public ReactorClientHttpRequest(HttpClient httpClient, URI uri, HttpMethod method,
+									Duration exchangeTimeout, Duration readTimeout) {
 
 		this.httpClient = httpClient;
 		this.method = method;
@@ -88,10 +88,10 @@ protected ClientHttpResponse executeInternal(HttpHeaders headers, @Nullable Body
 		requestSender = (this.uri.isAbsolute() ? requestSender.uri(this.uri) : requestSender.uri(this.uri.toString()));
 
 		try {
-			ReactorNettyClientResponse result = requestSender.send((reactorRequest, nettyOutbound) ->
+			ReactorClientHttpResponse result = requestSender.send((reactorRequest, nettyOutbound) ->
 					send(headers, body, reactorRequest, nettyOutbound))
 					.responseConnection((reactorResponse, connection) ->
-							Mono.just(new ReactorNettyClientResponse(reactorResponse, connection, this.readTimeout)))
+							Mono.just(new ReactorClientHttpResponse(reactorResponse, connection, this.readTimeout)))
 					.next()
 					.block(this.exchangeTimeout);
 

spring-web/src/main/java/org/springframework/http/client/ReactorClientHttpRequestFactory.java

@@ -0,0 +1,244 @@
+/*
+ * Copyright 2002-2024 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.http.client;
+
+import java.io.IOException;
+import java.net.URI;
+import java.time.Duration;
+import java.util.function.Function;
+
+import io.netty.channel.ChannelOption;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import reactor.netty.http.client.HttpClient;
+import reactor.netty.resources.ConnectionProvider;
+import reactor.netty.resources.LoopResources;
+
+import org.springframework.context.SmartLifecycle;
+import org.springframework.http.HttpMethod;
+import org.springframework.lang.Nullable;
+import org.springframework.util.Assert;
+
+/**
+ * Reactor-Netty implementation of {@link ClientHttpRequestFactory}.
+ *
+ * <p>This class implements {@link SmartLifecycle} and can be optionally declared
+ * as a Spring-managed bean in order to support JVM Checkpoint Restore.
+ *
+ * @author Arjen Poutsma
+ * @author Juergen Hoeller
+ * @author Sebastien Deleuze
+ * @since 6.2
+ */
+public class ReactorClientHttpRequestFactory implements ClientHttpRequestFactory, SmartLifecycle {
+
+	private static final Log logger = LogFactory.getLog(ReactorClientHttpRequestFactory.class);
+
+	private static final Function<HttpClient, HttpClient> defaultInitializer = client -> client.compress(true);
+
+
+	@Nullable
+	private final ReactorResourceFactory resourceFactory;
+
+	@Nullable
+	private final Function<HttpClient, HttpClient> mapper;
+
+	@Nullable
+	private Integer connectTimeout;
+
+	private Duration readTimeout = Duration.ofSeconds(10);
+
+	private Duration exchangeTimeout = Duration.ofSeconds(5);
+
+	@Nullable
+	private volatile HttpClient httpClient;
+
+	private final Object lifecycleMonitor = new Object();
+
+
+	/**
+	 * Create a new instance of the {@code ReactorClientHttpRequestFactory}
+	 * with a default {@link HttpClient} that has compression enabled.
+	 */
+	public ReactorClientHttpRequestFactory() {
+		this.httpClient = defaultInitializer.apply(HttpClient.create());
+		this.resourceFactory = null;
+		this.mapper = null;
+	}
+
+	/**
+	 * Create a new instance of the {@code ReactorClientHttpRequestFactory}
+	 * based on the given {@link HttpClient}.
+	 * @param httpClient the client to base on
+	 */
+	public ReactorClientHttpRequestFactory(HttpClient httpClient) {
+		Assert.notNull(httpClient, "HttpClient must not be null");
+		this.httpClient = httpClient;
+		this.resourceFactory = null;
+		this.mapper = null;
+	}
+
+	/**
+	 * Constructor with externally managed Reactor Netty resources, including
+	 * {@link LoopResources} for event loop threads, and {@link ConnectionProvider}
+	 * for the connection pool.
+	 * <p>This constructor should be used only when you don't want the client
+	 * to participate in the Reactor Netty global resources. By default the
+	 * client participates in the Reactor Netty global resources held in
+	 * {@link reactor.netty.http.HttpResources}, which is recommended since
+	 * fixed, shared resources are favored for event loop concurrency. However,
+	 * consider declaring a {@link ReactorResourceFactory} bean with
+	 * {@code globalResources=true} in order to ensure the Reactor Netty global
+	 * resources are shut down when the Spring ApplicationContext is stopped or closed
+	 * and restarted properly when the Spring ApplicationContext is
+	 * (with JVM Checkpoint Restore for example).
+	 * @param resourceFactory the resource factory to obtain the resources from
+	 * @param mapper a mapper for further initialization of the created client
+	 */
+	public ReactorClientHttpRequestFactory(ReactorResourceFactory resourceFactory, Function<HttpClient, HttpClient> mapper) {
+		this.resourceFactory = resourceFactory;
+		this.mapper = mapper;
+		if (resourceFactory.isRunning()) {
+			this.httpClient = createHttpClient(resourceFactory, mapper);
+		}
+	}
+
+
+	/**
+	 * Set the underlying connect timeout in milliseconds.
+	 * A value of 0 specifies an infinite timeout.
+	 * <p>Default is 30 seconds.
+	 * @see HttpClient#option(ChannelOption, Object)
+	 * @see ChannelOption#CONNECT_TIMEOUT_MILLIS
+	 */
+	public void setConnectTimeout(int connectTimeout) {
+		Assert.isTrue(connectTimeout >= 0, "Timeout must be a non-negative value");
+		this.connectTimeout = connectTimeout;
+		HttpClient httpClient = this.httpClient;
+		if (httpClient != null) {
+			this.httpClient = httpClient.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, this.connectTimeout);
+		}
+	}
+
+	/**
+	 * Set the underlying connect timeout in milliseconds.
+	 * A value of 0 specifies an infinite timeout.
+	 * <p>Default is 30 seconds.
+	 * @see HttpClient#option(ChannelOption, Object)
+	 * @see ChannelOption#CONNECT_TIMEOUT_MILLIS
+	 */
+	public void setConnectTimeout(Duration connectTimeout) {
+		Assert.notNull(connectTimeout, "ConnectTimeout must not be null");
+		setConnectTimeout((int) connectTimeout.toMillis());
+	}
+
+	/**
+	 * Set the underlying read timeout in milliseconds.
+	 * <p>Default is 10 seconds.
+	 */
+	public void setReadTimeout(long readTimeout) {
+		Assert.isTrue(readTimeout > 0, "Timeout must be a positive value");
+		this.readTimeout = Duration.ofMillis(readTimeout);
+	}
+
+	/**
+	 * Set the underlying read timeout as {@code Duration}.
+	 * <p>Default is 10 seconds.
+	 */
+	public void setReadTimeout(Duration readTimeout) {
+		Assert.notNull(readTimeout, "ReadTimeout must not be null");
+		Assert.isTrue(!readTimeout.isNegative(), "Timeout must be a non-negative value");
+		this.readTimeout = readTimeout;
+	}
+
+	/**
+	 * Set the timeout for the HTTP exchange in milliseconds.
+	 * <p>Default is 5 seconds.
+	 */
+	public void setExchangeTimeout(long exchangeTimeout) {
+		Assert.isTrue(exchangeTimeout > 0, "Timeout must be a positive value");
+		this.exchangeTimeout = Duration.ofMillis(exchangeTimeout);
+	}
+
+	/**
+	 * Set the timeout for the HTTP exchange.
+	 * <p>Default is 5 seconds.
+	 */
+	public void setExchangeTimeout(Duration exchangeTimeout) {
+		Assert.notNull(exchangeTimeout, "ExchangeTimeout must not be null");
+		Assert.isTrue(!exchangeTimeout.isNegative(), "Timeout must be a non-negative value");
+		this.exchangeTimeout = exchangeTimeout;
+	}
+
+	private HttpClient createHttpClient(ReactorResourceFactory factory, Function<HttpClient, HttpClient> mapper) {
+		HttpClient httpClient = defaultInitializer.andThen(mapper)
+				.apply(HttpClient.create(factory.getConnectionProvider()));
+		httpClient = httpClient.runOn(factory.getLoopResources());
+		if (this.connectTimeout != null) {
+			httpClient = httpClient.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, this.connectTimeout);
+		}
+		return httpClient;
+	}
+
+
+	@Override
+	public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException {
+		HttpClient httpClient = this.httpClient;
+		if (httpClient == null) {
+			Assert.state(this.resourceFactory != null && this.mapper != null, "Illegal configuration");
+			httpClient = createHttpClient(this.resourceFactory, this.mapper);
+		}
+		return new ReactorClientHttpRequest(httpClient, uri, httpMethod, this.exchangeTimeout, this.readTimeout);
+	}
+
+
+	@Override
+	public void start() {
+		if (this.resourceFactory != null && this.mapper != null) {
+			synchronized (this.lifecycleMonitor) {
+				if (this.httpClient == null) {
+					this.httpClient = createHttpClient(this.resourceFactory, this.mapper);
+				}
+			}
+		}
+		else {
+			logger.warn("Restarting a ReactorClientHttpRequestFactory bean is only supported " +
+					"with externally managed Reactor Netty resources");
+		}
+	}
+
+	@Override
+	public void stop() {
+		if (this.resourceFactory != null && this.mapper != null) {
+			synchronized (this.lifecycleMonitor) {
+				this.httpClient = null;
+			}
+		}
+	}
+
+	@Override
+	public boolean isRunning() {
+		return (this.httpClient != null);
+	}
+
+	@Override
+	public int getPhase() {
+		// Start after ReactorResourceFactory
+		return 1;
+	}
+
+}

spring-web/src/main/java/org/springframework/http/client/ReactorNettyClientResponse.java renamed to spring-web/src/main/java/org/springframework/http/client/ReactorClientHttpResponse.java

@@ -36,7 +36,7 @@
  * @author Juergen Hoeller
  * @since 6.1
  */
-final class ReactorNettyClientResponse implements ClientHttpResponse {
+final class ReactorClientHttpResponse implements ClientHttpResponse {
 
 	private final HttpClientResponse response;
 
@@ -50,7 +50,7 @@ final class ReactorNettyClientResponse implements ClientHttpResponse {
 	private volatile InputStream body;
 
 
-	public ReactorNettyClientResponse(HttpClientResponse response, Connection connection, Duration readTimeout) {
+	public ReactorClientHttpResponse(HttpClientResponse response, Connection connection, Duration readTimeout) {
 		this.response = response;
 		this.connection = connection;
 		this.readTimeout = readTimeout;
@@ -84,7 +84,7 @@ public InputStream getBody() throws IOException {
 			body = this.connection.inbound().receive().aggregate().asInputStream().block(this.readTimeout);
 		}
 		catch (RuntimeException ex) {
-			throw ReactorNettyClientRequest.convertException(ex);
+			throw ReactorClientHttpRequest.convertException(ex);
 		}
 
 		if (body == null) {