接口重试机制
在工作中,我们经常会碰到需要调用远程方法的业务,这时候,如果超时了,或者异常了,我们都会让其重试几次,达到一定的重试次数以后,
就返回异常信息,今天我们就来了解下Spring-Retry的用法以及实现原理是怎么样的
Spring-Retry用法
引入依赖
因为SpringRetry是基础Spring Aop的机制实现的 , 所以需要引入Aop的依赖
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
启动类增加注解 (@EnableRetry),打开重试机制
@SpringBootApplication
// 开启Spring-Retry重试机制
@EnableRetry
public class SpringTestApplication {
public static void main(String[] args) {
SpringApplication.run(SpringTestApplication.class, args);
}
}
写一个外部的接口
- 提供一个外部接口
@RestController
@RequestMapping("/test")
public class TestController {
@Resource
RetryService retryService;
@GetMapping("/springRetry")
public void SpringRetry(@RequestParam("code") Integer code) {
try {
retryService.retry(code);
} catch (Exception e) {
e.printStackTrace();
}
}
}
- 具体执行重试的代码
@Service
public class RetryService {
/**
* value:抛出指定异常才会重试
* include:和value一样,默认为空,当exclude也为空时,默认所有异常
* exclude:指定不处理的异常
* maxAttempts:最大重试次数,默认3次
* backoff:重试等待策略,
* 默认使用@Backoff,@Backoff的value默认为1000L,我们设置为3000; 以毫秒为单位的延迟(默认 1000)
* multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为2,则第一次重试为3秒,第二次为6秒,第三次为12秒。
*/
@Retryable(value = IOException.class,
maxAttempts = 4,
backoff = @Backoff(delay = 3000, multiplier = 2))
public void retry(int code) throws Exception {
System.out.println(getDateTime() + " : retry被调用了 : " + code);
if (code == 0) {
throw new IOException(getDateTime() + " : 调用失败,抛出异常 : 开始重试 : " + code);
}
System.out.println(getDateTime() + " : 调用成功 : " + code);
}
/**
* Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。
* 如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。
* 可以看到传参里面写的是 Exception e,这个是作为回调的接头暗号(重试次数用完了,还是失败,我们抛出这个Exception e通知触发这个回调方法)。
* 注意事项:
* 方法的返回值必须与@Retryable方法一致
* 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)
* 该回调方法与重试方法写在同一个实现类里面
* <p>
* 由于是基于AOP实现,所以不支持类里自调用方法
* 如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void
* 方法内不能使用try catch,只能往外抛异常
*
* @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。
*/
@Recover
public void recover(Exception e, int code) {
System.out.println(getDateTime() + " : 回调方法执行!!!! : " + code);
//记日志到数据库 或者调用其余的方法
System.out.println(getDateTime() + " : 异常信息:" + e.getMessage());
}
/**
* 获取到当前时分秒
*
* @return
* @throws Exception
*/
public String getDateTime() {
return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
}
}
- 调用外部接口 : 结果如下
2023-09-01 17:41:54 : retry被调用了 : 0
2023-09-01 17:41:57 : retry被调用了 : 0
2023-09-01 17:42:03 : retry被调用了 : 0
2023-09-01 17:42:15 : retry被调用了 : 0
2023-09-01 17:42:15 : 回调方法执行!!!! : 0
2023-09-01 17:42:15 : 异常信息:2023-09-01 17:42:15 : 调用失败,抛出异常 : 开始重试 : 0