ToB企服应用市场:ToB评测及商务社交产业平台

标题: SpringBoot进阶教程(八十四)spring-retry [打印本页]

---

作者: 滴水恩情    时间: 2025-1-5 20:52
标题: SpringBoot进阶教程(八十四)spring-retry

在日常的一些场景中, 很多需要进行重试的操作.而spring-retry是spring提供的一个基于spring的重试框架，某些场景需要对一些非常情况下的方法进行重试就会用到spring-retry。spring-retry可以资助我们以标准方式处理任何特定操作的重试。在spring-retry中，所有设置都是基于简单注释的。

v添加引用

1.         <dependency>
2.             <groupId>org.springframework.retry</groupId>
3.             <artifactId>spring-retry</artifactId>
4.         </dependency>
5.         <dependency>
6.             <groupId>org.springframework.boot</groupId>
7.             <artifactId>spring-boot-starter-aop</artifactId>
8.         </dependency>

复制代码

v启用@Retryable

1. @SpringBootApplication
2. @EnableRetry
3. public class TestApplication {
5.     public static void main(String[] args) {
6.         SpringApplication.run(TestApplication.class, args);
7.     }
9. }

复制代码

要使用@EnabelRetry开启重试才行，声明在设置类或者启动类上都可以激活。
v在方法上添加@Retryable

创建service接口

1. public interface HomeService {
2.     int convertStatus(int status) throws Exception;
3. }

复制代码

在service实现类并添加@Retryable

1. @Slf4j
2. @Service
3. public class HomeServiceImpl implements HomeService {
4.     /**
5.      * value：抛出指定异常才会重试
6.      * include：和value一样，默认为空，当exclude也为空时，默认所有异常
7.      * exclude：指定不处理的异常
8.      * maxAttempts：最大重试次数，默认3次（包括第一次调用）
9.      * backoff：重试等待策略，
10.      * 默认使用@Backoff，@Backoff的value默认为1000L，我们设置为2000； 以毫秒为单位的延迟（默认 1000）;delay：重试的间隔时间,就是value
11.      * multiplier delay时间的间隔倍数，默认为0，表示固定暂停1秒后进行重试，如果把multiplier设置为1.5，则第一次重试为2秒，第二次为3秒，第三次为4.5秒。
12.      * @param status
13.      * @return
14.      * @throws Exception
15.      */
16.     @Override
17.     @Retryable(retryFor = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
18.     public int convertStatus(int status) throws Exception{
19.         System.out.println("进入convertStatus时间："+ LocalTime.now());
20.         if (status < 0){
21.             throw new Exception("状态小于0是非法的");
22.         }
24.         System.out.println("convertStatus: status++");
26.         return status++;
27.     }
29.     /**
30.      * Spring-Retry还提供了@Recover注解，用于@Retryable重试失败后处理方法。
31.      * 如果不需要回调方法，可以直接不写回调方法，那么实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常。
32.      * @Recover标记方法必须要与@Retryable注解的方法“形参”保持一致，第一入参为要重试的异常(一定要是@Retryable方法里抛出的异常或者异常父类)，其他参数与@Retryable保持一致，返回值也要一样，否则无法执行！
33.      *
34.      * @param e
35.      * @param status @Retryable注解的原方法参数，可以保留，也可以不要。
36.      * @return
37.      */
38.     @Recover
39.     public int recover(Exception e, int status) {
40.         //记日志到数据库 或者调用其余的方法
41.         System.out.println(String.format("兜底方法执行，异常信息:%s,status:%d", e.toString(), status));
42.         return -1;
43.     }
44. }

复制代码

@Retryable修饰的convertStatus()方法，如果调用期间报了非常，那么它将进行重试3次（默认三次），如果超过最大重试次数，则执行@Retryable修饰的recover()方法，
创建controller

1. @Slf4j
2. @RestController
3. public class HomeController {
4.     @Autowired
5.     HomeService homeService;
7.     @GetMapping("convertStatus")
8.     public ReturnValue<?> convertStatus(@RequestParam("token") String token,
9.                                         @RequestParam("status") int status) throws Exception {
10.         int result = homeService.convertStatus(status);
11.         return ReturnValue.buildSuccessResult(result);
12.     }
13. }

复制代码

验证效果

v常用注解介绍

@EnableRetry启用重试，开启aop的功能，默认使用jdk的动态代理。proxyTargetClass属性为true时（默认false），使用CGLIB代理
@Retryable标记当前方法会使用重试机制。

属性	类型	默认值	阐明
interceptor	String	“”	将interceptor的bean名称应用到retryable()，和其他的属性互斥
include	Class[]	{}	哪些非常可以触发重试 ，默认为空
exclude	Class[]	{}	哪些非常将不会触发重试，默认为空，如果和include属性同时为空，则所有的非常都将会触发重试
value	Class[]	{}	可重试的非常类型
label	String	“”	统计陈诉的唯—标签。如果没有提供，调用者可以选择忽略它，或者提供默认值
maxAttempts	int	3	尝试的最大次数(包括第一次失败)，默认为3次
backoff	@Backoff	@Backoff()	@Backoff @Backoff()指定用于重试此操作的backoff属性。默认为

@Backoff重试回退计谋（立即重试照旧等待一会再重试）

属性	类型	默认值	阐明
delay	long	0	如果不设置则默认使用1000 ms等待重试，和value同义词
maxDelay	long	0	最大重试等待时间
multiplier	long	0	用于盘算下一个延长延长的乘数(大于0生效)
random	boolean	FALSE	随机重试等待时间

@Backoff 的参数会影响我们使用哪种退避计谋

• FixedBackOffPolicy默认退避计谋，每 1 秒重试 1 次
  
• ExponentialBackOffPolicy指数退避计谋，当设置 multiplier 时使用，每次重试时间间隔为 当前延长时间 * multiplier。
  
• ExponentialRandomBackOffPolicy指数随机退避计谋。在指数退避计谋的基础上增加了随机性。具体计谋查看 getSleepAndIncrement() 方法
  
• UniformRandomBackOffPolicy均匀随机计谋，设置 maxDely 但没有设置 multiplier 时使用，重试间隔会在 maxDelay 和 delay 间随机
  

@Recover作为恢复处理程序的方法调用的注释。重试方法最终会调用标注了@Recover 的方法。
@Recover声明的方法和@Retryable 方法相同类型的返回值，Throwable 第一个参数是可选的（但是，如果没有其他参数匹配，则不带该参数的方法将被调用）。从失败方法的参数列表中依次填充后续参数。
v注意事项

• 使用了Spring-Retry是通过捕获非常的方式来触发重试的,@Retryable注解的方法直接实例化调用不会触发重试，要先将实现类实例化到Spring容器中，然后通过注入等方式使用
  
• Spring-Retry是通过捕获非常的方式来触发重试的,@Retryable标注方法产生的非常不能使用try-catch捕获，要在方法上抛出非常，否则不会触发重试
  
• recover方法的返回值必须与Spring-Retry是通过捕获非常的方式来触发重试的,@Retryable方法一致
  
• 查询可以进行重试，写操作要慎重，除非业务方支持重入
  

v源码地点

https://github.com/toutouge/javademosecond/tree/master/hellolearn

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

---

欢迎光临 ToB企服应用市场:ToB评测及商务社交产业平台 (https://dis.qidao123.com/)

Powered by Discuz! X3.4