【spring-retry】Spring 提供的循环重试功能包
1 前言
今天看科技类的文章发现一个新的包,还是Spring提供的,用于失败重试的,我们这节来简单看看哈。
2 spring-retry 使用
2.1 依赖引入
<dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> </dependency>
2.2 启用 @EnableRetry
// 开启retry功能,就是引入retry的AOP @EnableRetry @MapperScan("com.virtuous.demo.mapper*") @SpringBootApplication public class VirtuousDemoApplication { public static void main(String[] args) { SpringApplication.run(VirtuousDemoApplication.class, args); } }
2.3 在方法上添加 @Retryable
@GetMapping("/getOne2") @Retryable(value = Exception.class, maxAttempts = 3,backoff = @Backoff(delay = 0,multiplier = 1.5)) public AccountResDto patchFirstCache2() throws Exception { throw new Exception("111"); }
我这里是把它用在了controller上试试哈,来简单解释一下注解中几个参数的含义:
- value:抛出指定异常才会重试
- include:和value一样,默认为空,当exclude也为空时,默认所有异常
- exclude:指定不处理的异常
- maxAttempts:最大重试次数,默认3次
- backoff:重试等待策略,默认使用@Backoff,@Backoff的value默认为1000L,我们设置为2000L;multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。
当重试耗尽时还是失败,会出现什么情况呢?
当重试耗尽时,RetryOperations可以将控制传递给另一个回调,即RecoveryCallback。Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。
2.4 重试逻辑 @Recover
@Recover public AccountResDto recover(AppException e) { System.out.println("回调方法执行!!!!"); //记日志到数据库 或者调用其余的方法 return new AccountResDto(); }
可以看到传参里面写的是 APPException e,这个是作为回调的接头暗号(重试次数用完了,还是失败,我们抛出这个APPException e通知触发这个回调方法)。对于@Recover注解的方法,需要特别注意的是:
- 方法的返回值必须与@Retryable方法一致
- 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)
- 该回调方法与重试方法写在同一个实现类里面
2.5 注意事项
- 由于是基于AOP实现,所以不支持类里自调用方法
- 依托于异常机制,所以方法内不能使用try catch,只能往外抛异常
- @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。
3 原理
那我们这里顺便看下源码,粗略的看下实现逻辑哈:
3.1 引入重试功能AOP@EnableRetry
注解@EnableRetry,用于开启retry功能,其实就是引入AOP,我们来看下:
可以看到引入了一个类RetryConfiguration,那我们进去看看这个类:
3.2 切点 Pointcut
那我们来看下切点,也就是要对哪些方法进行增强:
可以看到就是对带有注解@Retryable的类或者方法作为切入口进行增强。
3.3 通知 Advice
我们继续来看看通知器的创建:
4 小结
我们主要体验了一个retry的功能,具体怎么用什么场景下能用还是需要我们自己去选择哈,以及我们的业务量大的话会不会堆积呢,都是我们要考虑的事情,还需要深入探索的哈,本节就到这里哈,有理解不对的地方欢迎指正哈。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码,我用AI程序员写了一个飞机大战
· Obsidian + DeepSeek:免费 AI 助力你的知识管理,让你的笔记飞起来!
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· 白话解读 Dapr 1.15:你的「微服务管家」又秀新绝活了