Skip to content

Commit 9273a76

Browse files
wilkinsonawilkinsona
committed
Merge pull request #36116 from poutsma
* gh-36116: Polish "Support Jetty in ClientHttpRequestFactories" Support Jetty in ClientHttpRequestFactories Closes gh-36116
2 parents 2cbd916 + c3e2c9d commit 9273a76

File tree

9 files changed

+127
-18
lines changed

9 files changed

+127
-18
lines changed

‎spring-boot-project/spring-boot-docs/src/docs/asciidoc/io/rest-client.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ In order of preference, the following clients are supported:
2525

2626
. Apache HttpClient
2727
. OkHttp
28+
. Jetty HttpClient
2829
. Simple JDK client (`HttpURLConnection`)
2930

3031
If multiple clients are available on the classpath, the most preferred client will be used.

‎spring-boot-project/spring-boot/build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ dependencies {
6767
optional("org.eclipse.jetty.http2:http2-server") {
6868
exclude(group: "org.eclipse.jetty.toolchain", module: "jetty-jakarta-servlet-api")
6969
}
70+
optional("org.eclipse.jetty:jetty-client")
7071
optional("org.flywaydb:flyway-core")
7172
optional("org.hamcrest:hamcrest-library")
7273
optional("org.hibernate.orm:hibernate-core")

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/client/ClientHttpRequestFactories.java

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import java.util.function.Supplier;
2727

2828
import javax.net.ssl.HttpsURLConnection;
29+
import javax.net.ssl.SSLContext;
2930
import javax.net.ssl.SSLSocketFactory;
3031
import javax.net.ssl.TrustManager;
3132
import javax.net.ssl.X509TrustManager;
@@ -38,13 +39,17 @@
3839
import org.apache.hc.client5.http.ssl.DefaultHostnameVerifier;
3940
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
4041
import org.apache.hc.core5.http.io.SocketConfig;
42+
import org.eclipse.jetty.client.dynamic.HttpClientTransportDynamic;
43+
import org.eclipse.jetty.io.ClientConnector;
44+
import org.eclipse.jetty.util.ssl.SslContextFactory;
4145

4246
import org.springframework.boot.context.properties.PropertyMapper;
4347
import org.springframework.boot.ssl.SslBundle;
4448
import org.springframework.boot.ssl.SslOptions;
4549
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
4650
import org.springframework.http.client.ClientHttpRequestFactory;
4751
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
52+
import org.springframework.http.client.JettyClientHttpRequestFactory;
4853
import org.springframework.http.client.OkHttp3ClientHttpRequestFactory;
4954
import org.springframework.http.client.SimpleClientHttpRequestFactory;
5055
import org.springframework.util.Assert;
@@ -70,6 +75,10 @@ public final class ClientHttpRequestFactories {
7075

7176
private static final boolean OKHTTP_CLIENT_PRESENT = ClassUtils.isPresent(OKHTTP_CLIENT_CLASS, null);
7277

78+
static final String JETTY_CLIENT_CLASS = "org.eclipse.jetty.client.HttpClient";
79+
80+
private static final boolean JETTY_CLIENT_PRESENT = ClassUtils.isPresent(JETTY_CLIENT_CLASS, null);
81+
7382
private ClientHttpRequestFactories() {
7483
}
7584

@@ -87,6 +96,9 @@ public static ClientHttpRequestFactory get(ClientHttpRequestFactorySettings sett
8796
if (OKHTTP_CLIENT_PRESENT) {
8897
return OkHttp.get(settings);
8998
}
99+
if (JETTY_CLIENT_PRESENT) {
100+
return Jetty.get(settings);
101+
}
90102
return Simple.get(settings);
91103
}
92104

@@ -111,6 +123,9 @@ public static <T extends ClientHttpRequestFactory> T get(Class<T> requestFactory
111123
if (requestFactoryType == OkHttp3ClientHttpRequestFactory.class) {
112124
return (T) OkHttp.get(settings);
113125
}
126+
if (requestFactoryType == JettyClientHttpRequestFactory.class) {
127+
return (T) Jetty.get(settings);
128+
}
114129
if (requestFactoryType == SimpleClientHttpRequestFactory.class) {
115130
return (T) Simple.get(settings);
116131
}
@@ -210,6 +225,35 @@ private static OkHttp3ClientHttpRequestFactory createRequestFactory(SslBundle ss
210225

211226
}
212227

228+
/**
229+
* Support for {@link JettyClientHttpRequestFactory}.
230+
*/
231+
static class Jetty {
232+
233+
static JettyClientHttpRequestFactory get(ClientHttpRequestFactorySettings settings) {
234+
JettyClientHttpRequestFactory requestFactory = createRequestFactory(settings.sslBundle());
235+
PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull();
236+
map.from(settings::connectTimeout).asInt(Duration::toMillis).to(requestFactory::setConnectTimeout);
237+
map.from(settings::readTimeout).asInt(Duration::toMillis).to(requestFactory::setReadTimeout);
238+
return requestFactory;
239+
}
240+
241+
private static JettyClientHttpRequestFactory createRequestFactory(SslBundle sslBundle) {
242+
if (sslBundle != null) {
243+
SSLContext sslContext = sslBundle.createSslContext();
244+
SslContextFactory.Client sslContextFactory = new SslContextFactory.Client();
245+
sslContextFactory.setSslContext(sslContext);
246+
ClientConnector connector = new ClientConnector();
247+
connector.setSslContextFactory(sslContextFactory);
248+
org.eclipse.jetty.client.HttpClient httpClient = new org.eclipse.jetty.client.HttpClient(
249+
new HttpClientTransportDynamic(connector));
250+
return new JettyClientHttpRequestFactory(httpClient);
251+
}
252+
return new JettyClientHttpRequestFactory();
253+
}
254+
255+
}
256+
213257
/**
214258
* Support for {@link SimpleClientHttpRequestFactory}.
215259
*/

‎spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/client/ClientHttpRequestFactoriesRuntimeHints.java

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2022 the original author or authors.
2+
* Copyright 2012-2023 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@
2828
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
2929
import org.springframework.http.client.ClientHttpRequestFactory;
3030
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
31+
import org.springframework.http.client.JettyClientHttpRequestFactory;
3132
import org.springframework.http.client.OkHttp3ClientHttpRequestFactory;
3233
import org.springframework.http.client.SimpleClientHttpRequestFactory;
3334
import org.springframework.util.Assert;
@@ -59,6 +60,10 @@ private void registerHints(ReflectionHints hints, ClassLoader classLoader) {
5960
typeHint.onReachableType(TypeReference.of(ClientHttpRequestFactories.OKHTTP_CLIENT_CLASS));
6061
registerReflectionHints(hints, OkHttp3ClientHttpRequestFactory.class);
6162
});
63+
hints.registerTypeIfPresent(classLoader, ClientHttpRequestFactories.JETTY_CLIENT_CLASS, (typeHint) -> {
64+
typeHint.onReachableType(TypeReference.of(ClientHttpRequestFactories.JETTY_CLIENT_CLASS));
65+
registerReflectionHints(hints, JettyClientHttpRequestFactory.class, long.class);
66+
});
6267
hints.registerType(SimpleClientHttpRequestFactory.class, (typeHint) -> {
6368
typeHint.onReachableType(HttpURLConnection.class);
6469
registerReflectionHints(hints, SimpleClientHttpRequestFactory.class);
@@ -67,8 +72,13 @@ private void registerHints(ReflectionHints hints, ClassLoader classLoader) {
6772

6873
private void registerReflectionHints(ReflectionHints hints,
6974
Class<? extends ClientHttpRequestFactory> requestFactoryType) {
75+
registerReflectionHints(hints, requestFactoryType, int.class);
76+
}
77+
78+
private void registerReflectionHints(ReflectionHints hints,
79+
Class<? extends ClientHttpRequestFactory> requestFactoryType, Class<?> readTimeoutType) {
7080
registerMethod(hints, requestFactoryType, "setConnectTimeout", int.class);
71-
registerMethod(hints, requestFactoryType, "setReadTimeout", int.class);
81+
registerMethod(hints, requestFactoryType, "setReadTimeout", readTimeoutType);
7282
}
7383

7484
private void registerMethod(ReflectionHints hints, Class<? extends ClientHttpRequestFactory> requestFactoryType,

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/client/ClientHttpRequestFactoriesJettyTests.java

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* Copyright 2012-2023 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.web.client;
18+
19+
import org.eclipse.jetty.client.HttpClient;
20+
21+
import org.springframework.boot.testsupport.classpath.ClassPathExclusions;
22+
import org.springframework.http.client.JettyClientHttpRequestFactory;
23+
import org.springframework.test.util.ReflectionTestUtils;
24+
25+
/**
26+
* Tests for {@link ClientHttpRequestFactories} when Jetty is the predominant HTTP client.
27+
*
28+
* @author Arjen Poutsma
29+
*/
30+
@ClassPathExclusions({ "httpclient5-*.jar", "okhttp-*.jar" })
31+
class ClientHttpRequestFactoriesJettyTests
32+
extends AbstractClientHttpRequestFactoriesTests<JettyClientHttpRequestFactory> {
33+
34+
ClientHttpRequestFactoriesJettyTests() {
35+
super(JettyClientHttpRequestFactory.class);
36+
}
37+
38+
@Override
39+
protected long connectTimeout(JettyClientHttpRequestFactory requestFactory) {
40+
return ((HttpClient) ReflectionTestUtils.getField(requestFactory, "httpClient")).getConnectTimeout();
41+
}
42+
43+
@Override
44+
protected long readTimeout(JettyClientHttpRequestFactory requestFactory) {
45+
return (long) ReflectionTestUtils.getField(requestFactory, "readTimeout");
46+
}
47+
48+
}

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/client/ClientHttpRequestFactoriesRuntimeHintsTests.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
2727
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
2828
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
29+
import org.springframework.http.client.JettyClientHttpRequestFactory;
2930
import org.springframework.http.client.OkHttp3ClientHttpRequestFactory;
3031
import org.springframework.http.client.SimpleClientHttpRequestFactory;
3132
import org.springframework.util.ReflectionUtils;
@@ -73,6 +74,17 @@ void shouldRegisterOkHttpHints() {
7374
assertThat(hints.reflection().getTypeHint(OkHttp3ClientHttpRequestFactory.class).methods()).hasSize(2);
7475
}
7576

77+
@Test
78+
void shouldRegisterJettyClientHints() {
79+
RuntimeHints hints = new RuntimeHints();
80+
new ClientHttpRequestFactoriesRuntimeHints().registerHints(hints, getClass().getClassLoader());
81+
ReflectionHintsPredicates reflection = RuntimeHintsPredicates.reflection();
82+
assertThat(reflection.onMethod(method(JettyClientHttpRequestFactory.class, "setConnectTimeout", int.class)))
83+
.accepts(hints);
84+
assertThat(reflection.onMethod(method(JettyClientHttpRequestFactory.class, "setReadTimeout", long.class)))
85+
.accepts(hints);
86+
}
87+
7688
@Test
7789
void shouldRegisterSimpleHttpHints() {
7890
RuntimeHints hints = new RuntimeHints();

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/client/ClientHttpRequestFactoriesSimpleTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @author Andy Wilkinson
2828
*/
29-
@ClassPathExclusions({ "httpclient5-*.jar", "okhttp-*.jar" })
29+
@ClassPathExclusions({ "httpclient5-*.jar", "okhttp-*.jar", "jetty-client-*.jar" })
3030
class ClientHttpRequestFactoriesSimpleTests
3131
extends AbstractClientHttpRequestFactoriesTests<SimpleClientHttpRequestFactory> {
3232

‎spring-boot-project/spring-boot/src/test/java/org/springframework/boot/webservices/client/HttpWebServiceMessageSenderBuilderSimpleIntegrationTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* @author Stephane Nicoll
3636
*/
37-
@ClassPathExclusions({ "httpclient5-*.jar", "okhttp*.jar" })
37+
@ClassPathExclusions(files = { "httpclient5-*.jar", "jetty-client-*.jar", "okhttp*.jar" })
3838
class HttpWebServiceMessageSenderBuilderSimpleIntegrationTests {
3939

4040
private final HttpWebServiceMessageSenderBuilder builder = new HttpWebServiceMessageSenderBuilder();

‎spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-jetty/src/test/java/smoketest/jetty/SampleJettyApplicationTests.java

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@
1616

1717
package smoketest.jetty;
1818

19-
import java.io.ByteArrayInputStream;
20-
import java.nio.charset.StandardCharsets;
21-
import java.util.zip.GZIPInputStream;
22-
2319
import org.junit.jupiter.api.Test;
2420
import org.junit.jupiter.api.extension.ExtendWith;
2521
import smoketest.jetty.util.RandomStringUtil;
@@ -35,7 +31,6 @@
3531
import org.springframework.http.HttpMethod;
3632
import org.springframework.http.HttpStatus;
3733
import org.springframework.http.ResponseEntity;
38-
import org.springframework.util.StreamUtils;
3934

4035
import static org.assertj.core.api.Assertions.assertThat;
4136

@@ -65,16 +60,14 @@ void testHome() {
6560
}
6661

6762
@Test
68-
void testCompression() throws Exception {
69-
HttpHeaders requestHeaders = new HttpHeaders();
70-
requestHeaders.set("Accept-Encoding", "gzip");
71-
HttpEntity<?> requestEntity = new HttpEntity<>(requestHeaders);
72-
ResponseEntity<byte[]> entity = this.restTemplate.exchange("/", HttpMethod.GET, requestEntity, byte[].class);
63+
void testCompression() {
64+
// Jetty HttpClient sends Accept-Encoding: gzip by default
65+
ResponseEntity<String> entity = this.restTemplate.getForEntity("/", String.class);
7366
assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
74-
assertThat(entity.getBody()).isNotNull();
75-
try (GZIPInputStream inflater = new GZIPInputStream(new ByteArrayInputStream(entity.getBody()))) {
76-
assertThat(StreamUtils.copyToString(inflater, StandardCharsets.UTF_8)).isEqualTo("Hello World");
77-
}
67+
assertThat(entity.getBody()).isEqualTo("Hello World");
68+
// Jetty HttpClient decodes gzip reponses automatically
69+
// Check that we received a gzip-encoded response
70+
assertThat(entity.getHeaders().getFirst(HttpHeaders.CONTENT_ENCODING)).isEqualTo("gzip");
7871
}
7972

8073
@Test

0 commit comments

Comments
 (0)