Spring retry使用和采坑记录
1. 介绍
在项目中,调用第三方接口响应比较慢,或者由于网络抖动等原因,导致无响应的情况,就要用到重试机制.比较简单成熟的方案就是使用spring-retry功能,spring-retry需要使用aop的特性,所以引入aspectj
2. 项目依赖
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
</dependency>
2. 核心注解
核心注解3个: @EnableRetry,@Retryable 和 @Recover
@EnableRetry：此注解用于开启重试框架，可以修饰在SpringBoot启动类上面，也可以修饰在需要重试的类上
proxyTargetClass：Boolean类型，用于指明代理方式【true：cglib代理，false：jdk动态代理】默认使用jdk动态代理
@Retryable
value：Class[]类型，用于指定需要重试的异常类型，
include：Class[]类型，作用于value类似，区别尚未分析
exclude：Class[]类型，指定不需要重试的异常类型
maxAttemps：int类型，指定最多重试次数，默认3
backoff：Backoff类型，指明补偿机制
@BackOff
delay:指定延迟后重试，默认为1000L,即1s后开始重试 ;
multiplier:指定延迟的倍数
@Recover
当重试次数耗尽依然出现异常时，执行此异常对应的@Recover方法。
异常类型需要与Recover方法参数类型保持一致，
recover方法返回值需要与重试方法返回值保证一致https://blog.csdn.net/qq_39914581/java/article/details/96506043
3. 使用步骤
springboot开启重试
@SpringBootApplication
@EnableRetry
public class ReadscoreApplication {
public static void main(String[] args) {
SpringApplication.run(ReadscoreApplication.class, args);
}
}
添加重试注解,当有异常时触发重试机制.设置重试5次,默认是3.延时2000ms再次执行,每次延时提高1.5倍.当返回结果不符合要求时,主动报错触发重试.
@Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 2000, multiplier = 1.5))
public String download() throws Exception {
// 模拟测试
if(StringUtils.isBlank(null)){
log.info("重试查询下载链接: {}", LocalTime.now());
throw new Exception("正在导出文件,请稍后");
}else {
return result;
}
}
定义回调,注意异常类型和方法返回值类型要与重试方法一致
@Recover
public String recover(Exception e){
log.error("获取下载链接失败! {}", LocalTime.now());
throw new Exception("获取下载链接失败!");
}
模拟重试结果
2020-07-22 14:32:57.124 INFO com.service.PaperService:80 - 重试查询下载链接: 14:32:57.122
2020-07-22 14:32:59.341 INFO com.service.PaperService:80 - 重试查询下载链接: 14:32:59.341
2020-07-22 14:33:02.560 INFO com.service.PaperService:80 - 重试查询下载链接: 14:33:02.560
2020-07-22 14:33:07.308 INFO com.service.PaperService:80 - 重试查询下载链接: 14:33:07.308
2020-07-22 14:33:14.286 INFO com.service.PaperService:80 - 重试查询下载链接: 14:33:14.286
2020-07-22 14:33:14.286 ERROR com.service.PaperService:89 - 获取下载链接失败! 14:33:14.286
2020-07-22 14:33:14.287 INFO com.controller.PaperController:79 - com.exception.ParamsException : 正在导出文件,请稍后
采坑记录:
1. retry重试机制无效
由于retry用到了aspect增强，所有会有aspect的坑，就是方法内部调用，会使aspect增强失效，那么retry当然也会失效。
public class demo {
public void A() {
B();
}
@Retryable(Exception.class)
public void B() {
throw new RuntimeException("retry...");
}
}
这种情况B()不会重试。
2. recover回调报错
org.springframework.retry.ExhaustedRetryException: Cannot locate recovery method
报错显示找不到recovery方法
解决方案就这这两句话:
-
异常类型需要与Recover方法参数类型保持一致 -
recover方法返回值需要与重试方法返回值保证一致
异常类型和返回值要一致!
参考:
