Add GrpcClientBean annotations for single and multiple application context registration

Author: a-simeshin

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/inject/GrpcClientBean.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.client.inject;
+
+import java.lang.annotation.*;
+
+/**
+ * Annotation that can be added to `@Configuration` classes to create GrpcClient bean in the ApplicationContext.
+ */
+@Target(ElementType.TYPE)
+@Repeatable(GrpcClientBeans.class)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface GrpcClientBean {
+
+    /**
+     * The type of the bean to create.
+     */
+    Class<?> clazz();
+
+    /**
+     * The name of the bean to create. If empty, a name will be generated automatically based on the bean class and the
+     * client name.
+     */
+    String beanName() default "";
+
+    /**
+     * The client definition used to create the channel and grab all properties.
+     */
+    GrpcClient client();
+}

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/inject/GrpcClientBeanPostProcessor.java

@@ -19,7 +19,6 @@
 
 import static java.util.Objects.requireNonNull;
 
-import java.beans.Introspector;
 import java.lang.reflect.Field;
 import java.lang.reflect.Member;
 import java.lang.reflect.Method;
@@ -102,6 +101,22 @@ public Object postProcessBeforeInitialization(final Object bean, final String be
                             processInjectionPoint(method, paramTypes[0], annotation));
                 }
             }
+
+            for (final GrpcClientBean beanClientIterator : clazz.getAnnotationsByType(GrpcClientBean.class)) {
+                final String beanNameToCreate = beanClientIterator.beanName().isEmpty()
+                        ? beanClientIterator.client().value() + beanClientIterator.clazz().getSimpleName()
+                        : beanClientIterator.beanName();
+                try {
+                    final ConfigurableListableBeanFactory beanFactory =
+                            ((ConfigurableApplicationContext) this.applicationContext).getBeanFactory();
+                    final Object beanValue =
+                            processInjectionPoint(null, beanClientIterator.clazz(), beanClientIterator.client());
+                    beanFactory.registerSingleton(beanNameToCreate, beanValue);
+                } catch (final Exception e) {
+                    log.warn("Could not register and autowire bean: {}", beanNameToCreate, e);
+                }
+            }
+
             clazz = clazz.getSuperclass();
         } while (clazz != null);
         return bean;
@@ -136,16 +151,6 @@ protected <T> T processInjectionPoint(final Member injectionTarget, final Class<
                     "Injection value is null unexpectedly for " + name + " at " + injectionTarget);
         }
 
-        try {
-            final ConfigurableListableBeanFactory beanFactory =
-                    ((ConfigurableApplicationContext) applicationContext).getBeanFactory();
-            beanFactory.registerSingleton(Introspector.decapitalize(injectionType.getSimpleName()), value);
-            applicationContext.getAutowireCapableBeanFactory().autowireBean(value);
-        } catch (Exception e) {
-            log.warn("Could not register and autowire bean: {}",
-                    Introspector.decapitalize(injectionType.getSimpleName()));
-        }
-
         return value;
     }
 
@@ -239,8 +244,13 @@ protected <T> T valueForMember(final String name, final Member injectionTarget,
             }
             return injectionType.cast(stub);
         } else {
-            throw new InvalidPropertyException(injectionTarget.getDeclaringClass(), injectionTarget.getName(),
-                    "Unsupported type " + injectionType.getName());
+            if (injectionTarget != null) {
+                throw new InvalidPropertyException(injectionTarget.getDeclaringClass(), injectionTarget.getName(),
+                        "Unsupported type " + injectionType.getName());
+            } else {
+                throw new InvalidPropertyException(injectionType.getDeclaringClass(), injectionType.getName(),
+                        "Unsupported type " + injectionType.getName());
+            }
         }
     }
 

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/inject/GrpcClientBeans.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.client.inject;
+
+import java.lang.annotation.*;
+
+/**
+ * Annotation that can be added to `@Configuration` classes to create `GrpcClientBean` beans in the ApplicationContext.
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface GrpcClientBeans {
+
+    /**
+     * Array of bean declarations
+     */
+    GrpcClientBean[] value();
+}

tests/src/test/java/net/devh/boot/grpc/test/inject/GrpcClientAutoWiringFieldAndMethodInjectionTest.java renamed to tests/src/test/java/net/devh/boot/grpc/test/inject/GrpcClientBeanInjectionTest.java

@@ -19,8 +19,6 @@
 
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
-import javax.annotation.PostConstruct;
-
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
@@ -33,6 +31,8 @@
 import io.grpc.stub.AbstractStub;
 import lombok.extern.slf4j.Slf4j;
 import net.devh.boot.grpc.client.inject.GrpcClient;
+import net.devh.boot.grpc.client.inject.GrpcClientBean;
+import net.devh.boot.grpc.client.inject.GrpcClientBeans;
 import net.devh.boot.grpc.client.stubfactory.StandardJavaGrpcStubFactory;
 import net.devh.boot.grpc.client.stubfactory.StubFactory;
 import net.devh.boot.grpc.test.config.BaseAutoConfiguration;
