Spring-Retry(重试机制)

Posted llp1110

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring-Retry(重试机制)相关的知识,希望对你有一定的参考价值。

Spring-Retry(重试机制)

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

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

这些错误可能是因为网络波动造成的,等待过后重处理就能成功。通常来说,会用try/catchwhile循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。然而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可以将控制传递给另一个回调,即RecoveryCallbackSpring-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给浏览器

控制台输出结果

Spring Boot 一个注解搞定重试机制,不能太优雅了

参考技术A

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

这些错误可能是因为网络波动造成的,等待过后重处理就能成功。通常来说,会用 try/catch , while 循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。

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

spring系列的 spring-retry 是另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。在 spring-retry 中,所有配置都是基于简单注释的。

Spring Boot 基础就不介绍了,推荐下这个实战教程:https://github.com/javastacks/spring-boot-best-practice

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

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

当重试耗尽时, RetryOperations 可以将控制传递给另一个回调,即 RecoveryCallback 。 Spring-Retry 还提供了 @Recover 注解,用于@Retryable重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。

可以看到传参里面写的是 Exception e ,这个是作为回调的接头暗号(重试次数用完了,还是失败,我们抛出这个 Exception e 通知触发这个回调方法)。

对于 @Recover 注解的方法,需要特别注意的是:

本篇主要简单介绍了Springboot中的 Retryable 的使用,主要的适用场景和注意事项,当需要重试的时候还是很有用的。

以上是关于Spring-Retry(重试机制)的主要内容,如果未能解决你的问题,请参考以下文章

Spring-Retry

Spring Boot 一个注解搞定重试机制,不能太优雅了

spring-retry失败重试

spring-retry失败重试

spring-retry实现方法请求重试

Spring Boot中使用Spring-Retry重试框架