Optimize: add EncodeTransferMedataRestTemplateInterceptor to RestTemp… (#434)

CHANGELOG.md

@@ -4,3 +4,4 @@
 - [Bugfix: optimize ratelimit actuator](https://github.com/Tencent/spring-cloud-tencent/pull/413)
 - [Feature: add rate limit filter debug log](https://github.com/Tencent/spring-cloud-tencent/pull/417)
 - [Feature: add feature-env plugin & add spring cloud gateway staining plugin](https://github.com/Tencent/spring-cloud-tencent/pull/428)
+- [Optimize: add EncodeTransferMedataRestTemplateInterceptor to RestTemplate](https://github.com/Tencent/spring-cloud-tencent/pull/434)

spring-cloud-starter-tencent-metadata-transfer/src/main/java/com/tencent/cloud/metadata/config/MetadataTransferAutoConfiguration.java

@@ -18,8 +18,9 @@
 
 package com.tencent.cloud.metadata.config;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
-import java.util.Map;
 
 import com.netflix.zuul.ZuulFilter;
 import com.tencent.cloud.common.constant.MetadataConstant;
@@ -30,18 +31,15 @@ import com.tencent.cloud.metadata.core.EncodeTransferMedataRestTemplateIntercept
 import com.tencent.cloud.metadata.core.EncodeTransferMedataScgFilter;
 import com.tencent.cloud.metadata.core.EncodeTransferMetadataZuulFilter;
 
-import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.SmartInitializingSingleton;
-import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.web.servlet.FilterRegistrationBean;
 import org.springframework.cloud.gateway.filter.GlobalFilter;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.client.ClientHttpRequestInterceptor;
-import org.springframework.util.CollectionUtils;
 import org.springframework.web.client.RestTemplate;
 
 import static javax.servlet.DispatcherType.ASYNC;
@@ -143,9 +141,10 @@ public class MetadataTransferAutoConfiguration {
 	 */
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnClass(name = "org.springframework.web.client.RestTemplate")
-	protected static class MetadataTransferRestTemplateConfig implements ApplicationContextAware {
+	protected static class MetadataTransferRestTemplateConfig {
 
-		private ApplicationContext context;
+		@Autowired(required = false)
+		private List<RestTemplate> restTemplates = Collections.emptyList();
 
 		@Bean
 		public EncodeTransferMedataRestTemplateInterceptor encodeTransferMedataRestTemplateInterceptor() {
@@ -153,59 +152,12 @@ public class MetadataTransferAutoConfiguration {
 		}
 
 		@Bean
-		BeanPostProcessor encodeTransferMetadataRestTemplatePostProcessor(
+		public SmartInitializingSingleton addEncodeTransferMedataInterceptorForRestTemplate(EncodeTransferMedataRestTemplateInterceptor interceptor) {
-				EncodeTransferMedataRestTemplateInterceptor encodeTransferMedataRestTemplateInterceptor) {
+			return () -> restTemplates.forEach(restTemplate -> {
-			// Coping with multiple bean injection scenarios
+				List<ClientHttpRequestInterceptor> list = new ArrayList<>(restTemplate.getInterceptors());
-			Map<String, RestTemplate> beans = this.context.getBeansOfType(RestTemplate.class);
+				list.add(interceptor);
-			// If the restTemplate has been created when the
+				restTemplate.setInterceptors(list);
-			// MetadataRestTemplatePostProcessor Bean
+			});
-			// is initialized, then manually set the interceptor.
-			if (!CollectionUtils.isEmpty(beans)) {
-				for (RestTemplate restTemplate : beans.values()) {
-					List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
-					// Avoid setting interceptor repeatedly.
-					if (!interceptors.contains(encodeTransferMedataRestTemplateInterceptor)) {
-						interceptors.add(encodeTransferMedataRestTemplateInterceptor);
-						restTemplate.setInterceptors(interceptors);
-					}
-				}
-			}
-			return new EncodeTransferMetadataRestTemplatePostProcessor(encodeTransferMedataRestTemplateInterceptor);
-		}
-
-		@Override
-		public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
-			this.context = applicationContext;
-		}
-
-		public static class EncodeTransferMetadataRestTemplatePostProcessor
-				implements BeanPostProcessor {
-
-			private final EncodeTransferMedataRestTemplateInterceptor encodeTransferMedataRestTemplateInterceptor;
-
-			EncodeTransferMetadataRestTemplatePostProcessor(
-					EncodeTransferMedataRestTemplateInterceptor encodeTransferMedataRestTemplateInterceptor) {
-				this.encodeTransferMedataRestTemplateInterceptor = encodeTransferMedataRestTemplateInterceptor;
-			}
-
-			@Override
-			public Object postProcessBeforeInitialization(Object bean, String beanName) {
-				return bean;
-			}
-
-			@Override
-			public Object postProcessAfterInitialization(Object bean, String beanName) {
-				if (bean instanceof RestTemplate) {
-					RestTemplate restTemplate = (RestTemplate) bean;
-					List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
-					// Avoid setting interceptor repeatedly.
-					if (!interceptors.contains(encodeTransferMedataRestTemplateInterceptor)) {
-						interceptors.add(this.encodeTransferMedataRestTemplateInterceptor);
-						restTemplate.setInterceptors(interceptors);
-					}
-				}
-				return bean;
-			}
 		}
 	}
 }

spring-cloud-starter-tencent-metadata-transfer/src/test/java/com/tencent/cloud/metadata/config/MetadataTransferAutoConfigurationTest.java

@@ -18,6 +18,12 @@
 
 package com.tencent.cloud.metadata.config;
 
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.stream.Collectors;
+
 import com.tencent.cloud.metadata.core.EncodeTransferMedataFeignInterceptor;
 import com.tencent.cloud.metadata.core.EncodeTransferMedataRestTemplateInterceptor;
 import com.tencent.cloud.metadata.core.EncodeTransferMetadataZuulFilter;
@@ -26,7 +32,12 @@ import org.junit.Test;
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.cloud.client.loadbalancer.LoadBalanced;
 import org.springframework.cloud.gateway.filter.GlobalFilter;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.client.ClientHttpRequestInterceptor;
+import org.springframework.web.client.RestTemplate;
 
 /**
  * Test for {@link MetadataTransferAutoConfiguration}.
@@ -54,10 +65,6 @@ public class MetadataTransferAutoConfigurationTest {
 							MetadataTransferAutoConfiguration.MetadataTransferRestTemplateConfig.class);
 					Assertions.assertThat(context).hasSingleBean(
 							EncodeTransferMedataRestTemplateInterceptor.class);
-					Assertions.assertThat(context).hasSingleBean(
-							MetadataTransferAutoConfiguration
-									.MetadataTransferRestTemplateConfig
-									.EncodeTransferMetadataRestTemplatePostProcessor.class);
 					Assertions.assertThat(context).hasSingleBean(
 							MetadataTransferAutoConfiguration.MetadataTransferZuulFilterConfig.class);
 					Assertions.assertThat(context)
@@ -67,4 +74,44 @@ public class MetadataTransferAutoConfigurationTest {
 					Assertions.assertThat(context).hasSingleBean(GlobalFilter.class);
 				});
 	}
+
+
+	@Test
+	public void test2() {
+		this.applicationContextRunner
+				.withConfiguration(
+						AutoConfigurations.of(MetadataTransferAutoConfiguration.class, RestTemplateConfiguration.class))
+				.run(context -> {
+					Assertions.assertThat(context)
+							.hasSingleBean(EncodeTransferMedataFeignInterceptor.class);
+					EncodeTransferMedataRestTemplateInterceptor encodeTransferMedataRestTemplateInterceptor = context.getBean(EncodeTransferMedataRestTemplateInterceptor.class);
+					Map<String, RestTemplate> restTemplateMap = context.getBeansOfType(RestTemplate.class);
+					Assertions.assertThat(restTemplateMap.size()).isEqualTo(2);
+					for (String beanName : Arrays.asList("restTemplate", "loadBalancedRestTemplate")) {
+						RestTemplate restTemplate = restTemplateMap.get(beanName);
+						Assertions.assertThat(restTemplate).isNotNull();
+						List<ClientHttpRequestInterceptor> encodeTransferMedataFeignInterceptorList = restTemplate.getInterceptors()
+								.stream()
+								.filter(interceptor -> Objects.equals(interceptor, encodeTransferMedataRestTemplateInterceptor))
+								.collect(Collectors.toList());
+						//EncodeTransferMedataFeignInterceptor is not added repeatedly
+						Assertions.assertThat(encodeTransferMedataFeignInterceptorList.size()).isEqualTo(1);
+					}
+				});
+	}
+
+	@Configuration
+	static class RestTemplateConfiguration {
+
+		@Bean
+		public RestTemplate restTemplate() {
+			return new RestTemplate();
+		}
+
+		@LoadBalanced
+		@Bean
+		public RestTemplate loadBalancedRestTemplate() {
+			return new RestTemplate();
+		}
+	}
 }