Spring/spring-grpc
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Split bean registration and creation for stubs

Browse Source 
GrpcClientRegistry was responsible for both, which causes lifecycle
issues when users don't follow recommendations. This change
pushes the bean registration firmly down a level into an
ImportBeanDefinitionRegistrar. Also helps with AOT because the AOT
processor only runs the IBDR at build time.
This commit is contained in:
Dave Syer
2025-04-01 11:49:59 +01:00
parent 326c075b36
commit a3d7ba643d
13 changed files with 437 additions and 492 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
spring-grpc-spring-boot-autoconfigure/src/main/java/org/springframework/grpc/autoconfigure/client/ClientScanConfiguration.java
View File

@@ -18,38 +18,69 @@ package org.springframework.grpc.autoconfigure.client;
import java.util.ArrayList;
import java.util.List;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.grpc.autoconfigure.client.ClientScanConfiguration.DefaultGrpcClientRegistrations;
import org.springframework.grpc.autoconfigure.client.GrpcClientProperties.ChannelConfig;
import org.springframework.grpc.client.AbstractGrpcClientRegistrar;
import org.springframework.grpc.client.BlockingStubFactory;
import org.springframework.grpc.client.GrpcClientFactory;
import org.springframework.grpc.client.GrpcClientFactory.GrpcClientRegistrationSpec;
import org.springframework.grpc.client.GrpcClientFactoryPostProcessor;
import org.springframework.grpc.client.ImportGrpcClients;
import org.springframework.grpc.client.GrpcClientRegistryCustomizer;
import org.springframework.grpc.client.GrpcClientRegistryPostProcessor;
@Configuration(proxyBeanMethods = false)
@ConditionalOnMissingBean(GrpcClientRegistryPostProcessor.class)
@ConditionalOnMissingBean(GrpcClientFactoryPostProcessor.class)
@ImportGrpcClients
@Import(DefaultGrpcClientRegistrations.class)
public class ClientScanConfiguration {
@Bean
public GrpcClientRegistryCustomizer defaultGrpcClientRegistryCustomizer(BeanFactory beanFactory,
Environment environment) {
List<String> packages = new ArrayList<>();
if (AutoConfigurationPackages.has(beanFactory)) {
packages.addAll(AutoConfigurationPackages.get(beanFactory));
static class DefaultGrpcClientRegistrations extends AbstractGrpcClientRegistrar
implements EnvironmentAware, BeanFactoryAware {
private Environment environment;
private BeanFactory beanFactory;
@Override
public void setEnvironment(Environment environment) {
this.environment = environment;
}
Binder binder = Binder.get(environment);
boolean hasDefaultChannel = binder.bind("spring.grpc.client.default-channel", ChannelConfig.class).isBound();
return registry -> {
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
this.beanFactory = beanFactory;
}
@Override
protected GrpcClientRegistrationSpec[] collect(AnnotationMetadata meta) {
Binder binder = Binder.get(environment);
boolean hasDefaultChannel = binder.bind("spring.grpc.client.default-channel", ChannelConfig.class)
.isBound();
if (hasDefaultChannel) {
registry.channel("default").scan(BlockingStubFactory.class).packages(packages.toArray(new String[0]));
List<String> packages = new ArrayList<>();
if (AutoConfigurationPackages.has(beanFactory)) {
packages.addAll(AutoConfigurationPackages.get(beanFactory));
}
// TODO: change global default factory type in properties maybe?
return new GrpcClientRegistrationSpec[] { GrpcClientRegistrationSpec.of("default")
.factory(BlockingStubFactory.class)
.packages(packages.toArray(new String[0])) };
}
};
return new GrpcClientRegistrationSpec[0];
}
}
}