@Retryable注解重试功能

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

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

这些错误可能是因为网络波动造成的，等待过后重处理就能成功。通常来说，会用try/catch，while循环之类的语法来进行重处理，但是这样的做法缺乏统一性，并且不是很方便，要多写很多代码。然而spring-retry却可以通过注解，在不入侵原有业务逻辑代码的方式下，优雅的实现重处理功能。

源码分析:扒一扒@Retryable注解，很优雅，有点意思！

@Retryable

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

使用步骤：

① POM依赖

  org.springframework.retry
  spring-retry
 
 

    org.springframework.boot
    spring-boot-starter-aop
    2.6.3

② 启用

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

③ 使用

@Service
@Slf4j
public class IRetryServiceImpl implements IRetryService {

    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 3600,multiplier = 1.5))
    @Override
    public Boolean test(Integer code) {
        log.info("current-time===============>"+ DateUtil.date());
        if(code<0)
        {
            throw new RuntimeException("数字不能那个小于0");
        }
        return Boolean.TRUE;
    }
}

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

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

@Retryable参数详解

参数	含义
interceptor	重试拦截器bean名称，用于可重试方法
value	可重试的异常类型。含义同include。默认为空(如果excludes也为空，则重试所有异常)
include	可重试的异常类型。默认为空(如果excludes也为空，则重试所有异常)
exclude	无需重试的异常类型。默认为空(如果includes也为空，则重试所有异常)
label	统计报告的唯一标签。如果未提供，则调用者可以选择忽略它或提供一个默认值。
stateful	若为true，标志重试是有状态的：即重新抛出异常，但是重试策略与相同的策略应用于具有相同参数的后续调用。若为false，则不会重新引发可重试的异常
maxAttempts	最大重试次数(包括第一次失败)，默认为3次
maxAttemptsExpression	计算最大尝试次数(包括第一次失败)的表达式，默认为3 次
backoff	重试等待策略,下面会在@Backoff中介绍
exceptionExpression	指定在SimpleRetryPolicy.canRetry()返回true之后要求值的表达式-可用于有条件地禁止重试。

@backoff参数详解

参数	含义
value	重试间隔
delay	重试之间的等待时间(以毫秒为单位)
maxDelay	重试之间的最大等待时间(以毫秒为单位)
multiplier	指定延迟的倍数
delayExpression	重试之间的等待时间表达式
maxDelayExpression	重试之间的最大等待时间表达式
multiplierExpression	指定延迟的倍数表达式
random	随机指定延迟时间

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

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

除了使用注解来实现方法重试以外，Spring还提供了RetryTemplate来显式进行方法的重试，大致实现方式如下图所示：

RetryTemplate

从图中可以发现，我们可以通过setRetryPolicy()方法来为RetryTemplate设置重试策略。Spring为我们提供了6种重试策略：

1. NeverRetryPolicy：只允许调用 RetryCallback 一次，不允许重试
2. AlwaysRetryPolicy：允许无限重试，直到成功，此方式逻辑不当会导致死循环
3. SimpleRetryPolicy：固定次数重试策略，默认重试最大次数为 3 次，RetryTemplate 默认使用的策略
4. TimeoutRetryPolicy：超时时间重试策略，默认超时时间为 1 秒，在指定的超时时间内允许重试
5. CircuitBreakerRetryPolicy：有熔断功能的重试策略，需设置 3 个参数 openTimeout、resetTimeout 和 delegate
6. CompositeRetryPolicy：组合重试策略。有两种组合方式，乐观组合重试策略是指只要有一个策略允许重试即可以，悲观组合重试策略是指只要有一个策略不允许重试即不可以。但不管哪种组合方式，组合中的每一个策略都会执行

@Recover

@Service
@Slf4j
public class IRetryServiceImpl implements IRetryService {

    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 3600,multiplier = 1.5))
    @Override
    public Boolean test(Integer code) {
        log.info("current-time===============>"+ DateUtil.date());
        if(code<0)
        {
            throw new RuntimeException("数字不能那个小于0");
        }
        return Boolean.TRUE;
    }

    @Recover
    public Boolean recover(Exception e)
    {
        log.info("回调方法执行！！！！");
        log.info("{}"+e.getMessage());
       //记日志到数据库 或者调用其余的方法
        return Boolean.FALSE;
    }
}

可以看到传参里面写的是 Exception e，这个是作为回调的接头暗号（重试次数用完了，还是失败，抛出这个Exception e通知触发这个回调方法）。对于@Recover注解的方法，需要特别注意的是：

1. 方法的返回值必须与@Retryable方法一致
方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要哪个参数，写进去就可以了（@Recover方法中有的）
2. 该回调方法与重试方法写在同一个实现类里面

注意事项

1. 由于是基于AOP实现，所以不支持类里自调用方法（动态代理原因）
2. 如果重试失败需要给@Recover注解的方法做后续处理，那这个重试的方法不能有返回值，只能是void
3. 方法内不能使用try catch，只能往外抛异常
4. @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)，此注解注释的方法参数一定要是@Retryable抛出的异常，否则无法识别，可以在该方法中进行日志处理。