Add sample with Shaded Netty

Author: Dave Syer

README.md

@@ -85,8 +85,6 @@ As shown in the snippet below this can then be followed by version-less declarat
 ```gradle
 dependencies {
   implementation platform("org.springframework.ai:spring-grpc-dependencies:1.0.0-SNAPSHOT")
-  // Replace the following with the starter dependencies of specific modules you wish to use
-  implementation 'org.springframework.ai:spring-grpc-openai'
 }
 ```
 

samples/grpc-server-netty-shaded

@@ -0,0 +1 @@
+Subproject commit 3b1a5d8494dd0c322086f02e8939ba89a2f31666

samples/pom.xml

@@ -17,6 +17,7 @@
 
 	<modules>
 		<module>grpc-server</module>
+		<module>grpc-server-netty-shaded</module>
 		<module>grpc-tomcat</module>
 	</modules>
 

spring-grpc-docs/src/main/antora/modules/ROOT/pages/client.adoc

@@ -51,6 +51,7 @@ For Gradle users
 ----
 dependencies {
 	implementation "org.springframework.grpc:spring-grpc-spring-boot-starter"
+	implementation 'io.grpc:grpc-netty-shaded'
 	modules {
 		module("io.grpc:grpc-netty") {
 			replacedBy("io.grpc:grpc-netty-shaded", "Use Netty shaded instead of regular Netty")

spring-grpc-docs/src/main/antora/modules/ROOT/pages/server.adoc

@@ -47,6 +47,7 @@ For Gradle users
 ----
 dependencies {
 	implementation "org.springframework.grpc:spring-grpc-spring-boot-starter"
+	implementation 'io.grpc:grpc-netty-shaded'
 	modules {
 		module("io.grpc:grpc-netty") {
 			replacedBy("io.grpc:grpc-netty-shaded", "Use Netty shaded instead of regular Netty")

spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc

@@ -12,23 +12,23 @@
 |spring.grpc.client.default-channel.max-inbound-message-size |  | 
 |spring.grpc.client.default-channel.max-inbound-metadata-size |  | 
 |spring.grpc.client.default-channel.negotiation-type |  | The negotiation type for the channel. Default is {@link NegotiationType#PLAINTEXT}.
-|spring.grpc.client.default-channel.secure |  | Flag to say that strict SSL checks are not enabled (so the remote certificate could be anonymous).
+|spring.grpc.client.default-channel.secure | `+++true+++` | Flag to say that strict SSL checks are not enabled (so the remote certificate could be anonymous).
 |spring.grpc.client.default-channel.ssl.bundle |  | SSL bundle name.
 |spring.grpc.client.default-channel.ssl.enabled |  | Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise.
 |spring.grpc.client.default-channel.user-agent |  | 
 |spring.grpc.server.address |  | The address to bind to. could be a host:port combination or a pseudo URL like static://host:port. Can not be set if host or port are set independently.
-|spring.grpc.server.host |  | Server address to bind to. The default is any IP address ('*').
+|spring.grpc.server.host | `+++*+++` | Server address to bind to. The default is any IP address ('*').
 |spring.grpc.server.keep-alive.max-age |  | Maximum time a connection may exist before being gracefully terminated (default infinite).
 |spring.grpc.server.keep-alive.max-age-grace |  | Maximum time for graceful connection termination (default infinite).
 |spring.grpc.server.keep-alive.max-idle |  | Maximum time a connection can remain idle before being gracefully terminated (default infinite).
-|spring.grpc.server.keep-alive.permit-time |  | Maximum keep-alive time clients are permitted to configure (default 5m).
-|spring.grpc.server.keep-alive.permit-without-calls |  | Whether clients are permitted to send keep alive pings when there are no outstanding RPCs on the connection (default false).
-|spring.grpc.server.keep-alive.time |  | Duration without read activity before sending a keep alive ping (default 2h).
-|spring.grpc.server.keep-alive.timeout |  | Maximum time to wait for read activity after sending a keep alive ping. If sender does not receive an acknowledgment within this time, it will close the connection (default 20s).
-|spring.grpc.server.max-inbound-message-size |  | Maximum message size allowed to be received by the server (default 4MiB).
-|spring.grpc.server.max-inbound-metadata-size |  | Maximum metadata size allowed to be received by the server (default 8KiB).
-|spring.grpc.server.port |  | Server port to listen on. When the value is 0, a random available port is selected. The default is 9090.
-|spring.grpc.server.shutdown-grace-period |  | Maximum time to wait for the server to gracefully shutdown. When the value is negative, the server waits forever. When the value is 0, the server will force shutdown immediately. The default is 30 seconds.
+|spring.grpc.server.keep-alive.permit-time | `+++5m+++` | Maximum keep-alive time clients are permitted to configure (default 5m).
+|spring.grpc.server.keep-alive.permit-without-calls | `+++false+++` | Whether clients are permitted to send keep alive pings when there are no outstanding RPCs on the connection (default false).
+|spring.grpc.server.keep-alive.time | `+++2h+++` | Duration without read activity before sending a keep alive ping (default 2h).
+|spring.grpc.server.keep-alive.timeout | `+++20s+++` | Maximum time to wait for read activity after sending a keep alive ping. If sender does not receive an acknowledgment within this time, it will close the connection (default 20s).
+|spring.grpc.server.max-inbound-message-size | `+++4194304B+++` | Maximum message size allowed to be received by the server (default 4MiB).
+|spring.grpc.server.max-inbound-metadata-size | `+++8192B+++` | Maximum metadata size allowed to be received by the server (default 8KiB).
+|spring.grpc.server.port | `+++9090+++` | Server port to listen on. When the value is 0, a random available port is selected. The default is 9090.
+|spring.grpc.server.shutdown-grace-period | `+++30s+++` | Maximum time to wait for the server to gracefully shutdown. When the value is negative, the server waits forever. When the value is 0, the server will force shutdown immediately. The default is 30 seconds.
 |spring.grpc.server.ssl.bundle |  | SSL bundle name.
 |spring.grpc.server.ssl.enabled |  | Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise.
 

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

@@ -72,16 +72,4 @@ ServerBuilderCustomizers serverBuilderCustomizers(ObjectProvider<ServerBuilderCu
 		return new ServerBuilderCustomizers(customizers.orderedStream().toList());
 	}
 
-	@ConditionalOnBean(CompressorRegistry.class)
-	@Bean
-	ServerBuilderCustomizer<NettyServerBuilder> compressionServerConfigurer(CompressorRegistry registry) {
-		return builder -> builder.compressorRegistry(registry);
-	}
-
-	@ConditionalOnBean(DecompressorRegistry.class)
-	@Bean
-	ServerBuilderCustomizer<NettyServerBuilder> decompressionServerConfigurer(DecompressorRegistry registry) {
-		return builder -> builder.decompressorRegistry(registry);
-	}
-
 }

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

@@ -21,6 +21,7 @@
 import javax.net.ssl.KeyManagerFactory;
 
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -34,6 +35,8 @@
 import org.springframework.grpc.server.ShadedNettyGrpcServerFactory;
 
 import io.grpc.BindableService;
+import io.grpc.CompressorRegistry;
+import io.grpc.DecompressorRegistry;
 import io.grpc.netty.NettyServerBuilder;
 
 /**
@@ -67,6 +70,20 @@ ShadedNettyGrpcServerFactory shadedNettyGrpcServerFactory(GrpcServerProperties p
 			return factory;
 		}
 
+		@ConditionalOnBean(CompressorRegistry.class)
+		@Bean
+		ServerBuilderCustomizer<io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder> compressionServerConfigurer(
+				CompressorRegistry registry) {
+			return builder -> builder.compressorRegistry(registry);
+		}
+
+		@ConditionalOnBean(DecompressorRegistry.class)
+		@Bean
+		ServerBuilderCustomizer<io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder> decompressionServerConfigurer(
+				DecompressorRegistry registry) {
+			return builder -> builder.decompressorRegistry(registry);
+		}
+
 	}
 
 	@Configuration(proxyBeanMethods = false)
@@ -93,6 +110,18 @@ NettyGrpcServerFactory nettyGrpcServerFactory(GrpcServerProperties properties,
 			return factory;
 		}
 
+		@ConditionalOnBean(CompressorRegistry.class)
+		@Bean
+		ServerBuilderCustomizer<NettyServerBuilder> compressionServerConfigurer(CompressorRegistry registry) {
+			return builder -> builder.compressorRegistry(registry);
+		}
+
+		@ConditionalOnBean(DecompressorRegistry.class)
+		@Bean
+		ServerBuilderCustomizer<NettyServerBuilder> decompressionServerConfigurer(DecompressorRegistry registry) {
+			return builder -> builder.decompressorRegistry(registry);
+		}
+
 	}
 
 }