Use different WebClient.Builder instances per Retrofit context support non-loadbalancer. (#43)

Author: huahouye

docs/src/main/asciidoc/spring-cloud-square.adoc

@@ -159,7 +159,7 @@ public WebClient.Builder webClientBuilder() {
 
 They are used under the hood to run load-balanced HTTP requests.
 
-NOTE: You can create various instances of `WebClient.Builder` with different setup. If a `@LoadBalanced WebClient.Builder` bean is found with name matching the pattern `[retrofit-context-name]WebClientBuilder`, it will be picked for the Retrofit context in question, otherwise the first found `@LoadBalaced WebClient.Builder` bean will be picked.
+NOTE: You can create various instances of `WebClient.Builder` with different setup. If a `WebClient.Builder` bean is found with name matching the pattern `[retrofit-context-name]WebClientBuilder`, it will be picked for the Retrofit context in question, otherwise the first found `WebClient.Builder` bean will be picked.
 
 
 === Retrofit Reactor support

spring-cloud-square-retrofit-webclient/src/main/java/org/springframework/cloud/square/retrofit/webclient/WebClientRetrofitClientFactoryBean.java

@@ -32,6 +32,7 @@
  *
  * @author Spencer Gibb
  * @author Olga Maciaszek-Sharma
+ * @author HouYe Hua
  */
 public class WebClientRetrofitClientFactoryBean extends AbstractRetrofitClientFactoryBean {
 
@@ -48,22 +49,18 @@ protected Retrofit.Builder retrofit(RetrofitContext context, boolean hasUrl) {
 
 		if (hasUrl) {
 			// this is not load balanced and needs a WebClient
-			WebClient.Builder nonLoadBalancedBuilder = null;
 			Map<String, WebClient.Builder> instances = context.getInstances(this.name, WebClient.Builder.class);
-			for (Map.Entry<String, WebClient.Builder> entry : instances.entrySet()) {
-				String beanName = entry.getKey();
-				WebClient.Builder clientBuilder = entry.getValue();
-
-				if (applicationContext.findAnnotationOnBean(beanName, LoadBalanced.class) == null) {
-					nonLoadBalancedBuilder = clientBuilder;
-					break;
-				}
-			}
-
-			if (nonLoadBalancedBuilder == null) {
+			List<Map.Entry<String, WebClient.Builder>> webClientBuilders = instances.entrySet().stream().filter(
+					entry -> applicationContext.findAnnotationOnBean(entry.getKey(), LoadBalanced.class) == null)
+					.collect(Collectors.toList());
+			if (webClientBuilders.isEmpty()) {
 				throw new IllegalStateException("No WebClient.Builder bean defined.");
 			}
-			builder.callFactory(new WebClientCallFactory(nonLoadBalancedBuilder.build()));
+			WebClient.Builder selectedWebClientBuilder = webClientBuilders.stream()
+					.filter(entry -> entry.getKey().equals(name + WEB_CLIENT_BUILDER_SUFFIX)).findAny()
+					.orElse(webClientBuilders.stream().findAny().get()).getValue();
+
+			builder.callFactory(new WebClientCallFactory(selectedWebClientBuilder.build()));
 		}
 
 		return builder;

spring-cloud-square-retrofit-webclient/src/test/java/org/springframework/cloud/square/retrofit/webclient/WebClientRetrofitLoadBalancerTests.java

@@ -18,6 +18,8 @@
 
 import java.util.Objects;
 
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import reactor.core.publisher.Mono;
 import retrofit2.Retrofit;
@@ -39,6 +41,7 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.core.style.ToStringCreator;
 import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.util.SocketUtils;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.reactive.function.client.WebClient;
@@ -50,6 +53,7 @@
 /**
  * @author Spencer Gibb
  * @author Olga Maciaszek-Sharma
+ * @author HouYe Hua
  */
 @SpringBootTest(properties = { "spring.application.name=retrofitclientloadbalancertest",
 		"logging.level.org.springframework.cloud.square.retrofit=DEBUG",
@@ -65,9 +69,28 @@ class WebClientRetrofitLoadBalancerTests {
 	@Autowired
 	TestClientWithCustomWebClientBuilder testClientWithCustomWebClientBuilder;
 
+	@Autowired
+	TestClientWithoutLoadBalancedWebClientBuilder testClientWithoutLoadBalancedWebClientBuilder;
+
 	@Autowired
 	private RetrofitContext retrofitContext;
 
+	@LocalServerPort
+	private int port;
+
+	@BeforeAll
+	static void init() {
+		int port = SocketUtils.findAvailableTcpPort();
+		System.setProperty("server.port", String.valueOf(port));
+		System.setProperty("retrofit.client.url.tests.url", "http://localhost:" + port);
+	}
+
+	@AfterAll
+	static void destroy() {
+		System.clearProperty("server.port");
+		System.clearProperty("retrofit.client.url.tests.url");
+	}
+
 	@Test
 	void testRetrofitConfiguration() {
 		Retrofit retrofit = retrofitContext.getInstance("localapp", Retrofit.class);
@@ -84,11 +107,17 @@ void testSimpleType() {
 	}
 
 	@Test
-	void testCustomWebClientBuilderPickeByRetrofitName() {
+	void testCustomWebClientBuilderPickedByRetrofitName() {
 		assertThatExceptionOfType(UnsupportedOperationException.class)
 				.isThrownBy(() -> testClientWithCustomWebClientBuilder.getHello().block());
 	}
 
+	@Test
+	void testCustomWebClientBuilderPickedByRetrofitNameWithoutLoadBalanced() {
+		assertThatExceptionOfType(ExceptionForTest.class)
+				.isThrownBy(() -> testClientWithoutLoadBalancedWebClientBuilder.getHello().block());
+	}
+
 	@RetrofitClient("localapp")
 	protected interface TestClient {
 
@@ -105,9 +134,18 @@ protected interface TestClientWithCustomWebClientBuilder {
 
 	}
 
+	@RetrofitClient(name = "withoutLoadBalanced", url = "${retrofit.client.url.tests.url}")
+	protected interface TestClientWithoutLoadBalancedWebClientBuilder {
+
+		@GET("/hello")
+		Mono<Hello> getHello();
+
+	}
+
 	@SpringBootConfiguration
 	@EnableAutoConfiguration
-	@EnableRetrofitClients(clients = { TestClient.class, TestClientWithCustomWebClientBuilder.class })
+	@EnableRetrofitClients(clients = { TestClient.class, TestClientWithCustomWebClientBuilder.class,
+			TestClientWithoutLoadBalancedWebClientBuilder.class })
 	@LoadBalancerClients({ @LoadBalancerClient(name = "localapp", configuration = TestAppConfig.class),
 			@LoadBalancerClient(name = "localapp2", configuration = TestAppConfig.class) })
 	@SuppressWarnings("unused")
@@ -133,6 +171,29 @@ public WebClient.Builder localapp2WebClientBuilder() {
 			});
 		}
 
+		@Bean
+		public WebClient.Builder withoutLoadBalancedDefaultWebClientBuilder() {
+			return WebClient.builder();
+		}
+
+		@Bean
+		public WebClient.Builder withoutLoadBalancedWebClientBuilder() {
+			return WebClient.builder().filter((request, next) -> {
+				throw new ExceptionForTest("Failing WebClient Instance From withoutLoadBalancedWebClientBuilder");
+			});
+		}
+
+	}
+
+	protected static class ExceptionForTest extends RuntimeException {
+
+		public ExceptionForTest() {
+		}
+
+		public ExceptionForTest(String message) {
+			super(message);
+		}
+
 	}
 
 	protected static class TestAppConfig {