1、问题表述
有时客户端需要在 config server 无响应时进行重试,以给 config server 时间进行恢复。利用 spring 提供的重试组件,我们可以方便的配置重试机制,包括重试间隔,重试次数等。
2、解决方法
1.粗粒度控制重试
spring:
cloud:
consul:
host: localhost
port: 8500
discovery:
service-name: ${spring.application.name}
config:
discovery:
enabled: true # 开启服务发现
service-id: mango-config # 配置中心服务名称
name: consumer # 对应{application}部分
profile: dev # 对应{profile}部分
label: master # 对应git的分支,如果配置中心使用的是本地存储,则该参数无用
#默认false,是否启动快速失败功能,功能开启则优先判断config server是否正常,在获取不到远程配置时,立即失败,但是用下边的[retry]配置进行重试(粗粒度)
fail-fast: true
retry:
initial-interval: 1000 #最初重试间隔为 1000 毫秒
max-attempts: 10 #最多重试 10 次
max-interval: 5000 #最长重试间隔为 5000 毫秒
multiplier: 1.2 #每次重试失败后,重试间隔所增加的倍数
2.细粒度控制重试
package com.louis.mango.consumer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.retry.interceptor.RetryInterceptorBuilder;
import org.springframework.retry.interceptor.RetryOperationsInterceptor;
/**
* 客户端需要在 config server 无响应时进行重试,以给 config server 时间进行恢复。利用 spring 提供的重试组件,配置重试机制。RetryConfiguration类实现细粒度控制重试机制。
* 作用:自定义重试拦截器解决异常(consul作为注册中心时):NoSuchBeanDefinitionException:No bean named 'configServerRetryInterceptor' available
*
* Time 2019-09-27 14:51
*/
public class RetryConfiguration {
private static Logger log = LoggerFactory.getLogger(RetryConfiguration.class);
//@ConditionalOnMissingBean:当 BeanFactory 中没有名为 configServerRetryInterceptor 的 bean 时才匹配此 Bean,对应到bean名称,此为细粒度控制
@ConditionalOnMissingBean(name = "configServerRetryInterceptor")
@Bean
public RetryOperationsInterceptor configServerRetryInterceptor(){
log.info(String.format(
"configServerRetryInterceptor: Changing backOffOptions " +
"to initial: %s, multiplier: %s, maxInterval: %s",
1000, 1.2, 5000));
return RetryInterceptorBuilder.stateless()
//#最初重试间隔为 1000 毫秒 #每次重试失败后,重试间隔所增加的倍数 #最长重试间隔为 5000 毫秒
.backOffOptions(1000,1.2,5000)
//#最多重试 10 次
.maxAttempts(10)
.build();
}
}
最后在 src/main/resources/META-INF/ (没有可创建此文件夹) 新建一个 spring.factories 文件,指定我们刚创建类为启动时的配置,以在获取远程配置之前生效
org.springframework.cloud.bootstrap.BootstrapConfiguration=com.louis.mango.consumer.RetryConfiguration
3、测试
最后在关闭 configserver 的条件下启动 web 项目,然后就会看到重试十次之后,项目启动失败。
如果中途开启 config server,则 web 客户端启动成功。
以上方法2选1即可。