diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/AbstractLoadBalancerBlockingBuilderBeanPostProcessor.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/AbstractLoadBalancerBlockingBuilderBeanPostProcessor.java new file mode 100644 index 00000000..89de2377 --- /dev/null +++ b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/AbstractLoadBalancerBlockingBuilderBeanPostProcessor.java @@ -0,0 +1,66 @@ +/* + * Copyright 2012-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.client.loadbalancer; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.beans.factory.config.BeanPostProcessor; +import org.springframework.context.ApplicationContext; +import org.springframework.http.client.ClientHttpRequestInterceptor; + +/** + * A {@link BeanPostProcessor} that adds the provided {@link ClientHttpRequestInterceptor} + * to bean instances annotated with {@link LoadBalanced}. + * + * @author Olga Maciaszek-Sharma + * @since 4.2.0 + */ +public abstract class AbstractLoadBalancerBlockingBuilderBeanPostProcessor + implements BeanPostProcessor { + + protected final ObjectProvider loadBalancerInterceptorProvider; + + protected final ApplicationContext context; + + AbstractLoadBalancerBlockingBuilderBeanPostProcessor(ObjectProvider loadBalancerInterceptorProvider, + ApplicationContext context) { + this.loadBalancerInterceptorProvider = loadBalancerInterceptorProvider; + this.context = context; + } + + @Override + public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { + // a separate call to verify supported type before searching for annotation for + // performance reasons + if (isSupported(bean)) { + if (context.findAnnotationOnBean(beanName, LoadBalanced.class) == null) { + return bean; + } + ClientHttpRequestInterceptor interceptor = loadBalancerInterceptorProvider.getIfAvailable(); + if (interceptor == null) { + throw new IllegalStateException(ClientHttpRequestInterceptor.class.getSimpleName() + " not available."); + } + bean = apply(bean, interceptor); + } + return bean; + } + + protected abstract Object apply(Object bean, ClientHttpRequestInterceptor interceptor); + + protected abstract boolean isSupported(Object bean); + +} diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerAutoConfiguration.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerAutoConfiguration.java index 877f674a..6f7ed529 100644 --- a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerAutoConfiguration.java +++ b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerAutoConfiguration.java @@ -101,6 +101,15 @@ public class LoadBalancerAutoConfiguration { return new LoadBalancerRestClientBuilderBeanPostProcessor<>(loadBalancerInterceptorProvider, context); } + @Bean + @ConditionalOnBean(DeferringLoadBalancerInterceptor.class) + @ConditionalOnMissingBean(LoadBalancerRestTemplateBuilderBeanPostProcessor.class) + static LoadBalancerRestTemplateBuilderBeanPostProcessor lbRestTemplateBuilderPostProcessor( + ObjectProvider loadBalancerInterceptorProvider, + ApplicationContext context) { + return new LoadBalancerRestTemplateBuilderBeanPostProcessor<>(loadBalancerInterceptorProvider, context); + } + } @AutoConfiguration diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestClientBuilderBeanPostProcessor.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestClientBuilderBeanPostProcessor.java index 0e4bfe64..0fae7807 100644 --- a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestClientBuilderBeanPostProcessor.java +++ b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestClientBuilderBeanPostProcessor.java @@ -16,63 +16,57 @@ package org.springframework.cloud.client.loadbalancer; -import org.springframework.beans.BeansException; import org.springframework.beans.factory.ObjectProvider; -import org.springframework.beans.factory.config.BeanPostProcessor; import org.springframework.context.ApplicationContext; import org.springframework.http.client.ClientHttpRequestInterceptor; import org.springframework.web.client.RestClient; /** - * A {@link BeanPostProcessor} that adds the provided {@link ClientHttpRequestInterceptor} - * to all {@link RestClient.Builder} instances annotated with {@link LoadBalanced}. + * {@link RestClient.Builder}-specific + * {@link AbstractLoadBalancerBlockingBuilderBeanPostProcessor} implementation. Adds the + * provided {@link ClientHttpRequestInterceptor} to all {@link RestClient.Builder} + * instances annotated with {@link LoadBalanced}. * * @author Olga Maciaszek-Sharma * @since 4.1.0 */ public class LoadBalancerRestClientBuilderBeanPostProcessor - implements BeanPostProcessor { - - private final ObjectProvider loadBalancerInterceptorProvider; - - private final ApplicationContext context; + extends AbstractLoadBalancerBlockingBuilderBeanPostProcessor { /** - * Creates a {@link LoadBalancerRestClientBuilderBeanPostProcessor} instance using a provided {@link ClientHttpRequestInterceptor} and application context. - * @param loadBalancerInterceptor a {@link ClientHttpRequestInterceptor} used for load-balancing + * Creates a {@link LoadBalancerRestClientBuilderBeanPostProcessor} instance using a + * provided {@link ClientHttpRequestInterceptor} and application context. + * @param loadBalancerInterceptor a {@link ClientHttpRequestInterceptor} used for + * load-balancing * @param context {@link ApplicationContext} - * @deprecated in favour of {@link LoadBalancerRestClientBuilderBeanPostProcessor#LoadBalancerRestClientBuilderBeanPostProcessor(ObjectProvider, ApplicationContext)} + * @deprecated in favour of + * {@link LoadBalancerRestClientBuilderBeanPostProcessor#LoadBalancerRestClientBuilderBeanPostProcessor(ObjectProvider, ApplicationContext)} */ @Deprecated(forRemoval = true) public LoadBalancerRestClientBuilderBeanPostProcessor(T loadBalancerInterceptor, ApplicationContext context) { - this.loadBalancerInterceptorProvider = new SimpleObjectProvider<>(loadBalancerInterceptor); - this.context = context; + this(new SimpleObjectProvider<>(loadBalancerInterceptor), context); } /** - * Creates a {@link LoadBalancerRestClientBuilderBeanPostProcessor} instance using interceptor {@link ObjectProvider} and application context. - * @param loadBalancerInterceptorProvider an {@link ObjectProvider} for {@link ClientHttpRequestInterceptor} used for load-balancing + * Creates a {@link LoadBalancerRestClientBuilderBeanPostProcessor} instance using + * interceptor {@link ObjectProvider} and application context. + * @param loadBalancerInterceptorProvider an {@link ObjectProvider} for + * {@link ClientHttpRequestInterceptor} used for load-balancing * @param context {@link ApplicationContext} */ public LoadBalancerRestClientBuilderBeanPostProcessor(ObjectProvider loadBalancerInterceptorProvider, ApplicationContext context) { - this.loadBalancerInterceptorProvider = loadBalancerInterceptorProvider; - this.context = context; + super(loadBalancerInterceptorProvider, context); } @Override - public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { - if (bean instanceof RestClient.Builder) { - if (context.findAnnotationOnBean(beanName, LoadBalanced.class) == null) { - return bean; - } - ClientHttpRequestInterceptor interceptor = loadBalancerInterceptorProvider.getIfAvailable(); - if (interceptor == null) { - throw new IllegalStateException(ClientHttpRequestInterceptor.class.getSimpleName() + " not available."); - } - ((RestClient.Builder) bean).requestInterceptor(interceptor); - } - return bean; + protected Object apply(Object bean, ClientHttpRequestInterceptor interceptor) { + return ((RestClient.Builder) bean).requestInterceptor(interceptor); + } + + @Override + protected boolean isSupported(Object bean) { + return bean instanceof RestClient.Builder; } } diff --git a/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestTemplateBuilderBeanPostProcessor.java b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestTemplateBuilderBeanPostProcessor.java new file mode 100644 index 00000000..5dc46d11 --- /dev/null +++ b/spring-cloud-commons/src/main/java/org/springframework/cloud/client/loadbalancer/LoadBalancerRestTemplateBuilderBeanPostProcessor.java @@ -0,0 +1,51 @@ +/* + * Copyright 2012-2024 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.cloud.client.loadbalancer; + +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.boot.web.client.RestTemplateBuilder; +import org.springframework.context.ApplicationContext; +import org.springframework.http.client.ClientHttpRequestInterceptor; + +/** + * {@link RestTemplateBuilder}-specific + * {@link AbstractLoadBalancerBlockingBuilderBeanPostProcessor} implementation. Adds the + * provided {@link ClientHttpRequestInterceptor} to all {@link RestTemplateBuilder} + * instances annotated with {@link LoadBalanced}. + * + * @author Olga Maciaszek-Sharma + * @since 4.2.0 + */ +public class LoadBalancerRestTemplateBuilderBeanPostProcessor + extends AbstractLoadBalancerBlockingBuilderBeanPostProcessor { + + public LoadBalancerRestTemplateBuilderBeanPostProcessor(ObjectProvider loadBalancerInterceptorProvider, + ApplicationContext context) { + super(loadBalancerInterceptorProvider, context); + } + + @Override + protected boolean isSupported(Object bean) { + return bean instanceof RestTemplateBuilder; + } + + @Override + protected Object apply(Object bean, ClientHttpRequestInterceptor interceptor) { + return ((RestTemplateBuilder) bean).interceptors(interceptor); + } + +}