Simplify through use of grpc builder APIs

Author: dsyer

samples/grpc-server/src/test/java/org/springframework/grpc/sample/GrpcServerApplicationTests.java

@@ -15,6 +15,7 @@
 import org.springframework.grpc.sample.proto.SimpleGrpc;
 import org.springframework.test.annotation.DirtiesContext;
 
+import io.grpc.Channel;
 import io.grpc.Grpc;
 import io.grpc.InsecureChannelCredentials;
 
@@ -45,11 +46,17 @@ void serverResponds() {
 
 	@TestConfiguration
 	static class ExtraConfiguration {
+
 		@Bean
-		SimpleGrpc.SimpleBlockingStub stub() {
-			var channel = Grpc.newChannelBuilderForAddress("0.0.0.0", 9090, InsecureChannelCredentials.create())
-					.build();
+		SimpleGrpc.SimpleBlockingStub stub(Channel channel) {
 			return SimpleGrpc.newBlockingStub(channel);
 		}
+
+		@Bean(destroyMethod = "shutdown")
+		Channel channel() {
+			return Grpc.newChannelBuilderForAddress("0.0.0.0", 9090, InsecureChannelCredentials.create()).build();
+		}
+
 	}
+
 }

spring-grpc-core/src/main/java/org/springframework/grpc/client/GrpcChannelFactory.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024-2024 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.client;
+
+import io.grpc.Channel;
+
+public interface GrpcChannelFactory extends AutoCloseable {
+
+	Channel createChannel(String name);
+
+}

spring-grpc-core/src/main/java/org/springframework/grpc/server/AbstractGrpcServerFactory.java renamed to spring-grpc-core/src/main/java/org/springframework/grpc/server/DefaultGrpcServerFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2024 the original author or authors.
+ * Copyright 2024-2024 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.
@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
- * Partial copy from net.devh:grpc-spring-boot-starter.
  */
 package org.springframework.grpc.server;
 
@@ -32,7 +31,7 @@
 import io.grpc.ServerBuilder;
 import io.grpc.ServerServiceDefinition;
 
-public abstract class AbstractGrpcServerFactory<T extends ServerBuilder<T>> implements GrpcServerFactory {
+public class DefaultGrpcServerFactory<T extends ServerBuilder<T>> implements GrpcServerFactory {
 
 	/** Logger available to subclasses. */
 	protected final Log logger = LogFactory.getLog(getClass());
@@ -45,7 +44,7 @@ public abstract class AbstractGrpcServerFactory<T extends ServerBuilder<T>> impl
 
 	private final int port;
 
-	protected AbstractGrpcServerFactory(String address, int port, final List<GrpcServerConfigurer> serverConfigurers) {
+	public DefaultGrpcServerFactory(String address, int port, final List<GrpcServerConfigurer> serverConfigurers) {
 		this.serverConfigurers = requireNonNull(serverConfigurers, "serverConfigurers");
 		this.address = address;
 		this.port = port;
@@ -70,7 +69,11 @@ public Server createServer() {
 	 * Creates a new server builder.
 	 * @return The newly created server builder.
 	 */
-	protected abstract T newServerBuilder();
+	@SuppressWarnings("unchecked")
+	protected T newServerBuilder() {
+		// TODO: Add support for address resolution
+		return (T) ServerBuilder.forPort(getPort());
+	}
 
 	/**
 	 * Configures the given server builder. This method can be overwritten to add features

spring-grpc-core/src/main/java/org/springframework/grpc/server/NettyGrpcServerFactory.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2024-2024 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.autoconfigure.client;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.grpc.server.GrpcServerFactory;
+
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnBean(GrpcServerFactory.class)
+public class GrpcClientAutoConfiguration {
+
+}

spring-grpc-core/src/main/java/org/springframework/grpc/util/GrpcUtils.java

@@ -17,17 +17,14 @@
 
 import java.util.List;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.springframework.boot.autoconfigure.AutoConfigureBefore;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.grpc.server.DefaultGrpcServerFactory;
 import org.springframework.grpc.server.GrpcServerConfigurer;
 import org.springframework.grpc.server.GrpcServerFactory;
-import org.springframework.grpc.server.NettyGrpcServerFactory;
 
 import io.grpc.ServerServiceDefinition;
 
@@ -37,17 +34,12 @@
 @EnableConfigurationProperties(GrpcServerProperties.class)
 public class GrpcServerFactoryAutoConfiguration {
 
-	private static final Log logger = LogFactory.getLog(GrpcServerFactoryAutoConfiguration.class);
-
 	@ConditionalOnMissingBean(GrpcServerFactory.class)
-	@ConditionalOnClass(name = { "io.netty.channel.Channel", "io.grpc.netty.NettyServerBuilder" })
 	@Bean
-	public NettyGrpcServerFactory nettyGrpcServerFactory(final GrpcServerProperties properties,
+	public DefaultGrpcServerFactory<?> defaultGrpcServerFactory(final GrpcServerProperties properties,
 			final GrpcServiceDiscoverer serviceDiscoverer, final List<GrpcServerConfigurer> serverConfigurers) {
-
-		logger.info("Detected grpc-netty: Creating NettyGrpcServerFactory");
-		final NettyGrpcServerFactory factory = new NettyGrpcServerFactory(properties.getAddress(), properties.getPort(),
-				serverConfigurers);
+		final DefaultGrpcServerFactory<?> factory = new DefaultGrpcServerFactory<>(properties.getAddress(),
+				properties.getPort(), serverConfigurers);
 		for (final ServerServiceDefinition service : serviceDiscoverer.findGrpcServices()) {
 			factory.addService(service);
 		}

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/client/GrpcClientAutoConfiguration.java

@@ -20,12 +20,11 @@
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.convert.DurationUnit;
-import org.springframework.grpc.util.GrpcUtils;
 
 @ConfigurationProperties(prefix = "spring.grpc.server")
 public class GrpcServerProperties {
 
-	private String address = GrpcUtils.ANY_IP_ADDRESS;
+	private String address = "*";
 
 	private int port = 9090;
 

spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/server/GrpcServerFactoryAutoConfiguration.java

@@ -37,7 +37,7 @@ public class GrpcServiceAutoConfiguration {
 	@ConditionalOnMissingBean
 	@Bean
 	public GrpcServiceDiscoverer defaultGrpcServiceDiscoverer(ApplicationContext applicationContext) {
-		return new AnnotationGrpcServiceDiscoverer(applicationContext);
+		return new DefaultGrpcServiceDiscoverer(applicationContext);
 	}
 
 	@ConditionalOnMissingBean
@@ -49,11 +49,11 @@ public GrpcServerLifecycle grpcServerLifecycle(final GrpcServerFactory factory,
 
 }
 
-class AnnotationGrpcServiceDiscoverer implements GrpcServiceDiscoverer {
+class DefaultGrpcServiceDiscoverer implements GrpcServiceDiscoverer {
 
 	private final ApplicationContext applicationContext;
 
-	public AnnotationGrpcServiceDiscoverer(ApplicationContext applicationContext) {
+	public DefaultGrpcServiceDiscoverer(ApplicationContext applicationContext) {
 		this.applicationContext = applicationContext;
 	}