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版本,以及不同的重试参数。

相关推荐
陈果然DeepVersion3 小时前
Java大厂面试真题:Spring Boot微服务+Kafka消息队列+AIGC场景实战问答全解析
spring boot·redis·微服务·kafka·消息队列·aigc·java面试
程序猿ZhangSir3 小时前
Spring Boot 项目实现邮件推送功能 (以QQ邮箱为例)
java·数据库·spring boot
JosieBook3 小时前
【SpringBoot】30 核心功能 - 单元测试 - JUnit5 单元测试简介与常用注解实战详解
spring boot·后端·单元测试
韩立学长3 小时前
【开题答辩实录分享】以《植物病虫害在线答疑小程序的设计与实现》为例进行答辩实录分享
spring boot·小程序·vue
玛卡巴卡014 小时前
Maven 从入门到实战:搞定依赖管理与 Spring Boot 项目构建
java·spring boot·maven
جيون داد ناالام ميづ4 小时前
Spring Boot 核心原理(一):基础认知篇
java·spring boot·后端
夏之小星星5 小时前
Springboot结合Vue实现分页功能
vue.js·spring boot·后端
韩立学长5 小时前
【开题答辩实录分享】以《自动售货机刷脸支付系统的设计与实现》为例进行答辩实录分享
vue.js·spring boot·后端
ljh_learn_from_base7 小时前
【spring boot 使用apache poi 生成和处理word 文档】
java·spring boot·word·apache
bug攻城狮9 小时前
SpringBoot响应封装:Graceful Response vs 自定义通用响应类选型指南
java·spring boot·后端·http