Add @GrpcAdvice exception handling support

Closes gh-49053

Author: philwebb

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

@@ -38,6 +38,10 @@
 import org.springframework.grpc.server.GlobalServerInterceptor;
 import org.springframework.grpc.server.GrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
+import org.springframework.grpc.server.advice.GrpcAdvice;
+import org.springframework.grpc.server.advice.GrpcAdviceDiscoverer;
+import org.springframework.grpc.server.advice.GrpcAdviceExceptionHandler;
+import org.springframework.grpc.server.advice.GrpcExceptionHandlerMethodResolver;
 import org.springframework.grpc.server.exception.CompositeGrpcExceptionHandler;
 import org.springframework.grpc.server.exception.GrpcExceptionHandler;
 import org.springframework.grpc.server.exception.GrpcExceptionHandlerInterceptor;
@@ -91,7 +95,8 @@ DefaultGrpcServiceDiscoverer grpcServiceDiscoverer(ApplicationContext applicatio
 	@Bean
 	@GlobalServerInterceptor
 	@ConditionalOnMissingBean
-	GrpcExceptionHandlerInterceptor globalExceptionHandlerInterceptor(List<GrpcExceptionHandler> exceptionHandlers) {
+	GrpcExceptionHandlerInterceptor grpcGlobalExceptionHandlerInterceptor(
+			List<GrpcExceptionHandler> exceptionHandlers) {
 		CompositeGrpcExceptionHandler compositeHandler = new CompositeGrpcExceptionHandler(
 				exceptionHandlers.toArray(GrpcExceptionHandler[]::new));
 		return new GrpcExceptionHandlerInterceptor(compositeHandler);
@@ -104,4 +109,30 @@ static class ReactiveStubConfiguration {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnBean(annotation = GrpcAdvice.class)
+	static class GrpcAdviceConfiguration {
+
+		@Bean
+		@ConditionalOnMissingBean
+		GrpcAdviceDiscoverer grpcAdviceDiscoverer(ApplicationContext applicationContext) {
+			return new GrpcAdviceDiscoverer(applicationContext);
+		}
+
+		@Bean
+		@ConditionalOnMissingBean
+		GrpcExceptionHandlerMethodResolver grpcExceptionHandlerMethodResolver(
+				GrpcAdviceDiscoverer grpcAdviceDiscoverer) {
+			return new GrpcExceptionHandlerMethodResolver(grpcAdviceDiscoverer);
+		}
+
+		@Bean
+		@ConditionalOnMissingBean
+		GrpcAdviceExceptionHandler grpcAdviceExceptionHandler(
+				GrpcExceptionHandlerMethodResolver grpcExceptionHandlerMethodResolver) {
+			return new GrpcAdviceExceptionHandler(grpcExceptionHandlerMethodResolver);
+		}
+
+	}
+
 }

module/spring-boot-grpc-server/src/test/java/org/springframework/boot/grpc/server/autoconfigure/GrpcServerAutoConfigurationTests.java

@@ -21,6 +21,8 @@
 import io.grpc.BindableService;
 import io.grpc.ServerServiceDefinition;
 import io.grpc.ServiceDescriptor;
+import io.grpc.Status;
+import io.grpc.StatusException;
 import io.grpc.inprocess.InProcessServerBuilder;
 import io.grpc.internal.GrpcUtil;
 import io.grpc.netty.NettyServerBuilder;
@@ -36,6 +38,7 @@
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.autoconfigure.ssl.SslAutoConfiguration;
 import org.springframework.boot.grpc.server.GrpcServletRegistration;
+import org.springframework.boot.grpc.server.autoconfigure.GrpcServerAutoConfiguration.GrpcAdviceConfiguration;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.assertj.ApplicationContextAssertProvider;
 import org.springframework.boot.test.context.runner.AbstractApplicationContextRunner;
@@ -51,6 +54,11 @@
 import org.springframework.grpc.server.NettyGrpcServerFactory;
 import org.springframework.grpc.server.ServerBuilderCustomizer;
 import org.springframework.grpc.server.ShadedNettyGrpcServerFactory;
+import org.springframework.grpc.server.advice.GrpcAdvice;
+import org.springframework.grpc.server.advice.GrpcAdviceDiscoverer;
+import org.springframework.grpc.server.advice.GrpcAdviceExceptionHandler;
+import org.springframework.grpc.server.advice.GrpcExceptionHandler;
+import org.springframework.grpc.server.advice.GrpcExceptionHandlerMethodResolver;
 import org.springframework.grpc.server.lifecycle.GrpcServerLifecycle;
 import org.springframework.grpc.server.service.DefaultGrpcServiceDiscoverer;
 import org.springframework.grpc.server.service.GrpcServiceDiscoverer;
@@ -469,6 +477,43 @@ void whenHttp2EnabledPropertyMissingAndValidationDisabled() {
 
 	}
 
+	@Nested
+	class GrpcAdviceAutoConfigurationTests {
+
+		private final ApplicationContextRunner contextRunner = GrpcServerAutoConfigurationTests.this.contextRunner;
+
+		@Test
+		void whenNoAdviceDoesNotCreateBeans() {
+			this.contextRunner.run((context) -> {
+				assertThat(context).doesNotHaveBean(GrpcAdviceConfiguration.class);
+				assertThat(context).doesNotHaveBean(GrpcAdviceDiscoverer.class);
+				assertThat(context).doesNotHaveBean(GrpcExceptionHandlerMethodResolver.class);
+				assertThat(context).doesNotHaveBean(GrpcAdviceExceptionHandler.class);
+			});
+		}
+
+		@Test
+		void whenHasAdviceCreatesBeans() {
+			this.contextRunner.withBean(GrpAdviceComponent.class).run((context) -> {
+				assertThat(context).hasSingleBean(GrpcAdviceConfiguration.class);
+				assertThat(context).hasSingleBean(GrpcAdviceDiscoverer.class);
+				assertThat(context).hasSingleBean(GrpcExceptionHandlerMethodResolver.class);
+				assertThat(context).hasSingleBean(GrpcAdviceExceptionHandler.class);
+			});
+		}
+
+		@GrpcAdvice
+		static class GrpAdviceComponent {
+
+			@GrpcExceptionHandler
+			StatusException onIllegalStateException(IllegalStateException ex) {
+				return Status.FAILED_PRECONDITION.withDescription(ex.getMessage()).withCause(ex).asException();
+			}
+
+		}
+
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class ServerBuilderCustomizersConfig {