Merge pull request #30478 from mdeinum:http-client

* gh-30478:
  Polishing external contribution
  HttpClient based ClientHttpRequestFactory

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

@@ -0,0 +1,134 @@
+/*
+ * Copyright 2023-2023 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.io.InputStream;
+import java.io.UncheckedIOException;
+import java.net.URI;
+import java.net.http.HttpClient;
+import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+import java.nio.ByteBuffer;
+import java.util.List;
+import java.util.concurrent.Executor;
+import java.util.concurrent.Flow;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.lang.Nullable;
+import org.springframework.util.StreamUtils;
+
+/**
+ * {@link ClientHttpRequest} implementation based the Java {@link HttpClient}.
+ * Created via the {@link JdkClientHttpRequestFactory}.
+ *
+ * @author Marten Deinum
+ * @author Arjen Poutsma
+ * @since 6.1
+ */
+class JdkClientHttpRequest extends AbstractStreamingClientHttpRequest {
+
+	/*
+	 * The JDK HttpRequest doesn't allow all headers to be set. The named headers are taken from the default
+	 * implementation for HttpRequest.
+	 */
+	private static final List<String> DISALLOWED_HEADERS =
+			List.of("connection", "content-length", "expect", "host", "upgrade");
+
+	private final HttpClient httpClient;
+
+	private final HttpMethod method;
+
+	private final URI uri;
+
+	private final Executor executor;
+
+
+	public JdkClientHttpRequest(HttpClient httpClient, URI uri, HttpMethod method, Executor executor) {
+		this.httpClient = httpClient;
+		this.uri = uri;
+		this.method = method;
+		this.executor = executor;
+	}
+
+	@Override
+	public HttpMethod getMethod() {
+		return this.method;
+	}
+
+	@Override
+	public URI getURI() {
+		return this.uri;
+	}
+
+
+	@Override
+	protected ClientHttpResponse executeInternal(HttpHeaders headers, @Nullable Body body) throws IOException {
+		try {
+			HttpRequest request = buildRequest(headers, body);
+			HttpResponse<InputStream> response = this.httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream());
+			return new JdkClientHttpResponse(response);
+		}
+		catch (UncheckedIOException ex) {
+			throw ex.getCause();
+		}
+		catch (InterruptedException ex) {
+			Thread.currentThread().interrupt();
+			throw new IOException("Could not send request: " + ex.getMessage(), ex);
+		}
+	}
+
+
+	private HttpRequest buildRequest(HttpHeaders headers, @Nullable Body body) {
+		HttpRequest.Builder builder = HttpRequest.newBuilder()
+				.uri(this.uri);
+
+		headers.forEach((headerName, headerValues) -> {
+			if (!headerName.equalsIgnoreCase(HttpHeaders.CONTENT_LENGTH)) {
+				if (!DISALLOWED_HEADERS.contains(headerName.toLowerCase())) {
+					for (String headerValue : headerValues) {
+						builder.header(headerName, headerValue);
+					}
+				}
+			}
+		});
+
+		builder.method(this.method.name(), bodyPublisher(headers, body));
+		return builder.build();
+	}
+
+	private HttpRequest.BodyPublisher bodyPublisher(HttpHeaders headers, @Nullable Body body) {
+		if (body != null) {
+			Flow.Publisher<ByteBuffer> outputStreamPublisher = OutputStreamPublisher.create(
+					outputStream -> body.writeTo(StreamUtils.nonClosing(outputStream)),
+					this.executor);
+
+			long contentLength = headers.getContentLength();
+			if (contentLength != -1) {
+				return HttpRequest.BodyPublishers.fromPublisher(outputStreamPublisher, contentLength);
+			}
+			else {
+				return HttpRequest.BodyPublishers.fromPublisher(outputStreamPublisher);
+			}
+		}
+		else {
+			return HttpRequest.BodyPublishers.noBody();
+		}
+	}
+
+}

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

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2023-2023 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.net.http.HttpClient;
+import java.util.concurrent.Executor;
+
+import org.springframework.core.task.SimpleAsyncTaskExecutor;
+import org.springframework.http.HttpMethod;
+import org.springframework.util.Assert;
+
+
+/**
+ * {@link ClientHttpRequestFactory} implementation based on the Java
+ * {@link HttpClient}.
+ *
+ * @author Marten Deinum
+ * @author Arjen Poutsma
+ * @since 6.1
+ */
+public class JdkClientHttpRequestFactory implements ClientHttpRequestFactory {
+
+	private final HttpClient httpClient;
+
+	private final Executor executor;
+
+
+	/**
+	 * Create a new instance of the {@code JdkClientHttpRequestFactory}
+	 * with a default {@link HttpClient}.
+	 */
+	public JdkClientHttpRequestFactory() {
+		this(HttpClient.newHttpClient());
+	}
+
+	/**
+	 * Create a new instance of the {@code JdkClientHttpRequestFactory} based on
+	 * the given {@link HttpClient}.
+	 * @param httpClient the client to base on
+	 */
+	public JdkClientHttpRequestFactory(HttpClient httpClient) {
+		Assert.notNull(httpClient, "HttpClient is required");
+		this.httpClient = httpClient;
+		this.executor = httpClient.executor().orElseGet(SimpleAsyncTaskExecutor::new);
+	}
+
+	/**
+	 * Create a new instance of the {@code JdkClientHttpRequestFactory} based on
+	 * the given {@link HttpClient} and {@link Executor}.
+	 * @param httpClient the client to base on
+	 * @param executor the executor to use for blocking write operations
+	 */
+	public JdkClientHttpRequestFactory(HttpClient httpClient, Executor executor) {
+		Assert.notNull(httpClient, "HttpClient is required");
+		Assert.notNull(executor, "Executor must not be null");
+		this.httpClient = httpClient;
+		this.executor = executor;
+	}
+
+
+	@Override
+	public ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod) throws IOException {
+		return new JdkClientHttpRequest(this.httpClient, uri, httpMethod, this.executor);
+	}
+
+}

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

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2023-2023 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.io.InputStream;
+import java.net.http.HttpClient;
+import java.net.http.HttpResponse;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.LinkedCaseInsensitiveMap;
+import org.springframework.util.MultiValueMap;
+import org.springframework.util.StreamUtils;
+
+/**
+ * {@link ClientHttpResponse} implementation based on the Java {@link HttpClient}.
+ *
+ * @author Marten Deinum
+ * @author Arjen Poutsma
+ * @since 6.1
+ */
+class JdkClientHttpResponse implements ClientHttpResponse {
+
+	private final HttpResponse<InputStream> response;
+
+	private final HttpHeaders headers;
+
+	private final InputStream body;
+
+
+	public JdkClientHttpResponse(HttpResponse<InputStream> response) {
+		this.response = response;
+		this.headers = adaptHeaders(response);
+		InputStream inputStream = response.body();
+		this.body = (inputStream != null) ? inputStream : InputStream.nullInputStream();
+	}
+
+	private static HttpHeaders adaptHeaders(HttpResponse<?> response) {
+		Map<String, List<String>> rawHeaders = response.headers().map();
+		Map<String, List<String>> map = new LinkedCaseInsensitiveMap<>(rawHeaders.size(), Locale.ENGLISH);
+		MultiValueMap<String, String> multiValueMap = CollectionUtils.toMultiValueMap(map);
+		multiValueMap.putAll(rawHeaders);
+		return HttpHeaders.readOnlyHttpHeaders(multiValueMap);
+	}
+
+
+	@Override
+	public HttpStatusCode getStatusCode() {
+		return HttpStatusCode.valueOf(this.response.statusCode());
+	}
+
+	@Override
+	public String getStatusText() {
+		// HttpResponse does not expose status text
+		if (getStatusCode() instanceof HttpStatus status) {
+			return status.getReasonPhrase();
+		}
+		else {
+			return "";
+		}
+	}
+
+	@Override
+	public HttpHeaders getHeaders() {
+		return this.headers;
+	}
+
+	@Override
+	public InputStream getBody() throws IOException {
+		return this.body;
+	}
+
+	@Override
+	public void close() {
+		try {
+			try {
+				StreamUtils.drain(this.body);
+			}
+			finally {
+				this.body.close();
+			}
+		}
+		catch (IOException ignored) {
+		}
+	}
+}