Spring Cloud Config Client超時及重試示例詳解
簡介
有時客戶端需要在 config server 無響應時進行重試,以給 config server 時間進行恢復。利用 spring 提供的重試組件,我們可以方便的配置重試機制,包括重試間隔,重試次數(shù)等。下面話不多說了,來一起看看詳細的介紹吧。
項目源碼
為 web 項目添加依賴
開啟客戶端重試功能需要兩個新依賴,spring-retry 和 spring-boot-starter-aop,把如下代碼添加到 web 項目的 pom.xml 文件中:
<dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> <version>1.2.2.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
然后在 bootstrap.yml 文件中添加如下配置:
spring: application: name: web-client cloud: config: uri: http://localhost:8888 fail-fast: true retry: initial-interval: 1000 max-attempts: 6 max-interval: 2000 multiplier: 1.1
首先把 spring.cloud.config.fail-fast 為true,即在獲取不到遠程配置時,立即失敗,但是用下邊的配置進行重試。
spring.cloud.config.retry 所有子項均為默認值:
- initial-interval: 最初重試間隔為 1000 毫秒
- max-attempts: 最多重試 6 次
- max-interval: 最長重試間隔為 2000 毫秒
- multiplier: 每次重試失敗后,重試間隔所增加的倍數(shù)
測試
如果使用了本教程的項目,我們需要首先啟動 configserver 項目,然后再啟動 registry 項目開啟 eureka,因為 web 客戶端使用了 eureka 服務,之后關(guān)閉 configserver,然后啟動 web 項目,會看到如下 log:
2018-05-15 16:04:58.421 INFO 2663 --- [ main] c.c.c.ConfigServicePropertySourceLocator : Fetching config from server at: http://localhost:8888
重試 6 次失敗后,客戶端啟動失敗,如果中途開啟 configserver,則 web 客戶端啟動成功。
細粒度控制重試
我們可以在代碼中實現(xiàn)更精細的控制重試機制,在 web 項目中創(chuàng)建一個新的 java 類 cn.zxuqian.configurations.RetryConfiguration,添加如下代碼:
package cn.zxuqian.configurations; 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; public class RetryConfiguration { private static Logger log = LoggerFactory.getLogger(RetryConfiguration.class); @Bean @ConditionalOnMissingBean(name = "configServerRetryInterceptor") public RetryOperationsInterceptor configServerRetryInterceptor() { log.info(String.format( "configServerRetryInterceptor: Changing backOffOptions " + "to initial: %s, multiplier: %s, maxInterval: %s", 1000, 1.2, 5000)); return RetryInterceptorBuilder .stateless() .backOffOptions(1000, 1.2, 5000) .maxAttempts(10) .build(); } }
這里我們定義了configServerRetryInterceptor方法用于 Spring Retry 使用我們自定義的重試攔截器。方法使用 RetryInterceptorBuilder 按要求創(chuàng)建了一個 stateless 的 RetryOperationsInterceptor,并設置了初始重試間隔為 1000 毫秒,增加倍數(shù)為 1.2 倍,最大重試間隔為 5000 毫秒,最大重試次數(shù)為 10 次,builder 還提供了諸如配置重試機制之類的接口,有興趣的讀者可自行研究。
@ConditionalOnMissingBean 標明當 BeanFactory 中沒有名為 configServerRetryInterceptor 的 bean 時才匹配此 Bean。
最后在 src/main/resources/META-INF/ (沒有可創(chuàng)建此文件夾) 新建一個 spring.factories 文件,指定我們剛創(chuàng)建類為啟動時的配置,以在獲取遠程配置之前生效:
org.springframework.cloud.bootstrap.BootstrapConfiguration=cn.zxuqian.configurations.RetryConfiguration
測試
最后在關(guān)閉 configserver 的條件下啟動 web 項目,然后就會看到重試十次之后,項目啟動失敗。
總結(jié)
以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
相關(guān)文章
獲取JPEGImageEncoder和JPEGCode這兩個類的方法
下面小編就為大家?guī)硪黄@取JPEGImageEncoder和JPEGCode這兩個類的方法。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-07-07MyBatis JdbcType 與Oracle、MySql數(shù)據(jù)類型對應關(guān)系說明
這篇文章主要介紹了MyBatis JdbcType 與Oracle、MySql數(shù)據(jù)類型對應關(guān)系說明,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09microlog4android將Android Log日志寫到SD卡文件中實現(xiàn)方法
這篇文章主要介紹了microlog4android將Android Log日志寫到SD卡文件中實現(xiàn)方法的相關(guān)資料,需要的朋友可以參考下2016-10-10