springboot整合@Retryable实现重试功能的示例代码

作者:南风落尽 时间:2023-11-27 11:08:20 

前言

在实际工作中,重试机制是一个很常见的场景,比如:发送消息失败,下载网络文件失败等…,因为这些错误可能是网络波动造成的,等待一些延迟就能成功处理。我们通常会使用try/catch、while循环等进行相关处理,但是这样看起来比较臃肿复杂,且不好看。于是就有了spring提供的重试模块—— @Retryable

@Retryable 简介

一个spring提供的重试机制注解模块,简单的注解,提供有效的帮助。虽然有一些限制,但是在大多数情况下还是可以很好的解决我们的问题——优雅,永不过时。

使用步骤

1.引入依赖

gradle 引入方式如下

implementation 'org.springframework.retry:spring-retry:1.3.3'

maven 引入方式

<dependency>
   <groupId>org.springframework.retry</groupId>
   <artifactId>spring-retry</artifactId>
   <version>1.3.3</version>
</dependency>

2.启用@Retryable

在项目启动类上加上注解@EnableRetry

@SpringBootApplication
@EnableRetry
public class NfljApplication {

    public static void main(String[] args) {
        SpringApplication.run(NfljApplication.class, args);
    }
}

3.添加@Retryable注解

新建service方法,添加如下方法

public interface CodeService {
   String code() throws Exception;
}

新建实现类,在我们要使用的方法上添加@Retryable注解

在同一个实现类下加上回调方法@Recover(如果不需要回调方法,可以直接不写回调方法),实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常

@Service
public class CodeServiceImpl implements CodeService {

    @Override
    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 1000,multiplier = 1.5))
    public String code() throws Exception {
        System.out.println("开始调用----------");
        if (0 == 0) {
            throw new Exception("调用出错啦!!!");
        }
        System.out.println("成功调用");
        return "200";
    }
    
    /**
     * 回调方法
     *
     * @return
     */
    @Recover
    public String recover(Exception e) {
        System.out.println("---------------回调方法执行----------------");
        //记录日志到数据库
        return "500";
    }
}

4.测试

编写测试类进行测试

@Autowired
   private CodeService codeService;
   @Test
   void test4() throws Exception {
       String code = codeService.code();
       System.out.println(code);
   }

测试的打印结果如下,可以证明,完美的进行了重试

开始调用----------
开始调用----------
开始调用----------
---------------回调方法执行----------------
500

注意事项

1. @Retryable注解参数

  • value:抛出我们指定异常才会重试

  • include:和value一样,默认为空,当exclude也为空时,默认所有异常

  • exclude:指定不处理的异常

  • maxAttempts:最大重试次数,默认3次,包括第一次请求也算在其中

  • backoff:重试等待策略,默认使用@Backoff,@Backoff的value默认为1000L

  • multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。

2. @Recover 注解

  • 方法的返回值必须与@Retryable方法一致

  • 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致,其他的参数,需要哪个参数,写进去即可

  • 回调方法与重试方法写在同一个实现类里面

最后

由于是基于AOP实现,所以不支持类里自调用方法,且需引入aop依赖

implementation 'org.springframework.boot:spring-boot-starter-aop:2.6.3'

如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void
方法内不能使用try catch,只能往外抛异常
@Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理

来源:https://juejin.cn/post/7094613787973517343

标签:springboot,@Retryable,重试
0
投稿

猜你喜欢

  • grails不能运行fork模式解决方法

    2023-05-17 18:37:59
  • C#串口通信实现方法

    2023-04-15 06:31:11
  • SpringBoot详细讲解静态资源导入的实现

    2023-07-26 13:23:21
  • 一文掌握MyBatis Plus的条件构造器方法

    2023-06-18 13:00:26
  • Android自定义控件之组合控件学习笔记分享

    2022-09-18 01:09:22
  • C#针对xml基本操作及保存配置文件应用实例

    2022-11-24 05:51:17
  • java的Arrays工具类实战

    2023-08-21 15:46:36
  • C#执行EXE文件与输出消息的提取操作

    2023-02-28 00:08:06
  • 详解LINQ入门(上篇)

    2023-10-15 05:57:30
  • Android 中SP与DP的区别实例详解

    2021-12-26 22:43:13
  • Spring中@Validated和@Valid区别浅析

    2021-10-04 23:27:22
  • Java 如何使用Feign发送HTTP请求

    2023-05-10 15:04:08
  • Maven中的SnapShot版本和正式版本的区别

    2023-11-03 16:31:46
  • Android ListView position详解及实例代码

    2023-10-29 03:33:15
  • Java并发LinkedBlockingQueue源码分析

    2022-09-01 08:35:30
  • Java中对话框的弹出方法

    2022-04-24 14:35:52
  • Java框架---Spring详解

    2021-07-09 14:27:30
  • 在Mybatis中使用自定义缓存ehcache的方法

    2022-02-24 17:27:35
  • MyBatis中PageHelper不生效的解决方案

    2022-10-23 11:46:47
  • Android应用中仿今日头条App制作ViewPager指示器

    2023-02-01 15:45:24
  • asp之家 软件编程 m.aspxhome.com