@@ -47,37 +47,92 @@
 @SpringBootTest
 @SpringJUnitConfig(
         classes = {
-                GrpcClientAutoWiringFieldAndMethodInjectionTest.TestConfig.class,
-                GrpcClientAutoWiringFieldAndMethodInjectionTest.TestConfig2.class,
+                GrpcClientBeanInjectionTest.TestConfig.class,
                 InProcessConfiguration.class,
                 ServiceConfiguration.class,
                 BaseAutoConfiguration.class
         })
 @DirtiesContext
-public class GrpcClientAutoWiringFieldAndMethodInjectionTest {
+public class GrpcClientBeanInjectionTest {
+
+    @Autowired
+    TestServiceGrpc.TestServiceBlockingStub blockingStub;
+
+    @Autowired
+    TestServiceGrpc.TestServiceFutureStub futureStubForClientTest;
+
+    @Autowired
+    TestServiceGrpc.TestServiceBlockingStub anotherBlockingStub;
+
+    @Autowired
+    TestServiceGrpc.TestServiceBlockingStub unnamedTestServiceBlockingStub;
 
     @Autowired
-    @Qualifier("testServiceBlockingStub")
-    TestServiceGrpc.TestServiceBlockingStub testServiceBlockingStub; // created in TestConfig with @GrpcClient
+    CustomGrpc.FactoryMethodAccessibleStub anotherServiceClientBean;
 
     @Autowired
-    String aboutBlockingStubBean; // created in TestConfig2 with method injection
+    String aboutMethodInjectedBlockingStubBean;
+
+    @Test
+    void singleContextInjectionTest() {
+        assertNotNull(blockingStub, "blockingStub");
+    }
+
+    @Test
+    void anotherSubTypeAndSameClientDefinitionTest() {
+        assertNotNull(futureStubForClientTest, "futureStubForClientTest");
+    }
+
+    @Test
+    void twoDifferentClientDefinitionsTest() {
+        assertNotNull(anotherBlockingStub, "blockingStub");
+    }
 
     @Test
-    void fieldInjectionAutoWiringTest() {
-        assertNotNull(testServiceBlockingStub, "testServiceBlockingStub");
+    void unnamedBeanContextInjectionTest() {
+        assertNotNull(unnamedTestServiceBlockingStub, "unnamedTestServiceBlockingStub");
     }
 
     @Test
-    void methodInjectionAutoWiringTest() {
-        assertNotNull(aboutBlockingStubBean, "aboutBlockingStubBean");
+    void autoWiringQualifierMethodInjectionFromContextTest() {
+        assertNotNull(aboutMethodInjectedBlockingStubBean, "aboutBlockingStubBean");
+    }
+
+    @Test
+    void anotherGrpcServiceAndSameGrpcClientDefinitionTest() {
+        assertNotNull(anotherServiceClientBean, "anotherServiceClientBean");
     }
 
     @TestConfiguration
+    @GrpcClientBeans(value = {
+            @GrpcClientBean(
+                    clazz = TestServiceGrpc.TestServiceBlockingStub.class,
+                    beanName = "blockingStub",
+                    client = @GrpcClient("test")),
+            @GrpcClientBean(
+                    clazz = TestServiceGrpc.TestServiceFutureStub.class,
+                    beanName = "futureStubForClientTest",
+                    client = @GrpcClient("test")),
+            @GrpcClientBean(
+                    clazz = TestServiceGrpc.TestServiceBlockingStub.class,
+                    beanName = "anotherBlockingStub",
+                    client = @GrpcClient("anotherTest")),
+            @GrpcClientBean(
+                    clazz = TestServiceGrpc.TestServiceBlockingStub.class,
+                    client = @GrpcClient("unnamed")),
+            @GrpcClientBean(
+                    clazz = CustomGrpc.FactoryMethodAccessibleStub.class,
+                    beanName = "anotherServiceClientBean",
+                    client = @GrpcClient("test"))
+    })
     public static class TestConfig {
 
-        @GrpcClient("test")
-        TestServiceGrpc.TestServiceBlockingStub blockingStub;
+        @Bean
+        public String aboutMethodInjectedBlockingStubBean(
+                @Autowired
+                @Qualifier("anotherBlockingStub") TestServiceGrpc.TestServiceBlockingStub blockingStub) {
+            return blockingStub.toString();
+        }
 
         @Bean
         StubFactory customStubFactory() {
@@ -95,21 +150,5 @@ protected String getFactoryMethodName() {
 
             };
         }
-
-        @PostConstruct
-        public void init() {
-            assertNotNull(this.blockingStub, "blockingStub");
-        }
     }
-
-    @TestConfiguration
-    public static class TestConfig2 {
-
-        @Bean
-        public String aboutBlockingStubBean(
-                @Autowired @Qualifier("testServiceBlockingStub") TestServiceGrpc.TestServiceBlockingStub blockingStub) {
-            return blockingStub.toString();
-        }
-    }
-
 }