From fae48b82765d26cd4c0773586edca1c09d5e7b38 Mon Sep 17 00:00:00 2001 From: weihu Date: Tue, 21 Jun 2022 23:11:12 +0800 Subject: [PATCH] add java doc --- .../circuitbreaker/PolarisResponseErrorHandler.java | 3 ++- .../PolarisRestTemplateAutoConfiguration.java | 6 +++--- ...olarisRestTemplateRegisterAutoConfiguration.java} | 12 ++++-------- .../PolarisRestTemplateResponseErrorHandler.java | 2 +- .../polaris/circuitbreaker/example/ServiceA.java | 5 +---- 5 files changed, 11 insertions(+), 17 deletions(-) rename spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/{PolarisRestTemplateBeanPostProcessor.java => PolarisRestTemplateRegisterAutoConfiguration.java} (80%) diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisResponseErrorHandler.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisResponseErrorHandler.java index cf125c067..828d67bfe 100644 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisResponseErrorHandler.java +++ b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisResponseErrorHandler.java @@ -22,7 +22,8 @@ import org.springframework.web.client.ResponseErrorHandler; /** * @author : wh * @date : 2022/6/21 19:12 - * @description: + * @description: errorHandler {@link ResponseErrorHandler} */ public interface PolarisResponseErrorHandler extends ResponseErrorHandler { + } diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateAutoConfiguration.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateAutoConfiguration.java index 8b10c38b3..6e3cefc5a 100644 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateAutoConfiguration.java +++ b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateAutoConfiguration.java @@ -30,7 +30,7 @@ import org.springframework.web.client.RestTemplate; /** * @author : wh * @date : 2022/6/21 21:34 - * @description: + * @description: Auto configuration PolarisRestTemplateAutoConfiguration */ @ConditionalOnProperty(value = "spring.cloud.polaris.circuitbreaker.enabled", havingValue = "true", matchIfMissing = true) @@ -46,7 +46,7 @@ public class PolarisRestTemplateAutoConfiguration { @Bean @ConditionalOnBean(RestTemplate.class) - public PolarisRestTemplateBeanPostProcessor polarisRestTemplateBeanPostProcessor(PolarisRestTemplateResponseErrorHandler restTemplateResponseErrorHandler) { - return new PolarisRestTemplateBeanPostProcessor(restTemplateResponseErrorHandler); + public PolarisRestTemplateRegisterAutoConfiguration polarisRestTemplateBeanPostProcessor(PolarisRestTemplateResponseErrorHandler restTemplateResponseErrorHandler) { + return new PolarisRestTemplateRegisterAutoConfiguration(restTemplateResponseErrorHandler); } } diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateBeanPostProcessor.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateRegisterAutoConfiguration.java similarity index 80% rename from spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateBeanPostProcessor.java rename to spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateRegisterAutoConfiguration.java index b9040ff48..081859a9c 100644 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateBeanPostProcessor.java +++ b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateRegisterAutoConfiguration.java @@ -23,29 +23,25 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; import org.springframework.web.client.RestTemplate; -import java.util.Objects; - /** * @author : wh * @date : 2022/6/21 21:20 - * @description: + * @description: auto configuration RestTemplate */ -public class PolarisRestTemplateBeanPostProcessor implements ApplicationContextAware, SmartInitializingSingleton { +public class PolarisRestTemplateRegisterAutoConfiguration implements ApplicationContextAware, SmartInitializingSingleton { private ApplicationContext applicationContext; private final PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler; - public PolarisRestTemplateBeanPostProcessor(PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler) { + public PolarisRestTemplateRegisterAutoConfiguration(PolarisRestTemplateResponseErrorHandler polarisRestTemplateResponseErrorHandler) { this.polarisRestTemplateResponseErrorHandler = polarisRestTemplateResponseErrorHandler; } @Override public void afterSingletonsInstantiated() { RestTemplate restTemplate = this.applicationContext.getBean(RestTemplate.class); - if (Objects.nonNull(restTemplate)) { - restTemplate.setErrorHandler(polarisRestTemplateResponseErrorHandler); - } + restTemplate.setErrorHandler(polarisRestTemplateResponseErrorHandler); } @Override diff --git a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateResponseErrorHandler.java b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateResponseErrorHandler.java index bf01b4e0f..1a8bf7a8f 100644 --- a/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateResponseErrorHandler.java +++ b/spring-cloud-starter-tencent-polaris-circuitbreaker/src/main/java/com/tencent/cloud/polaris/circuitbreaker/PolarisRestTemplateResponseErrorHandler.java @@ -39,7 +39,7 @@ import java.util.Objects; /** * @author : wh * @date : 2022/6/21 17:25 - * @description: + * @description: Extend ResponseErrorHandler to get request information */ public class PolarisRestTemplateResponseErrorHandler implements ResponseErrorHandler { diff --git a/spring-cloud-tencent-examples/polaris-circuitbreaker-example/polaris-circuitbreaker-example-a/src/main/java/com/tencent/cloud/polaris/circuitbreaker/example/ServiceA.java b/spring-cloud-tencent-examples/polaris-circuitbreaker-example/polaris-circuitbreaker-example-a/src/main/java/com/tencent/cloud/polaris/circuitbreaker/example/ServiceA.java index 6cec50890..1c96db6c9 100644 --- a/spring-cloud-tencent-examples/polaris-circuitbreaker-example/polaris-circuitbreaker-example-a/src/main/java/com/tencent/cloud/polaris/circuitbreaker/example/ServiceA.java +++ b/spring-cloud-tencent-examples/polaris-circuitbreaker-example/polaris-circuitbreaker-example-a/src/main/java/com/tencent/cloud/polaris/circuitbreaker/example/ServiceA.java @@ -18,9 +18,6 @@ package com.tencent.cloud.polaris.circuitbreaker.example; -import com.tencent.cloud.polaris.circuitbreaker.PolarisResponseErrorHandler; -import com.tencent.polaris.api.core.ConsumerAPI; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.loadbalancer.LoadBalanced; @@ -43,7 +40,7 @@ public class ServiceA { @Bean @LoadBalanced - public RestTemplate restTemplate(ConsumerAPI consumerAPI, @Autowired(required = false) PolarisResponseErrorHandler polarisResponseErrorHandler) { + public RestTemplate restTemplate() { return new RestTemplate(); }