Spring-Retry(重试机制)解读

 更新时间:2023年08月11日 09:39:23   作者:llp1110  
这篇文章主要介绍了Spring-Retry(重试机制),具有很好的价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

Spring-Retry(重试机制)

在实际工作中,重处理是一个非常常见的场景,比如:

发送消息失败。调用远程服务失败。争抢锁失败。

这些错误可能是因为网络波动造成的,等待过后重处理就能成功。

通常来说,会用 try/catch while 循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。

然而 spring-retry 却可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。

一、@Retryable是什么?

spring系列的 spring-retry 是另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。

spring-retry 中,所有配置都是基于简单注释的。

二、使用步骤

1.POM依赖

基于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>

2.启用 @Retryable

@EnableRetry
@SpringBootApplication
public class HelloApplication {
    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.class, args);
    }
}

3.在方法上添加 @Retryable

1.创建测试controller

@RestController
public class TestRetryController {
    @Resource
    private TestRetryService testRetryService;
    @RequestMapping(value = "/test")
    public int test(int code) throws Exception {
        return testRetryService.testRetry(code);
    }
}

2.创建service接口

public interface TestRetryService {
    int testRetry(int code) throws Exception;
}

3.创建service实现类并添加@Retryable

@Service
public class TestRetryServiceImpl implements TestRetryService  {
    /**
     * value:抛出指定异常才会重试
     * include:和value一样,默认为空,当exclude也为空时,默认所有异常
     * exclude:指定不处理的异常
     * maxAttempts:最大重试次数,默认3次
     * backoff:重试等待策略,
     * 默认使用@Backoff,@Backoff的value默认为1000L,我们设置为2000; 以毫秒为单位的延迟(默认 1000)
     * multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。
     * @param code
     * @return
     * @throws Exception
     */
    @Override
    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
    public int testRetry(int code) throws Exception{
        System.out.println("test被调用,时间:"+ LocalTime.now());
          if (code==0){
              throw new Exception("情况不对头!");
          }
        System.out.println("test被调用,情况对头了!");
        return 200;
    }
    /**
     * Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。
     * 如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。
     * 可以看到传参里面写的是 Exception e,这个是作为回调的接头暗号(重试次数用完了,还是失败,我们抛出这个Exception e通知触发这个回调方法)。
     * 注意事项:
     * 方法的返回值必须与@Retryable方法一致
     * 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)
     * 该回调方法与重试方法写在同一个实现类里面
     *
     * 由于是基于AOP实现,所以不支持类里自调用方法
     * 如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void
     * 方法内不能使用try catch,只能往外抛异常
     * @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。
     * @param e
     * @param code
     * @return
     */
    @Recover
    public int recover(Exception e, int code){
        System.out.println("回调方法执行!!!!");
        //记日志到数据库 或者调用其余的方法
        System.out.println("异常信息:"+e.getMessage());
        return 400;
    }
}

来简单解释一下注解中几个参数的含义:

  • value :抛出指定异常才会重试
  • include :和value一样,默认为空,当exclude也为空时,默认所有异常
  • exclude :指定不处理的异常 maxAttempts :最大重试次数,默认3次
  • backoff :重试等待策略,默认使用 @Backoff @Backoff 的value默认为1000(单位毫秒),我们设置为2000;
  • multiplier (指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把 multiplier 设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。

当重试耗尽时还是失败,会出现什么情况呢?

当重试耗尽时, RetryOperations 可以将控制传递给另一个回调,即 RecoveryCallback

Spring-Retry 还提供了 @Recover 注解,用于@Retryable重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。

@Recover
public int recover(Exception e, int code){
    System.out.println("回调方法执行!!!!");
    //记日志到数据库 或者调用其余的方法
    System.out.println("异常信息:"+e.getMessage());
    return 400;
}

4.测试效果

这里我们传入的code=0因此走异常的分支,由于我们添加@Retryable注解并设置了相关的参数,程序会按照配置进行重试,重试都失败之后会调用@Recover修饰的方法,最终返回400给浏览器

image-20220707132821431

控制台输出结果

image-20220707133104962

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • mybatis连接PGSQL中对于json和jsonb的处理方法

    mybatis连接PGSQL中对于json和jsonb的处理方法

    在使用PostgreSQL数据库时,将表字段设置为jsonb格式可以存储JSON数据,本文给大家介绍mybatis连接PGSQL中对于json和jsonb的处理方法,感兴趣的朋友一起看看吧
    2024-11-11
  • IDEA如何切换数据库版本mysql5或mysql8

    IDEA如何切换数据库版本mysql5或mysql8

    本文介绍了如何将IntelliJ IDEA从MySQL5切换到MySQL8的详细步骤,包括下载MySQL8、安装、配置、停止旧服务、启动新服务以及更改密码等
    2025-01-01
  • Java实现动态验证码生成

    Java实现动态验证码生成

    这篇文章主要为大家详细介绍了Java实现动态验证码生成,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • 如何使用MyBatis框架实现增删改查(CRUD)操作

    如何使用MyBatis框架实现增删改查(CRUD)操作

    本文主要介绍了如何使用MyBatis框架实现增删改查(CRUD)操作。首先介绍了MyBatis框架的基本概念和使用方法,然后分别介绍了如何使用MyBatis实现增删改查操作。最后,通过一个简单的示例演示了如何使用MyBatis框架实现CRUD操作。
    2023-05-05
  • Java使用application.property读取文件里面的值

    Java使用application.property读取文件里面的值

    本文通过实例代码给大家介绍了Java使用application.property读取文件里面的值,需要的朋友可以参考下
    2018-10-10
  • spring 整合 mybatis 中数据源的几种配置方式(总结篇)

    spring 整合 mybatis 中数据源的几种配置方式(总结篇)

    因为spring 整合mybatis的过程中, 有好几种整合方式,尤其是数据源那块,经常看到不一样的配置方式,总感觉有点乱,所以今天有空总结下,感兴趣的朋友跟随脚本之家小编一起学习吧
    2018-05-05
  • SpringBoot项目部署到服务器的两种方式

    SpringBoot项目部署到服务器的两种方式

    目前,前后端分离的架构已成主流,而使用SpringBoot构建Web应用是非常快速的,项目发布到服务器上的时候,只需要打成一个jar包,然后通过命令 : java -jar jar包名称即可启动服务了,本文介绍了SpringBoot项目部署到服务器的两种方式,需要的朋友可以参考下
    2024-10-10
  • spring boot使用logback实现多环境日志配置详解

    spring boot使用logback实现多环境日志配置详解

    这篇文章主要介绍了spring boot使用logback实现多环境日志配置详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • Java Maven构建工具中mvnd和Gradle谁更快

    Java Maven构建工具中mvnd和Gradle谁更快

    这篇文章主要介绍了Java Maven构建工具中mvnd和Gradle谁更快,mvnd 是 Maven Daemon 的缩写 ,翻译成中文就是 Maven 守护进程,下文更多相关资料,需要的小伙伴可以参考一下
    2022-05-05
  • jsp页面中获取servlet请求中的参数的办法详解

    jsp页面中获取servlet请求中的参数的办法详解

    在JAVA WEB应用中,如何获取servlet请求中的参数,本文讲解了jsp页面中获取servlet请求中的参数的办法
    2018-03-03

最新评论