Add Builder to HttpServiceProxyFactory

rstoyanchev · rstoyanchev · commit 5cb3af708c91 · 2022-10-17T12:23:58.000+01:00
HttpServiceProxyFactory now support programmatic initialization through a builder, while bean-style initialization is deprecated. See gh-29296
diff --git a/spring-web/src/main/java/org/springframework/web/service/invoker/HttpServiceProxyFactory.java b/spring-web/src/main/java/org/springframework/web/service/invoker/HttpServiceProxyFactory.java
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/CookieValueArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/CookieValueArgumentResolverTests.java
@@ -42,8 +42,7 @@ class CookieValueArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/HttpMethodArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/HttpMethodArgumentResolverTests.java
@@ -43,7 +43,7 @@ public class HttpMethodArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		proxyFactory.afterPropertiesSet();
 		this.service = proxyFactory.createClient(Service.class);
 	}
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/HttpServiceMethodTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/HttpServiceMethodTests.java
@@ -64,7 +64,7 @@ public class HttpServiceMethodTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		this.proxyFactory = new HttpServiceProxyFactory(this.client);
+		this.proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.proxyFactory.afterPropertiesSet();
 	}
 
@@ -174,10 +174,10 @@ void methodAnnotatedService() {
 	}
 
 	@Test
-	void typeAndMethodAnnotatedService() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.setEmbeddedValueResolver(value -> (value.equals("${baseUrl}") ? "/base" : value));
-		proxyFactory.afterPropertiesSet();
+	void typeAndMethodAnnotatedService() {
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client)
+				.embeddedValueResolver(value -> (value.equals("${baseUrl}") ? "/base" : value))
+				.build();
 
 		MethodLevelAnnotatedService service = proxyFactory.createClient(TypeAndMethodLevelAnnotatedService.class);
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/NamedValueArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/NamedValueArgumentResolverTests.java
@@ -61,8 +61,9 @@ class NamedValueArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.addCustomArgumentResolver(this.argumentResolver);
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client)
+				.customArgumentResolver(this.argumentResolver)
+				.build();
 		proxyFactory.afterPropertiesSet();
 
 		this.service = proxyFactory.createClient(Service.class);
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/PathVariableArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/PathVariableArgumentResolverTests.java
@@ -41,7 +41,7 @@ class PathVariableArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		proxyFactory.afterPropertiesSet();
 		this.service = proxyFactory.createClient(Service.class);
 	}
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/RequestAttributeArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/RequestAttributeArgumentResolverTests.java
@@ -40,8 +40,7 @@ class RequestAttributeArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/RequestBodyArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/RequestBodyArgumentResolverTests.java
@@ -45,8 +45,7 @@ public class RequestBodyArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/RequestHeaderArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/RequestHeaderArgumentResolverTests.java
@@ -43,8 +43,7 @@ class RequestHeaderArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/RequestParamArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/RequestParamArgumentResolverTests.java
@@ -45,8 +45,7 @@ public class RequestParamArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-web/src/test/java/org/springframework/web/service/invoker/UrlArgumentResolverTests.java b/spring-web/src/test/java/org/springframework/web/service/invoker/UrlArgumentResolverTests.java
@@ -40,8 +40,7 @@ public class UrlArgumentResolverTests {
 
 	@BeforeEach
 	void setUp() throws Exception {
-		HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);
-		proxyFactory.afterPropertiesSet();
+		HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();
 		this.service = proxyFactory.createClient(Service.class);
 	}
 
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/support/WebClientAdapter.java b/spring-webflux/src/main/java/org/springframework/web/reactive/function/client/support/WebClientAdapter.java
@@ -124,6 +124,15 @@ else if (requestValues.getBody() != null) {
 	}
 
 
+	/**
+	 * Create a {@link WebClientAdapter} for the given {@code WebClient} instance.
+	 * @param webClient the client to use
+	 * @return the created adapter instance
+	 */
+	public static WebClientAdapter forClient(WebClient webClient) {
+		return new WebClientAdapter(webClient);
+	}
+
 	/**
 	 * Static method to create a {@link HttpServiceProxyFactory} configured to
 	 * use the given {@link WebClient} instance. Effectively a shortcut for:
@@ -133,7 +142,11 @@ else if (requestValues.getBody() != null) {
 	 * </pre>
 	 * @param webClient the client to use
 	 * @return the created {@code HttpServiceProxyFactory} instance
+	 * @deprecated in favor of using {@link #forClient(WebClient)} and
+	 * {@link HttpServiceProxyFactory#builder(HttpClientAdapter)}
 	 */
+	@SuppressWarnings("removal")
+	@Deprecated(since = "6.0.0-RC1", forRemoval = true)
 	public static HttpServiceProxyFactory createHttpServiceProxyFactory(WebClient webClient) {
 		return new HttpServiceProxyFactory(new WebClientAdapter(webClient));
 	}
