Fix ManagedChannelsImpl channel retrieval issue (#115)

DanielLiu1123 · web-flow · commit 8d064e9b272d · 2025-06-29T22:24:53.000+08:00
* fix: resolve ManagedChannelsImpl channel retrieval issue - Fix ManagedChannelsImpl to proactively create channels when not found in cache - Ensure channels are properly initialized and cached on demand - Resolves issue where getChannel() throws exception for configured channels Fixes #114 * fix: update ManagedChannels retrieval for User and Order services
diff --git a/examples/quick-start/src/main/java/grpcstarter/example/QuickStartApp.java b/examples/quick-start/src/main/java/grpcstarter/example/QuickStartApp.java
@@ -1,5 +1,6 @@
 package grpcstarter.example;
 
+import grpcstarter.client.ManagedChannels;
 import io.grpc.testing.protobuf.SimpleRequest;
 import io.grpc.testing.protobuf.SimpleServiceGrpc;
 import order.v1.GetOrdersByUserIdRequest;
@@ -42,4 +43,14 @@ ApplicationRunner runner(
             System.out.println("Orders: " + orders);
         };
     }
+
+    @Bean
+    UserServiceGrpc.UserServiceBlockingStub userStub(ManagedChannels channels) {
+        return UserServiceGrpc.newBlockingStub(channels.getChannel("channel-1"));
+    }
+
+    @Bean
+    OrderServiceGrpc.OrderServiceBlockingStub orderStub(ManagedChannels channels) {
+        return OrderServiceGrpc.newBlockingStub(channels.getChannel("channel-1"));
+    }
 }
diff --git a/examples/quick-start/src/main/resources/application.yaml b/examples/quick-start/src/main/resources/application.yaml
@@ -8,5 +8,5 @@ grpc:
     channels:
       - authority: localhost:${grpc.server.port}
         stubs: [ io.grpc.testing.** ]
-      - authority: 127.0.0.1:${grpc.server.port}
-        stubs: [ user.v1.**, order.v1.** ]
+      - name: channel-1
+        authority: 127.0.0.1:${grpc.server.port}
diff --git a/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/Cache.java b/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/Cache.java
@@ -4,7 +4,6 @@
 import static grpcstarter.client.Util.shutdownChannel;
 
 import io.grpc.ManagedChannel;
-import jakarta.annotation.Nullable;
 import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -18,7 +17,6 @@
 import java.util.stream.Collectors;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.util.StringUtils;
 
 /**
  * @author Freeman
@@ -39,11 +37,6 @@ private Cache() {
     private static final Map<GrpcClientProperties.Channel, ManagedChannel> cfgToChannel =
             Collections.synchronizedMap(new LinkedHashMap<>());
 
-    /**
-     * Cache channel name to ManagedChannel mapping.
-     */
-    private static final ConcurrentMap<String, ManagedChannel> nameToChannel = new ConcurrentHashMap<>();
-
     public static Set<Class<?>> getStubClasses() {
         return serviceToStubClasses.values().stream().flatMap(List::stream).collect(Collectors.toSet());
     }
