SpringBoot中如何优雅地使用重试

1 缘起

项目中使用了第三方的服务,

第三方服务偶尔会出现不稳定、连接不上的情况,

于是,在调用时为了保证服务的相对高可用,添加了超时连接重试,

当连接第三方服务超时时,多重试几次,比如3次,三次后仍连接不上,抛出异常,

在实际的测试过程中,重试一次即可连接到第三方服务,

提高了服务的可用性。

2 spring-retry

Spring提供了重试项目:spring-retry,用于处理项目中需要重试的方法,

spring-retry中提供了自定义参数,如重试次数、指定重试情况、重试延迟时间等,

满足不同的重试场景。

2.1 小插曲:试错过程

搜索SpringBoot如何使用重试注解时,发现需要使用spring-retry这个项目,在Maven仓库搜索了一下spring-retry,发现有多个版本,如下图,选择了最新版本2.0.4,启动项目时发现,无法运行。

环境:
Java8
SpringBoot2.4.5

xml 复制代码
<!-- https://mvnrepository.com/artifact/org.springframework.retry/spring-retry -->
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>2.0.4</version>
</dependency>

异常信息如下,版本不一致,进入spring-retry项目,查看项目配置。

java: 无法访问org.springframework.retry.annotation.Backoff

错误的类文件: /D:/install/maven/apache-maven-3.8.8/my-repository/org/springframework/retry/spring-retry/2.0.4/spring-retry-2.0.4.jar!/org/springframework/retry/annotation/Backoff.class

类文件具有错误的版本 61.0, 应为 52.0

请删除该文件或确保该文件位于正确的类路径子目录中。

查看spring-retry项目的配置文件,发现java版本为17,所以,使用java8无法启动项目,

因此,需要选择spring-retry对应Java8的版本。

2.2 正确过程

2.2.1 配置依赖

不指定spring-retry版本,Maven会自动下载合适的版本,本次自动下载的版本为1.3.1。

xml 复制代码
<!-- https://mvnrepository.com/artifact/org.springframework.retry/spring-retry -->
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

2.2.2 重试注解@Retryable

为方法添加@Retryable注解,即可在方法遇到异常时,重试指定次数。

常用参数如下,如有其他开发需求,可继续查看源码中的其他参数。

序号 参数 描述
1 value 触发重试的异常情况
2 maxAttempts 最大重试次数,默认重试3次
3 backoff 补偿机制,delay重试延迟时间,单位:毫秒;multiplier延迟时间比例,延迟的具体时间为delay*multiplier(multiplier>0时生效,默认multiplier为0),当multiplier为0时,延迟时间即为delay

2.2.3 添加启动注解@EnableRetry

启动类中添加开启重试注解:@EnableRetry

配置样例如下:

启动重试@EnableRetry后,Spring会全局启动重试注解@Retryable,在执行重试方法时,通过CGLIB代理方法,根据注解的元数据进行重试,EnableRetry源码如下:

org.springframework.retry.annotation.EnableRetry

2.2.4 测试重试

重试结果:

重试参数:5次,延迟:2秒,比例:2

重试间隔:

第二次:第一次~第二次:2秒

第三次:第二次~第三次:22=4秒
第四次:第三次~第四次:4
2=8秒

第五次:第四次~第五次:8*2=16秒

3 小结

(1)Spring提供重试项目:spring-retry,支持自定义参数,如重试次数、指定重试情况、重试延迟时间等,满足不同的重试场景;

(2)spring-retry生效有两处配置:启动配置@EnableRetry,重试配置:@Retryable;

(3)延迟时间:第n次~第n+1次 第n次delay*multiplier,上一次的dealy与比例的乘积;

(4)使用spring-retry时需要注意与Java版本的匹配,不同的Java版本使用不同的spring-retry版本,以及不同的重试参数。

相关推荐
DCTANT6 分钟前
【原创】国产化适配-全量迁移MySQL数据到OpenGauss数据库
java·数据库·spring boot·mysql·opengauss
Touper.15 分钟前
SpringBoot -- 自动配置原理
java·spring boot·后端
喜欢敲代码的程序员2 小时前
SpringBoot+Mybatis+MySQL+Vue+ElementUI前后端分离版:项目搭建(一)
spring boot·mysql·elementui·vue·mybatis
华子w9089258593 小时前
基于 SpringBoot+Vue.js+ElementUI 的 “花开富贵“ 花园管理系统设计与实现7000字论文
vue.js·spring boot·elementui
小时候的阳光4 小时前
SpringBoot3 spring.factories 自动配置功能不生效?
spring boot·spring·失效·factories·imports
大只鹅4 小时前
Springboot3整合ehcache3缓存--XML配置和编程式配置
spring boot·缓存
执笔诉情殇〆5 小时前
springboot集成达梦数据库,取消MySQL数据库,解决问题和冲突
数据库·spring boot·mysql·达梦
hdsoft_huge6 小时前
Spring Boot 高并发框架实现方案:数字城市的奇妙之旅
java·spring boot·后端
gjh12087 小时前
Easy-excel监听器中对批量上传的工单做错误收集
java·spring boot
考虑考虑9 小时前
使用jpa中的group by返回一个数组对象
spring boot·后端·spring