Exclude HttpServiceClient from GroupRegistry scan

The detect methods in the GroupRegistry that find all interfaces
with HttpExchange annotations now exclude HttpServiceClient
interfaces that are instead supported by a dedicated registrar.

This ensures there is no overlap between the HttpServiceClient
registrar scan and the ImportHttpServices registrar scan or
the scan of any other custom registrar.

See gh-35244

Author: rstoyanchev

spring-web/src/main/java/org/springframework/web/service/registry/AbstractHttpServiceRegistrar.java

@@ -188,6 +188,12 @@ protected abstract void registerHttpServices(
 			GroupRegistry registry, AnnotationMetadata importingClassMetadata);
 
 
+	/**
+	 * Exposes the scan for HTTP Service types, looking for
+	 * interfaces with type or method {@link HttpExchange} annotations.
+	 * @param basePackage the packages to look under
+	 * @return match bean definitions
+	 */
 	protected Stream<BeanDefinition> findHttpServices(String basePackage) {
 		if (this.scanner == null) {
 			Assert.state(this.environment != null, "Environment has not been set");
@@ -257,7 +263,10 @@ interface GroupSpec {
 
 			/**
 			 * Detect HTTP Service types in the given packages, looking for
-			 * interfaces with a type and/or method {@link HttpExchange} annotation.
+			 * interfaces with type or method {@link HttpExchange} annotations.
+			 * <p>The performed scan, however, filters out any interfaces
+			 * annotated with {@link HttpServiceClient} that are instead supported
+			 * by {@link HttpServiceClientRegistrarSupport}.
 			 */
 			GroupSpec detectInBasePackages(Class<?>... packageClasses);
 
@@ -314,11 +323,19 @@ public GroupRegistry.GroupSpec detectInBasePackages(String... packageNames) {
 
 			private void detectInBasePackage(String packageName) {
 				findHttpServices(packageName)
+						.filter(DefaultGroupSpec::isNotHttpServiceClientAnnotated)
 						.map(BeanDefinition::getBeanClassName)
 						.filter(Objects::nonNull)
 						.forEach(this::registerServiceTypeName);
 			}
 
+			private static boolean isNotHttpServiceClientAnnotated(BeanDefinition defintion) {
+				if (defintion instanceof AnnotatedBeanDefinition abd) {
+					return !abd.getMetadata().hasAnnotation(HttpServiceClient.class.getName());
+				}
+				return true;
+			}
+
 			private void registerServiceTypeName(String httpServiceTypeName) {
 				this.registration.httpServiceTypeNames().add(httpServiceTypeName);
 			}

spring-web/src/main/java/org/springframework/web/service/registry/ImportHttpServices.java

@@ -76,10 +76,11 @@
 	String group() default HttpServiceGroup.DEFAULT_GROUP_NAME;
 
 	/**
-	 * Detect HTTP Services in the packages of the specified classes by looking
-	 * for interfaces with type-level or method-level
-	 * {@link org.springframework.web.service.annotation.HttpExchange @HttpExchange}
-	 * annotations.
+	 * Detect HTTP Services in the packages of the specified classes, looking
+	 * for interfaces with type or method {@link HttpExchange} annotations.
+	 * <p>The performed scan, however, filters out interfaces annotated with
+	 * {@link HttpServiceClient} that are instead supported by
+	 * {@link HttpServiceClientRegistrarSupport}.
 	 */
 	Class<?>[] basePackageClasses() default {};
 

spring-web/src/test/java/org/springframework/web/service/registry/HttpServiceClientRegistrarSupportTests.java

@@ -25,9 +25,9 @@
 import org.springframework.core.env.StandardEnvironment;
 import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
 import org.springframework.core.type.AnnotationMetadata;
-import org.springframework.web.service.registry.client.DefaultClient;
-import org.springframework.web.service.registry.client.EchoClientA;
-import org.springframework.web.service.registry.client.EchoClientB;
+import org.springframework.web.service.registry.basic.BasicClient;
+import org.springframework.web.service.registry.echo.EchoClientA;
+import org.springframework.web.service.registry.echo.EchoClientB;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
@@ -43,21 +43,24 @@ public class HttpServiceClientRegistrarSupportTests {
 
 	@Test
 	void register() {
+
+		List<String> basePackages = List.of(
+				BasicClient.class.getPackageName(), EchoClientA.class.getPackageName());
+
 		HttpServiceClientRegistrarSupport registrar = new HttpServiceClientRegistrarSupport() {
 
 			@Override
 			protected void registerHttpServices(GroupRegistry registry, AnnotationMetadata importingClassMetadata) {
-				findAndRegisterHttpServiceClients(groupRegistry, List.of(getClass().getPackage().getName() + ".client"));
+				findAndRegisterHttpServiceClients(groupRegistry, basePackages);
 			}
 		};
 		registrar.setEnvironment(new StandardEnvironment());
 		registrar.setResourceLoader(new PathMatchingResourcePatternResolver());
-
 		registrar.registerHttpServices(groupRegistry, mock(AnnotationMetadata.class));
 
 		assertGroups(
-				TestGroup.ofListing("echo", EchoClientA.class, EchoClientB.class),
-				TestGroup.ofListing("default", DefaultClient.class));
+				TestGroup.ofListing("default", BasicClient.class),
+				TestGroup.ofListing("echo", EchoClientA.class, EchoClientB.class));
 	}
 
 	private void assertGroups(TestGroup... expectedGroups) {

spring-web/src/test/java/org/springframework/web/service/registry/client/DefaultClient.java renamed to spring-web/src/test/java/org/springframework/web/service/registry/basic/BasicClient.java

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-package org.springframework.web.service.registry.client;
+package org.springframework.web.service.registry.basic;
 
 
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.service.annotation.GetExchange;
 import org.springframework.web.service.registry.HttpServiceClient;
 
 @HttpServiceClient
-public interface DefaultClient {
+public interface BasicClient {
 
 	@GetExchange
 	String handle(@RequestParam String input);

spring-web/src/test/java/org/springframework/web/service/registry/client/EchoClientA.java renamed to spring-web/src/test/java/org/springframework/web/service/registry/echo/EchoClientA.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.web.service.registry.client;
+package org.springframework.web.service.registry.echo;
 
 
 import org.springframework.web.bind.annotation.RequestParam;

spring-web/src/test/java/org/springframework/web/service/registry/client/EchoClientB.java renamed to spring-web/src/test/java/org/springframework/web/service/registry/echo/EchoClientB.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.web.service.registry.client;
+package org.springframework.web.service.registry.echo;
 
 
 import org.springframework.web.bind.annotation.RequestParam;