使用Spring-Retry解决Spring Boot应用程序中的重试问题

目录

• 1、背景
• 2、引入依赖
• 3、开启spring-retry
• 4、在方法上添加@Retryable
• 5、重试完
• 6、注意事项

1、背景

在日常开发过程中，难免会与第三方接口发生交互，例如：远程服务调用当正常调用发生异常时，例如：网络抖动等短时间内的临时问题，程序为了更加健壮并且更不容易出现故障。需要重新触发业务操作，以防止间歇性的异常对程序照成的影响。这个可以就可以用重试来解决。

2、引入依赖

<!--因为spring-retry是基于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>

3、开启spring-retry

在springboot的启动类上增加注解 @EnableRetry

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

4、在方法上添加@Retryable

@Component
public class TestRetry {
       /**
     * 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
     */
    @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;
    }
}

@Retryable 注解

value，可重试的异常类型。含义同include。默认为空(如果excludes也为空，则重试所有异常)

include：可重试的异常类型。默认为空(如果excludes也为空，则重试所有异常)

exclude：无需重试的异常类型。默认为空(如果includes也为空，则重试所有异常)

maxAttempts：最大重试次数(包括第一次失败)，默认为3次

backoff：重试等待策略,下面会在@Backoff中介绍

recover：表示重试次数到达最大重试次数后的回调方法

@Backoff 注解

delay，重试之间的等待时间(以毫秒为单位)

maxDelay，重试之间的最大等待时间(以毫秒为单位)

multiplier，指定延迟的倍数

delayExpression，重试之间的等待时间表达式

maxDelayExpression，重试之间的最大等待时间表达式

multiplierExpression，指定延迟的倍数表达式

random，随机指定延迟时间

5、重试完

当重试完，RetryOperations 可以将控制传递给另一个回调，即 RecoveryCallback。Spring-Retry 还提供了 @Recover 注解，用于 @Retryable 重试失败后处理方法。若不需要重试失败后的处理方法，则不写回调方法，重试耗尽后抛出异常。

@Component
public class TestRetry {
    @Retryable(recover = \"recoverTest\",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;
    }
/**
**方法的返回值必须与 @Retryable 方法一致
**方法的第一个参数，必须是 Throwable 类型的，建议是与 @Retryable 配置的**异常一致，其他的参数，需要哪个参数，写进去就可以了（@Recover 方法中有的）
**该回调方法与重试方法写在同一个实现类里面
*/
 @Recover
    public String recoverTest(RuntimeException e) {
        return \"回调方法-\" + e.getMessage();
    }
}

6、注意事项

由于是基于 AOP 实现，所以不支持类里自调用方法

如果重试失败需要给 @Recover 注解的方法做后续处理，那这个重试的方法不能有返回值，只能是 void

方法内不能使用 try catch，只能往外抛异常

@Recover 注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)，此注解注释的方法参数一定要是 @Retryable 抛出的异常，否则无法识别，可以在该方法中进行日志处理。