@@ -143,18 +156,12 @@ public static HttpServiceProxyFactory createHttpServiceProxyFactory(WebClient we
 	 * a {@link WebClient.Builder} and uses it to create the client.
 	 * @param webClientBuilder a builder to create the client to use with
 	 * @return the created {@code HttpServiceProxyFactory} instance
+	 * @deprecated in favor of using {@link #forClient(WebClient)} and
+	 * {@link HttpServiceProxyFactory#builder(HttpClientAdapter)}
 	 */
+	@Deprecated(since = "6.0.0-RC1", forRemoval = true)
 	public static HttpServiceProxyFactory createHttpServiceProxyFactory(WebClient.Builder webClientBuilder) {
 		return createHttpServiceProxyFactory(webClientBuilder.build());
 	}
 
-	/**
-	 * Create a {@link WebClientAdapter} for the given {@code WebClient} instance.
-	 * @param webClient the client to use
-	 * @return the created adapter instance
-	 */
-	public static WebClientAdapter forClient(WebClient webClient) {
-		return new WebClientAdapter(webClient);
-	}
-
 }
diff --git a/spring-webflux/src/test/java/org/springframework/web/reactive/function/client/support/WebClientHttpServiceProxyTests.java b/spring-webflux/src/test/java/org/springframework/web/reactive/function/client/support/WebClientHttpServiceProxyTests.java
@@ -105,10 +105,11 @@ private TestHttpService initHttpService() throws Exception {
 		return initHttpService(webClient);
 	}
 
-	private TestHttpService initHttpService(WebClient webClient) throws Exception {
-		HttpServiceProxyFactory factory = WebClientAdapter.createHttpServiceProxyFactory(webClient);
-		factory.afterPropertiesSet();
-		return factory.createClient(TestHttpService.class);
+	private TestHttpService initHttpService(WebClient webClient) {
+		return HttpServiceProxyFactory.builder()
+				.clientAdapter(WebClientAdapter.forClient(webClient))
+				.build()
+				.createClient(TestHttpService.class);
 	}
 
 	private void prepareResponse(Consumer<MockResponse> consumer) {
diff --git a/src/docs/asciidoc/integration.adoc b/src/docs/asciidoc/integration.adoc
@@ -390,8 +390,7 @@ Two, create a proxy that will perform the declared HTTP exchanges:
 [source,java,indent=0,subs="verbatim,quotes"]
 ----
 	WebClient client = WebClient.builder().baseUrl("https://api.github.com/").build();
-	HttpServiceProxyFactory factory = WebClientAdapter.createHttpServiceProxyFactory(client);
-	factory.afterPropertiesSet();
+	HttpServiceProxyFactory factory = HttpServiceProxyFactory.builder(WebClientAdapter.forClient(client)).build();
 
 	RepositoryService service = factory.createClient(RepositoryService.class);
 ----

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,7 @@ class CookieValueArgumentResolverTests {`
`42`	`42`
`43`	`43`	`@BeforeEach`
`44`	`44`	`void setUp() throws Exception {`
`45`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
`46`		`- proxyFactory.afterPropertiesSet();`
	`45`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`47`	`46`	`this.service = proxyFactory.createClient(Service.class);`
`48`	`47`	`}`
`49`	`48`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public class HttpMethodArgumentResolverTests {`
`43`	`43`
`44`	`44`	`@BeforeEach`
`45`	`45`	`void setUp() throws Exception {`
`46`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
	`46`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`47`	`47`	`proxyFactory.afterPropertiesSet();`
`48`	`48`	`this.service = proxyFactory.createClient(Service.class);`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ class PathVariableArgumentResolverTests {`
`41`	`41`
`42`	`42`	`@BeforeEach`
`43`	`43`	`void setUp() throws Exception {`
`44`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
	`44`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`45`	`45`	`proxyFactory.afterPropertiesSet();`
`46`	`46`	`this.service = proxyFactory.createClient(Service.class);`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,7 @@ class RequestAttributeArgumentResolverTests {`
`40`	`40`
`41`	`41`	`@BeforeEach`
`42`	`42`	`void setUp() throws Exception {`
`43`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
`44`		`- proxyFactory.afterPropertiesSet();`
	`43`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`45`	`44`	`this.service = proxyFactory.createClient(Service.class);`
`46`	`45`	`}`
`47`	`46`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,7 @@ public class RequestBodyArgumentResolverTests {`
`45`	`45`
`46`	`46`	`@BeforeEach`
`47`	`47`	`void setUp() throws Exception {`
`48`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
`49`		`- proxyFactory.afterPropertiesSet();`
	`48`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`50`	`49`	`this.service = proxyFactory.createClient(Service.class);`
`51`	`50`	`}`
`52`	`51`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,7 @@ class RequestHeaderArgumentResolverTests {`
`43`	`43`
`44`	`44`	`@BeforeEach`
`45`	`45`	`void setUp() throws Exception {`
`46`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
`47`		`- proxyFactory.afterPropertiesSet();`
	`46`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`48`	`47`	`this.service = proxyFactory.createClient(Service.class);`
`49`	`48`	`}`
`50`	`49`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,7 @@ public class RequestParamArgumentResolverTests {`
`45`	`45`
`46`	`46`	`@BeforeEach`
`47`	`47`	`void setUp() throws Exception {`
`48`		`- HttpServiceProxyFactory proxyFactory = new HttpServiceProxyFactory(this.client);`
`49`		`- proxyFactory.afterPropertiesSet();`
	`48`	`+ HttpServiceProxyFactory proxyFactory = HttpServiceProxyFactory.builder(this.client).build();`
`50`	`49`	`this.service = proxyFactory.createClient(Service.class);`
`51`	`50`	`}`
`52`	`51`