Allow filtering of services

therepanic · onobc · commit 0fccea188f9a · 2025-07-01T20:27:30.000-05:00
This commit adds the ability to filter out services from being bound to server factories. Resolves #207 Signed-off-by: Andrey Litvitski <andrey1010102008@gmail.com> Signed-off-by: Chris Bono <chris.bono@gmail.com>
diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/DefaultGrpcServerFactory.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/DefaultGrpcServerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024-2024 the original author or authors.
+ * Copyright 2024-2025 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.
@@ -28,6 +28,7 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.grpc.internal.GrpcUtils;
+import org.springframework.lang.Nullable;
 
 import com.google.common.collect.Lists;
 import io.grpc.Grpc;
@@ -49,6 +50,7 @@
  * @param <T> the type of server builder
  * @author David Syer
  * @author Chris Bono
+ * @author Andrey Litvitski
  * @see ServerProvider#provider()
  */
 public class DefaultGrpcServerFactory<T extends ServerBuilder<T>> implements GrpcServerFactory {
@@ -68,17 +70,21 @@ public class DefaultGrpcServerFactory<T extends ServerBuilder<T>> implements Grp
 
 	private ClientAuth clientAuth;
 
+	private ServerServiceDefinitionFilter serviceFilter;
+
 	public DefaultGrpcServerFactory(String address, List<ServerBuilderCustomizer<T>> serverBuilderCustomizers) {
 		this.address = address;
 		this.serverBuilderCustomizers = Objects.requireNonNull(serverBuilderCustomizers, "serverBuilderCustomizers");
 	}
 
 	public DefaultGrpcServerFactory(String address, List<ServerBuilderCustomizer<T>> serverBuilderCustomizers,
-			KeyManagerFactory keyManager, TrustManagerFactory trustManager, ClientAuth clientAuth) {
+			KeyManagerFactory keyManager, TrustManagerFactory trustManager, ClientAuth clientAuth,
+			@Nullable ServerServiceDefinitionFilter serviceFilter) {
 		this(address, serverBuilderCustomizers);
 		this.keyManager = keyManager;
 		this.trustManager = trustManager;
 		this.clientAuth = clientAuth;
+		this.serviceFilter = serviceFilter;
 	}
 
 	protected String address() {
@@ -94,7 +100,9 @@ public Server createServer() {
 
 	@Override
 	public void addService(ServerServiceDefinition service) {
-		this.serviceList.add(service);
+		if (this.serviceFilter == null || this.serviceFilter.filter(service)) {
+			this.serviceList.add(service);
+		}
 	}
 
 	/**
diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/InProcessGrpcServerFactory.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/InProcessGrpcServerFactory.java
@@ -17,18 +17,22 @@
 
 import java.util.List;
 
+import org.springframework.lang.Nullable;
+
 import io.grpc.inprocess.InProcessServerBuilder;
 
 /**
  * {@link GrpcServerFactory} that can be used to create an in-process gRPC server.
  *
  * @author Chris Bono
+ * @author Andrey Litvitski
  */
 public class InProcessGrpcServerFactory extends DefaultGrpcServerFactory<InProcessServerBuilder> {
 
 	public InProcessGrpcServerFactory(String address,
-			List<ServerBuilderCustomizer<InProcessServerBuilder>> serverBuilderCustomizers) {
-		super(address, serverBuilderCustomizers);
+			List<ServerBuilderCustomizer<InProcessServerBuilder>> serverBuilderCustomizers,
+			@Nullable ServerServiceDefinitionFilter serviceFilter) {
+		super(address, serverBuilderCustomizers, null, null, null, serviceFilter);
 	}
 
 	@Override
diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/NettyGrpcServerFactory.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/NettyGrpcServerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024-2024 the original author or authors.
+ * Copyright 2024-2025 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.
@@ -21,6 +21,8 @@
 import javax.net.ssl.KeyManagerFactory;
 import javax.net.ssl.TrustManagerFactory;
 
+import org.springframework.lang.Nullable;
+
 import io.grpc.TlsServerCredentials.ClientAuth;
 import io.grpc.netty.NettyServerBuilder;
 import io.netty.channel.epoll.EpollEventLoopGroup;
@@ -32,13 +34,15 @@
  *
  * @author David Syer
  * @author Chris Bono
+ * @author Andrey Litvitski
  */
 public class NettyGrpcServerFactory extends DefaultGrpcServerFactory<NettyServerBuilder> {
 
 	public NettyGrpcServerFactory(String address,
 			List<ServerBuilderCustomizer<NettyServerBuilder>> serverBuilderCustomizers, KeyManagerFactory keyManager,
-			TrustManagerFactory trustManager, ClientAuth clientAuth) {
-		super(address, serverBuilderCustomizers, keyManager, trustManager, clientAuth);
+			TrustManagerFactory trustManager, ClientAuth clientAuth,
+			@Nullable ServerServiceDefinitionFilter serviceFilter) {
+		super(address, serverBuilderCustomizers, keyManager, trustManager, clientAuth, serviceFilter);
 	}
 
 	@Override
diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/ServerServiceDefinitionFilter.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/ServerServiceDefinitionFilter.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2023-2025 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.grpc.server;
+
+import io.grpc.ServerServiceDefinition;
+
+/**
+ * Strategy to determine whether a {@link ServerServiceDefinition} should be included for
+ * the {@link GrpcServerFactory server factory}.
+ *
+ * @author Andrey Litvitski
+ */
+@FunctionalInterface
+public interface ServerServiceDefinitionFilter {
+
+	/**
+	 * Determine whether the given {@link ServerServiceDefinition} should be included for
+	 * the {@link GrpcServerFactory server factory}.
+	 * @param serviceDefinition the gRPC service definition under consideration.
+	 * @return {@code true} if the service should be included; {@code false} otherwise.
+	 */
+	boolean filter(ServerServiceDefinition serviceDefinition);
+
+}
diff --git a/spring-grpc-core/src/main/java/org/springframework/grpc/server/ShadedNettyGrpcServerFactory.java b/spring-grpc-core/src/main/java/org/springframework/grpc/server/ShadedNettyGrpcServerFactory.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024-2024 the original author or authors.
+ * Copyright 2024-2025 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.
@@ -21,6 +21,8 @@
 import javax.net.ssl.KeyManagerFactory;
 import javax.net.ssl.TrustManagerFactory;
 
+import org.springframework.lang.Nullable;
+
 import io.grpc.TlsServerCredentials.ClientAuth;
 import io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder;
 import io.grpc.netty.shaded.io.netty.channel.epoll.EpollEventLoopGroup;
@@ -32,13 +34,15 @@
  *
  * @author David Syer
  * @author Chris Bono
+ * @author Andrey Litvitski
  */
 public class ShadedNettyGrpcServerFactory extends DefaultGrpcServerFactory<NettyServerBuilder> {
 
 	public ShadedNettyGrpcServerFactory(String address,
 			List<ServerBuilderCustomizer<NettyServerBuilder>> serverBuilderCustomizers, KeyManagerFactory keyManager,
-			TrustManagerFactory trustManager, ClientAuth clientAuth) {
-		super(address, serverBuilderCustomizers, keyManager, trustManager, clientAuth);
+			TrustManagerFactory trustManager, ClientAuth clientAuth,
+			@Nullable ServerServiceDefinitionFilter serviceFilter) {
+		super(address, serverBuilderCustomizers, keyManager, trustManager, clientAuth, serviceFilter);
 	}
 
 	@Override
diff --git a/spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/server/GrpcServerFactoryConfigurations.java b/spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/server/GrpcServerFactoryConfigurations.java
@@ -30,11 +30,13 @@
 import org.springframework.boot.ssl.SslBundles;
 import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.context.annotation.Bean;
+import org.springframework.lang.Nullable;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.grpc.server.GrpcServerFactory;
 import org.springframework.grpc.server.InProcessGrpcServerFactory;
 import org.springframework.grpc.server.NettyGrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
+import org.springframework.grpc.server.ServerServiceDefinitionFilter;
 import org.springframework.grpc.server.ShadedNettyGrpcServerFactory;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
 import org.springframework.grpc.server.service.GrpcServiceConfigurer;
@@ -62,7 +64,8 @@ static class ShadedNettyServerFactoryConfiguration {
 		@Bean
 		ShadedNettyGrpcServerFactory shadedNettyGrpcServerFactory(GrpcServerProperties properties,
 				GrpcServiceDiscoverer serviceDiscoverer, GrpcServiceConfigurer serviceConfigurer,
-				ServerBuilderCustomizers serverBuilderCustomizers, SslBundles bundles) {
+				ServerBuilderCustomizers serverBuilderCustomizers, SslBundles bundles,
+				@Nullable ServerServiceDefinitionFilter serviceFilter) {
 			ShadedNettyServerFactoryPropertyMapper mapper = new ShadedNettyServerFactoryPropertyMapper(properties);
 			List<ServerBuilderCustomizer<io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder>> builderCustomizers = List
 				.of(mapper::customizeServerBuilder, serverBuilderCustomizers::customize);
@@ -75,7 +78,7 @@ ShadedNettyGrpcServerFactory shadedNettyGrpcServerFactory(GrpcServerProperties p
 						: io.grpc.netty.shaded.io.netty.handler.ssl.util.InsecureTrustManagerFactory.INSTANCE;
 			}
 			ShadedNettyGrpcServerFactory factory = new ShadedNettyGrpcServerFactory(properties.getAddress(),
-					builderCustomizers, keyManager, trustManager, properties.getSsl().getClientAuth());
+					builderCustomizers, keyManager, trustManager, properties.getSsl().getClientAuth(), serviceFilter);
 			serviceDiscoverer.findServices()
 				.stream()
 				.map((serviceSpec) -> serviceConfigurer.configure(serviceSpec, factory))
@@ -104,7 +107,8 @@ static class NettyServerFactoryConfiguration {
 		@Bean
 		NettyGrpcServerFactory nettyGrpcServerFactory(GrpcServerProperties properties,
 				GrpcServiceDiscoverer serviceDiscoverer, GrpcServiceConfigurer serviceConfigurer,
-				ServerBuilderCustomizers serverBuilderCustomizers, SslBundles bundles) {
+				ServerBuilderCustomizers serverBuilderCustomizers, SslBundles bundles,
+				@Nullable ServerServiceDefinitionFilter serviceFilter) {
 			NettyServerFactoryPropertyMapper mapper = new NettyServerFactoryPropertyMapper(properties);
 			List<ServerBuilderCustomizer<NettyServerBuilder>> builderCustomizers = List
 				.of(mapper::customizeServerBuilder, serverBuilderCustomizers::customize);
@@ -117,7 +121,7 @@ NettyGrpcServerFactory nettyGrpcServerFactory(GrpcServerProperties properties,
 						: InsecureTrustManagerFactory.INSTANCE;
 			}
 			NettyGrpcServerFactory factory = new NettyGrpcServerFactory(properties.getAddress(), builderCustomizers,
-					keyManager, trustManager, properties.getSsl().getClientAuth());
+					keyManager, trustManager, properties.getSsl().getClientAuth(), serviceFilter);
 			serviceDiscoverer.findServices()
 				.stream()
 				.map((serviceSpec) -> serviceConfigurer.configure(serviceSpec, factory))
@@ -145,12 +149,13 @@ static class InProcessServerFactoryConfiguration {
 		@Bean
 		InProcessGrpcServerFactory inProcessGrpcServerFactory(GrpcServerProperties properties,
 				GrpcServiceDiscoverer serviceDiscoverer, GrpcServiceConfigurer serviceConfigurer,
-				ServerBuilderCustomizers serverBuilderCustomizers) {
+				ServerBuilderCustomizers serverBuilderCustomizers,
+				@Nullable ServerServiceDefinitionFilter serviceFilter) {
 			var mapper = new InProcessServerFactoryPropertyMapper(properties);
 			List<ServerBuilderCustomizer<InProcessServerBuilder>> builderCustomizers = List
 				.of(mapper::customizeServerBuilder, serverBuilderCustomizers::customize);
 			InProcessGrpcServerFactory factory = new InProcessGrpcServerFactory(properties.getInprocess().getName(),
-					builderCustomizers);
+					builderCustomizers, serviceFilter);
 			serviceDiscoverer.findServices()
 				.stream()
 				.map((serviceSpec) -> serviceConfigurer.configure(serviceSpec, factory))
diff --git a/spring-grpc-spring-boot-autoconfigure/src/test/java/org/springframework/grpc/autoconfigure/server/GrpcServerAutoConfigurationTests.java b/spring-grpc-spring-boot-autoconfigure/src/test/java/org/springframework/grpc/autoconfigure/server/GrpcServerAutoConfigurationTests.java
@@ -45,10 +45,12 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.core.annotation.Order;
+import org.springframework.grpc.server.DefaultGrpcServerFactory;
 import org.springframework.grpc.server.GrpcServerFactory;
 import org.springframework.grpc.server.InProcessGrpcServerFactory;
 import org.springframework.grpc.server.NettyGrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
+import org.springframework.grpc.server.ServerServiceDefinitionFilter;
 import org.springframework.grpc.server.ShadedNettyGrpcServerFactory;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
 import org.springframework.grpc.server.service.DefaultGrpcServiceConfigurer;
@@ -68,6 +70,7 @@
  * Tests for {@link GrpcServerAutoConfiguration}.
  *
  * @author Chris Bono
+ * @author Andrey Litvitski
  */
 class GrpcServerAutoConfigurationTests {
 
diff --git a/spring-grpc-test/src/main/java/org/springframework/grpc/test/InProcessTestAutoConfiguration.java b/spring-grpc-test/src/main/java/org/springframework/grpc/test/InProcessTestAutoConfiguration.java
@@ -34,9 +34,11 @@
 import org.springframework.grpc.client.InProcessGrpcChannelFactory;
 import org.springframework.grpc.server.InProcessGrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
+import org.springframework.grpc.server.ServerServiceDefinitionFilter;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
 import org.springframework.grpc.server.service.GrpcServiceConfigurer;
 import org.springframework.grpc.server.service.GrpcServiceDiscoverer;
+import org.springframework.lang.Nullable;
 
 import io.grpc.BindableService;
 import io.grpc.ChannelCredentials;
@@ -56,8 +58,9 @@ public class InProcessTestAutoConfiguration {
 	@Order(Ordered.HIGHEST_PRECEDENCE)
 	TestInProcessGrpcServerFactory testInProcessGrpcServerFactory(GrpcServiceDiscoverer serviceDiscoverer,
 			GrpcServiceConfigurer serviceConfigurer,
-			List<ServerBuilderCustomizer<InProcessServerBuilder>> customizers) {
-		var factory = new TestInProcessGrpcServerFactory(address, customizers);
+			List<ServerBuilderCustomizer<InProcessServerBuilder>> customizers,
+			@Nullable ServerServiceDefinitionFilter serviceFilter) {
+		var factory = new TestInProcessGrpcServerFactory(address, customizers, serviceFilter);
 		serviceDiscoverer.findServices()
 			.stream()
 			.map((serviceSpec) -> serviceConfigurer.configure(serviceSpec, factory))
@@ -86,8 +89,9 @@ GrpcServerLifecycle inProcessGrpcServerLifecycle(InProcessGrpcServerFactory fact
 	public static class TestInProcessGrpcServerFactory extends InProcessGrpcServerFactory {
 
 		public TestInProcessGrpcServerFactory(String address,
-				List<ServerBuilderCustomizer<InProcessServerBuilder>> serverBuilderCustomizers) {
-			super(address, serverBuilderCustomizers);
+				List<ServerBuilderCustomizer<InProcessServerBuilder>> serverBuilderCustomizers,
+				@Nullable ServerServiceDefinitionFilter serviceFilter) {
+			super(address, serverBuilderCustomizers, serviceFilter);
 		}
 
 	}