@@ -63,18 +56,7 @@ public static void addStubClass(Class<?> stubClass) {
     public static ManagedChannel getOrSupplyChannel(
             GrpcClientProperties.Channel channelConfig, Supplier<ManagedChannel> channelSupplier) {
         // Do not close the channel if it already exists, it may be still in use
-        ManagedChannel channel = cfgToChannel.computeIfAbsent(channelConfig, k -> channelSupplier.get());
-
-        // Also cache by name
-        String channelName = channelConfig.getName();
-        if (!StringUtils.hasText(channelName)) {
-            throw new IllegalArgumentException(
-                    "Channel name must not be null or empty, authority: " + channelConfig.getAuthority());
-        }
-
-        nameToChannel.put(channelName, channel);
-
-        return channel;
+        return cfgToChannel.computeIfAbsent(channelConfig, k -> channelSupplier.get());
     }
 
     /**
@@ -97,18 +79,6 @@ public static void shutdownChannels() {
                     System.currentTimeMillis() - start);
         }
         cfgToChannel.clear();
-        nameToChannel.clear();
-    }
-
-    /**
-     * Get a ManagedChannel by name.
-     *
-     * @param name the channel name
-     * @return the managed channel, or null if not found
-     */
-    @Nullable
-    public static ManagedChannel getChannelByName(String name) {
-        return nameToChannel.get(name);
     }
 
     public static void clear() {
diff --git a/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/GrpcClientAutoConfiguration.java b/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/GrpcClientAutoConfiguration.java
@@ -3,6 +3,7 @@
 import static grpcstarter.client.Checker.checkUnusedConfig;
 
 import grpcstarter.server.GrpcServerShutdownEvent;
+import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.boot.CommandLineRunner;
@@ -48,8 +49,9 @@ public GrpcClientOptionsClientInterceptor grpcClientOptionsClientInterceptor() {
 
     @Bean
     @ConditionalOnMissingBean
-    public ManagedChannels grpcClientManagedChannels() {
-        return new ManagedChannelsImpl();
+    public ManagedChannels grpcClientManagedChannels(
+            BeanFactory beanFactory, GrpcClientProperties grpcClientProperties) {
+        return new ManagedChannelsImpl(beanFactory, grpcClientProperties);
     }
 
     @Bean
diff --git a/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/GrpcClientUtil.java b/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/GrpcClientUtil.java
@@ -166,7 +166,7 @@ static GrpcClientProperties.Refresh getRefresh(Environment environment) {
                 .orElseGet(GrpcClientProperties.Refresh::new);
     }
 
-    private static ManagedChannel createChannel(BeanFactory beanFactory, GrpcClientProperties.Channel channelConfig) {
+    static ManagedChannel createChannel(BeanFactory beanFactory, GrpcClientProperties.Channel channelConfig) {
         checkValid(channelConfig);
         return new GrpcChannelCreator(beanFactory, channelConfig).create();
     }
diff --git a/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/ManagedChannelsImpl.java b/grpc-boot-autoconfigure/grpc-client-boot-autoconfigure/src/main/java/grpcstarter/client/ManagedChannelsImpl.java
@@ -1,6 +1,7 @@
 package grpcstarter.client;
 
 import io.grpc.ManagedChannel;
+import org.springframework.beans.factory.BeanFactory;
 
 /**
  * Default implementation of {@link ManagedChannels}.
@@ -10,12 +11,20 @@
  */
 class ManagedChannelsImpl implements ManagedChannels {
 
+    private final BeanFactory beanFactory;
+    private final GrpcClientProperties properties;
+
+    ManagedChannelsImpl(BeanFactory beanFactory, GrpcClientProperties properties) {
+        this.beanFactory = beanFactory;
+        this.properties = properties;
+    }
+
     @Override
     public ManagedChannel getChannel(String name) {
-        ManagedChannel channel = Cache.getChannelByName(name);
-        if (channel == null) {
+        var channelConfig = Util.findChannelByName(name, properties);
+        if (channelConfig == null) {
             throw new IllegalArgumentException("No channel found with name: " + name);
         }
-        return channel;
+        return GrpcClientUtil.createChannel(beanFactory, channelConfig);
     }
 }
diff --git a/website/docs/40-configuration-properties.md b/website/docs/40-configuration-properties.md
@@ -80,56 +80,56 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| cert-chain| org.springframework.core.io.Resource| @see TlsChannelCredentials.Builder#getCertificateChain()| | | 
-| private-key| org.springframework.core.io.Resource| @see TlsChannelCredentials.Builder#getPrivateKey()| | | 
-| private-key-password| java.lang.String| @see TlsChannelCredentials.Builder#getPrivateKeyPassword()| | | 
+| cert-chain| org.springframework.core.io.Resource| | | | 
+| private-key| org.springframework.core.io.Resource| | | | 
+| private-key-password| java.lang.String| | | | 
 ### grpc.client.tls.trust-manager
 **Class:** `grpcstarter.client.GrpcClientProperties$Tls$TrustManager`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| root-certs| org.springframework.core.io.Resource| @see TlsChannelCredentials.Builder#getRootCertificates()| | | 
+| root-certs| org.springframework.core.io.Resource| | | | 
 ### grpc.client
 **Class:** `grpcstarter.client.GrpcClientProperties`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| authority| java.lang.String| Default authority. &lt;p&gt; e.g. localhost:8080 &lt;/p&gt;| | | 
-| base-packages| java.util.List&lt;java.lang.String&gt;| Base packages to scan for gRPC stubs. &lt;p&gt; This value will merge with \{@link EnableGrpcClients#basePackages}. &lt;p&gt; The advantage of using configuration is no need to introduce external annotations. &lt;/p&gt;| | | 
-| bean-definition-handler| java.lang.Class&lt;? extends grpcstarter.client.GrpcClientBeanDefinitionHandler&gt;| gRPC client bean definition handler, used to customize the bean definition before registering. &lt;p&gt; Use \{@link GrpcClientBeanDefinitionHandler} if not set. &lt;p&gt; Implementation must have a public no-args constructor. @since 3.4.3.1| | | 
-| channels| java.util.List&lt;grpcstarter.client.GrpcClientProperties$Channel&gt;| Channels configuration.| | | 
-| clients| java.util.List&lt;java.lang.Class&lt;? extends io.grpc.stub.AbstractStub&gt;&gt;| The clients used to register as Spring beans. &lt;p&gt; This value will merge with \{@link EnableGrpcClients#clients}. &lt;p&gt; &#x60;clients&#x60; and \{@link #basePackages} represent two different configuration methods. \{@link #basePackages} is through package scanning, and &#x60;clients&#x60; is through class name. &lt;p&gt; The &#x60;clients&#x60; configuration can avoid classpath scanning, resulting in faster startup, and it has better IDE support.| | | 
-| compression| java.lang.String| Compression configuration. @see AbstractStub#withCompression(String)| | | 
-| deadline| java.lang.Long| Deadline after in milliseconds, default value is 5000. @see AbstractStub#withDeadline(Deadline) @since 3.2.0| | | 
-| enabled| java.lang.Boolean| Whether to enable gRPC client autoconfiguration, default true.| true| | 
-| max-inbound-message-size| org.springframework.util.unit.DataSize| Default max inbound message size, default value is 4MB. @see DataSize @see GrpcUtil#DEFAULT_MAX_MESSAGE_SIZE| | | 
-| max-inbound-metadata-size| org.springframework.util.unit.DataSize| Default max metadata size, default value is 8KB. @see DataSize @see GrpcUtil#DEFAULT_MAX_HEADER_LIST_SIZE| | | 
-| max-outbound-message-size| org.springframework.util.unit.DataSize| Default max outbound message size. @see DataSize @see AbstractStub#withMaxOutboundMessageSize(int)| | | 
-| metadata| java.util.List&lt;grpcstarter.client.GrpcClientProperties$Metadata&gt;| Default metadata will be added to all the gRPC requests.| | | 
-| shutdown-timeout| java.lang.Long| Channel shutdown timeout in milliseconds, default value is 5000.| 5000| | 
-| ssl-bundle| java.lang.String| SSL bundle name to use for secure connections. &lt;p&gt;References an SSL bundle configured under \{@code spring.ssl.bundle.*}. This is the preferred way to configure SSL/TLS for gRPC clients. @since 3.5.3| | | 
-| warn-unused-config-enabled| java.lang.Boolean| Whether to enable warn unused config, default true.| true| | 
+| authority| java.lang.String| | | | 
+| base-packages| java.util.List&lt;java.lang.String&gt;| | | | 
+| bean-definition-handler| java.lang.Class&lt;? extends grpcstarter.client.GrpcClientBeanDefinitionHandler&gt;| | | | 
+| channels| java.util.List&lt;grpcstarter.client.GrpcClientProperties$Channel&gt;| | | | 
+| clients| java.util.List&lt;java.lang.Class&lt;? extends io.grpc.stub.AbstractStub&gt;&gt;| | | | 
+| compression| java.lang.String| | | | 
+| deadline| java.lang.Long| | | | 
+| enabled| java.lang.Boolean| | | | 
+| max-inbound-message-size| org.springframework.util.unit.DataSize| | | | 
+| max-inbound-metadata-size| org.springframework.util.unit.DataSize| | | | 
+| max-outbound-message-size| org.springframework.util.unit.DataSize| | | | 
+| metadata| java.util.List&lt;grpcstarter.client.GrpcClientProperties$Metadata&gt;| | | | 
+| shutdown-timeout| java.lang.Long| | | | 
+| ssl-bundle| java.lang.String| | | | 
+| warn-unused-config-enabled| java.lang.Boolean| | | | 
 ### grpc.client.in-process
 **Class:** `grpcstarter.client.GrpcClientProperties$InProcess`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| name| java.lang.String| In-process client name. &lt;p&gt; If set, will create an in-process channel by default, usually for testing. &lt;/p&gt;| | | 
+| name| java.lang.String| | | | 
 ### grpc.client.refresh
 **Class:** `grpcstarter.client.GrpcClientProperties$Refresh`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| Whether to enable refresh grpc clients, default false. &lt;p&gt; NOTE: this feature needs &#x27;spring-cloud-context&#x27; dependency in the classpath. &lt;/p&gt;| false| | 
+| enabled| java.lang.Boolean| | | | 
 ### grpc.client.retry
 **Class:** `grpcstarter.client.GrpcClientProperties$Retry`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| Whether to enable retry. @see io.grpc.ManagedChannelBuilder#enableRetry() @see io.grpc.ManagedChannelBuilder#disableRetry()| | | 
-| max-retry-attempts| java.lang.Integer| Maximum number of attempts to retry. @see io.grpc.ManagedChannelBuilder#maxRetryAttempts(int)| | | 
-| per-rpc-buffer-limit| org.springframework.util.unit.DataSize| The maximum number of retry buffer entries per RPC. @see io.grpc.ManagedChannelBuilder#perRpcBufferLimit(long)| | | 
-| retry-buffer-size| org.springframework.util.unit.DataSize| The maximum number of retry buffer entries. @see io.grpc.ManagedChannelBuilder#retryBufferSize(long)| | | 
+| enabled| java.lang.Boolean| | | | 
+| max-retry-attempts| java.lang.Integer| | | | 
+| per-rpc-buffer-limit| org.springframework.util.unit.DataSize| | | | 
+| retry-buffer-size| org.springframework.util.unit.DataSize| | | | 
 ### grpc.client.tls
 **Class:** `grpcstarter.client.GrpcClientProperties$Tls`
 
@@ -228,21 +228,21 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable metrics, default is \{@code true}| true| | 
+| enabled| java.lang.Boolean| | | | 
 ### grpc.metrics.client
 **Class:** `grpcstarter.extensions.metrics.GrpcMetricsProperties$Client`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable client metrics, default is \{@code true}| true| | 
-| order| java.lang.Integer| The order of the client metrics interceptor. Default is \{@code 0}.| 0| | 
+| enabled| java.lang.Boolean| | | | 
+| order| java.lang.Integer| | | | 
 ### grpc.metrics.server
 **Class:** `grpcstarter.extensions.metrics.GrpcMetricsProperties$Server`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable server metrics, default is \{@code true}| true| | 
-| order| java.lang.Integer| The order of the server metrics interceptor. Default is \{@code 0}.| 0| | 
+| enabled| java.lang.Boolean| | | | 
+| order| java.lang.Integer| | | | 
 
 ## grpc-test
 ### grpc.test
@@ -265,21 +265,21 @@ This page was generated by [spring-configuration-property-documenter](https://gi
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable tracing, default is \{@code true}| true| | 
+| enabled| java.lang.Boolean| | | | 
 ### grpc.tracing.client
 **Class:** `grpcstarter.extensions.tracing.GrpcTracingProperties$Client`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable client tracing, default is \{@code true}| true| | 
-| order| java.lang.Integer| The order of the client tracing interceptor. Default is \{@code 0}.| 0| | 
+| enabled| java.lang.Boolean| | | | 
+| order| java.lang.Integer| | | | 
 ### grpc.tracing.server
 **Class:** `grpcstarter.extensions.tracing.GrpcTracingProperties$Server`
 
 |Key|Type|Description|Default value|Deprecation|
 |---|----|-----------|-------------|-----------|
-| enabled| java.lang.Boolean| whether to enable server tracing, default is \{@code true}| true| | 
-| order| java.lang.Integer| The order of the server tracing interceptor. Default is \{@code 0}.| 0| | 
+| enabled| java.lang.Boolean| | | | 
+| order| java.lang.Integer| | | | 
 
 ## grpc-transcoding
 ### grpc.transcoding

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ static GrpcClientProperties.Refresh getRefresh(Environment environment) {`
`166`	`166`	`.orElseGet(GrpcClientProperties.Refresh::new);`
`167`	`167`	`}`
`168`	`168`
`169`		`- private static ManagedChannel createChannel(BeanFactory beanFactory, GrpcClientProperties.Channel channelConfig) {`
	`169`	`+ static ManagedChannel createChannel(BeanFactory beanFactory, GrpcClientProperties.Channel channelConfig) {`
`170`	`170`	`checkValid(channelConfig);`
`171`	`171`	`return new GrpcChannelCreator(beanFactory, channelConfig).create();`
`172`	`172`	`}`