SpringBoot @Retryable注解使用
更新时间：2024年12月10日 09:54:00 作者：LBL_lin
SpringBoot提供的@Retryable注解可以方便地实现方法的重试机制,可以在不侵入原有逻辑代码的方式下,优雅地实现重处理功能
前言
在使用第三方接口的时候，一般都会有一些类似登录客户端的处理，或者发送消息这些场景，有时候会出现网络抖动、连接超时等异常，这时候就需要进行多次重试。
一般如果我们自己实现重试机制，都是使用循环，但是这样并不优雅。
在SpringBoot中已经提供了实现重试机制的功能——@Retryable注解，可以在不侵入原有逻辑代码的方式下，优雅的实现重处理功能。
一、@Retryable是什么？
@Retryable是Spring提供的可重试注解，该注解一般用于方法上，实现方法的重试机制。
二、使用步骤
POM依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>启动@Retryable
在启动类上加上@EnableRetry，开启重试机制。
@EnableRetry
@SpringBootApplication
public class SpringBootRetryApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootRetryApplication.class, args);
}
}Service类
在需要重试方法上加上@Restryable
@Slf4j
@Service
public class LoginService {
@Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 2000L, multiplier = 1))
public void login(boolean isRetry) throws Exception {
log.info("----------开始登录----------");
if (isRetry) {
throw new Exception("重试登录");
}
}
}这里解释一下@Retryable常用的几个参数的含义：
- value：抛出指定的异常才会重试
- include：和value一样，默认为空，当exclude也为空时，默认所有异常
- exclude：指定不处理的异常
- maxAttempts：最大重试次数，默认是3次
- backoff：重试等待策略，默认使用@Backoff，value为重试间隔，delay为重试之间的等待时间(毫秒为单位)，multiplier指定延迟的倍数。
查看效果
可以看到，重试5次之后抛出异常，不再重试。
@Recover
当重试耗尽完后还是失败，会出现什么情况？
RetryOperations可以将控制传递给另一个回调，即RecoveryCallback。Spring还提供了@Recover注解，用于@Retryable重试失败后处理方法，此方法里的异常一定要是@Retryable方法里抛出的异常，否则不会回调这个方法。
@Recover
public void doRecover(Exception e) {
log.info("----------重试失败回调方法----------");
log.info(e.getMessage());
}
@Recover注解需要注意的点：
- 方法的返回值必须与@Retryable方法一致
- 方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要与@Retryable方法的参数一致。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。
相关文章
今天小编就为大家分享一篇关于Java内存泄漏问题处理方法经验总结，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2021-07-07
这篇文章主要介绍了Java8新特性之默认方法(default)浅析,默认方法也称为虚拟扩展方法或防护方法,可以让我们修改接口而不破坏原来的实现类的结构,需要的朋友可以参考下2014-06-06
这篇文章主要介绍了spring boot结合Redis实现工具类的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-11-11
这篇文章主要为大家详细介绍了java的正则表达式，使用表格进行介绍，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2022-02-02
这篇文章主要介绍了Java面向对象之继承的概念详解，Java是一种面向对象的编程语言，继承是实现面向对象编程的基础之一。通过继承，我们可以使代码更具可读性、可重用性和可维护性，从而提高程序的效率和可靠性,需要的朋友可以参考下2023-04-04
这篇文章主要介绍了Java使用观察者模式实现气象局高温预警功能,结合完整实例形式分析了java观察者模式实现气象局高温预警的相关接口定义、使用、功能操作技巧,并总结了其设计原则与适用场合,具有一定参考借鉴价值,需要的朋友可以参考下2018-04-04
这篇文章主要介绍了JAVA多线程编程,结合实例形式总结分析了多线程、锁、线程池等相关原理及使用技巧,需要的朋友可以参考下2019-09-09
这篇文章主要为大家详细介绍了Java实现简单的弹球游戏，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2020-12-12
详解SpringBoot 创建定时任务（配合数据库动态执行）
本篇文章主要介绍了SpringBoot 创建定时任务（配合数据库动态执行），小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-10-10
SpringBoot+Mybatis-plus实现分页查询的示例代码
本文主要介绍了SpringBoot+Mybatis-plus实现分页查询的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2025-02-02
最新评论