springboot整合@Retryable实现重试功能

前言

在实际工作中，重试机制是一个很常见的场景，比如：发送消息失败，下载网络文件失败等…，因为这些错误可能是网络波动造成的，等待一些延迟就能成功处理。我们通常会使用try/catch、while循环等进行相关处理，但是这样看起来比较臃肿复杂，且不好看。于是就有了spring提供的重试模块—— @Retryable

@Retryable 简介

一个spring提供的重试机制注解模块，简单的注解，提供有效的帮助。虽然有一些限制，但是在大多数情况下还是可以很好的解决我们的问题——优雅，永不过时。

使用步骤

1.引入依赖

gradle 引入方式如下

implementation 'org.springframework.retry:spring-retry:1.3.3'

maven 引入方式

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>1.3.3</version>
</dependency>

2.启用@Retryable

在项目启动类上加上注解 @EnableRetry

@SpringBootApplication
@EnableRetry
public class NfljApplication {

    public static void main(String[] args) {
        SpringApplication.run(NfljApplication.class, args);
    }
}

3.添加@Retryable注解

  1. 新建service方法，添加如下方法
public interface CodeService {
    String code() throws Exception;
}

  1. 新建实现类，在我们要使用的方法上添加 @Retryable注解
  2. 在同一个实现类下加上回调方法 @Recover（如果不需要回调方法，可以直接不写回调方法），实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常
@Service
public class CodeServiceImpl implements CodeService {

    @Override
    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 1000,multiplier = 1.5))
    public String code() throws Exception {
        System.out.println("开始调用----------");
        if (0 == 0) {
            throw new Exception("调用出错啦！！！");
        }
        System.out.println("成功调用");
        return "200";
    }
    
    /**
     * 回调方法
     *
     * @return
     */
    @Recover
    public String recover(Exception e) {
        System.out.println("---------------回调方法执行----------------");
        //记录日志到数据库
        return "500";
    }
}

4.测试

  1. 编写测试类进行测试
@Autowired
    private CodeService codeService;
    @Test
    void test4() throws Exception {
        String code = codeService.code();
        System.out.println(code);
    }

  1. 测试的打印结果如下，可以证明，完美的进行了重试

开始调用---------- 开始调用---------- 开始调用---------- ---------------回调方法执行---------------- 500

注意事项

1. @Retryable注解参数

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

2. @Recover 注解

  • 方法的返回值必须与@Retryable方法一致
  • 方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要哪个参数，写进去即可
  • 回调方法与重试方法写在同一个实现类里面

最后

  • 由于是基于AOP实现，所以不支持类里自调用方法，且需引入aop依赖

implementation 'org.springframework.boot:spring-boot-starter-aop:2.6.3'

  • 如果重试失败需要给@Recover注解的方法做后续处理，那这个重试的方法不能有返回值，只能是void
  • 方法内不能使用try catch，只能往外抛异常
  • @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)，此注解注释的方法参数一定要是@Retryable抛出的异常，否则无法识别，可以在该方法中进行日志处理

结语

虽然该注解的使用有一些限制，但是依然能够在很大程度上解决我们的需求，也不用在代码中写很臃肿的重试方法，此时此刻，只需要一个注解，就能优雅的解决我们的问题