Spring的重试机制:浅谈@Retryable和@Recover注解

Spring的重试机制:浅谈@Retryable和@Recover注解

【腾讯云-专属】精选爆款云产品，大额代金券等你领

  在我们的日常开发中，经查会遇到调用接口失败的情况，这时候就需要通过一些方法来进行重试，比如通过while循环手动重复调用或是通过JDK/CGLib动态代理的方式来进行重试。但是这种方法比较笨重，且对原有逻辑代码的入侵性比较大。

while-retry

cglib-retry

  实际上，Spring已经为我们提供了封装好的重试功能，spring-retry，使我们可以通过@Retryable和@Recover注解来完成重试和重试失败后的回调。

spring-annotation-retry

  如上图中的代码所示，我们通过@Retryable注解，对RemoteAccessException异常进行重试，重试次数为2次，第一次重试间隔为5s，之后重试的时间间隔为前一次的2倍，第二次重试间隔10s，第三次重试间隔20s。然后通过@Recover注解设定当重试到达指定次数时，将要回调的方法。
我们来看看@Retryable注解中有什么内容：

@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注解：

@Backoff

参数	含义
value	这个我不知道，原文是"A canonical backoff period."
delay	重试之间的等待时间(以毫秒为单位)
maxDelay	重试之间的最大等待时间(以毫秒为单位)
multiplier	指定延迟的倍数
delayExpression	重试之间的等待时间表达式
maxDelayExpression	重试之间的最大等待时间表达式
multiplierExpression	指定延迟的倍数表达式
random	随机指定延迟时间

除了使用注解来实现方法重试以外，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：组合重试策略。有两种组合方式，乐观组合重试策略是指只要有一个策略允许重试即可以，悲观组合重试策略是指只要有一个策略不允许重试即不可以。但不管哪种组合方式，组合中的每一个策略都会执行

在使用@Retryable和@Recover注解时，有几点需要注意：
首先，要添加maven依赖
<dependency>
   <groupId>org.springframework.retry</groupId>
  <artifactId>spring-retry</artifactId>
</dependency>
并添加@EnableRetry注解使@Retryable和@Recover注解生效。
另外@Retryable和@Recover修饰的方法要在同一个类中,且被@Retryable 标记的方法不能有返回值，这样Recover方法才会生效。
最后,由于@Retryable注解是通过切面实现的，因此我们要避免@Retryable 注解的方法的调用方和被调用方处于同一个类中，因为这样会使@Retryable 注解失效