Add GrpcClient soft bean registration and autowiring

Author: a-simeshin

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

@@ -19,6 +19,7 @@
 
 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;
@@ -32,7 +33,9 @@
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.BeanDefinitionStoreException;
 import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.context.ApplicationContext;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.ReflectionUtils;
 
@@ -41,6 +44,7 @@
 import io.grpc.Channel;
 import io.grpc.ClientInterceptor;
 import io.grpc.stub.AbstractStub;
+import lombok.extern.slf4j.Slf4j;
 import net.devh.boot.grpc.client.channelfactory.GrpcChannelFactory;
 import net.devh.boot.grpc.client.nameresolver.NameResolverRegistration;
 import net.devh.boot.grpc.client.stubfactory.FallbackStubFactory;
@@ -53,6 +57,7 @@
  * @author Michael ([email protected])
  * @author Daniel Theuke ([email protected])
  */
+@Slf4j
 public class GrpcClientBeanPostProcessor implements BeanPostProcessor {
 
     private final ApplicationContext applicationContext;
@@ -130,6 +135,17 @@ protected <T> T processInjectionPoint(final Member injectionTarget, final Class<
             throw new IllegalStateException(
                     "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;
     }
 
@@ -233,9 +249,9 @@ protected <T> T valueForMember(final String name, final Member injectionTarget,
      *
      * @param stubClass The stub class that needs to be created.
      * @param channel The gRPC channel associated with the created stub, passed as a parameter to the stub factory.
+     * @return A newly created gRPC stub.
      * @throws BeanInstantiationException If the stub couldn't be created, either because the type isn't supported or
      *         because of a failure in creation.
-     * @return A newly created gRPC stub.
      */
     private AbstractStub<?> createStub(final Class<? extends AbstractStub<?>> stubClass, final Channel channel) {
         final StubFactory factory = getStubFactories().stream()

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

@@ -0,0 +1,115 @@
+/*
+ * 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.test.inject;
+
+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;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
+
+import io.grpc.stub.AbstractStub;
+import lombok.extern.slf4j.Slf4j;
+import net.devh.boot.grpc.client.inject.GrpcClient;
+import net.devh.boot.grpc.client.stubfactory.StandardJavaGrpcStubFactory;
+import net.devh.boot.grpc.client.stubfactory.StubFactory;
+import net.devh.boot.grpc.test.config.BaseAutoConfiguration;
+import net.devh.boot.grpc.test.config.InProcessConfiguration;
+import net.devh.boot.grpc.test.config.ServiceConfiguration;
+import net.devh.boot.grpc.test.proto.TestServiceGrpc;
+
+/**
+ * Test case should cover auto wiring with field and method injection
+ */
+@Slf4j
+@SpringBootTest
+@SpringJUnitConfig(
+        classes = {
+                GrpcClientAutoWiringFieldAndMethodInjectionTest.TestConfig.class,
+                GrpcClientAutoWiringFieldAndMethodInjectionTest.TestConfig2.class,
+                InProcessConfiguration.class,
+                ServiceConfiguration.class,
+                BaseAutoConfiguration.class
+        })
+@DirtiesContext
+public class GrpcClientAutoWiringFieldAndMethodInjectionTest {
+
+    @Autowired
+    @Qualifier("testServiceBlockingStub")
+    TestServiceGrpc.TestServiceBlockingStub testServiceBlockingStub; // created in TestConfig with @GrpcClient
+
+    @Autowired
+    String aboutBlockingStubBean; // created in TestConfig2 with method injection
+
+    @Test
+    void fieldInjectionAutoWiringTest() {
+        assertNotNull(testServiceBlockingStub, "testServiceBlockingStub");
+    }
+
+    @Test
+    void methodInjectionAutoWiringTest() {
+        assertNotNull(aboutBlockingStubBean, "aboutBlockingStubBean");
+    }
+
+    @TestConfiguration
+    public static class TestConfig {
+
+        @GrpcClient("test")
+        TestServiceGrpc.TestServiceBlockingStub blockingStub;
+
+        @Bean
+        StubFactory customStubFactory() {
+            return new StandardJavaGrpcStubFactory() {
+
+                @Override
+                public boolean isApplicable(final Class<? extends AbstractStub<?>> stubType) {
+                    return CustomStub.class.isAssignableFrom(stubType);
+                }
+
+                @Override
+                protected String getFactoryMethodName() {
+                    return "custom";
+                }
+
+            };
+        }
+
+        @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();
+        }
+    }
+
+}