如果你需要使用重试机制,请使用Spring官方的Spring Retry

Spring Retry 是 Spring Framework 中的一个模块,提供了一种简单的方式来在应用程序中实现重试机制。

在应用程序中,如果遇到了一些不可避免的错误,比如网络连接失败、数据库连接失败等,我们通常需要对这些错误进行重试,以尝试解决这些问题。Spring Retry 提供了一个可插拔的、面向切面的重试框架,可以让我们很容易地在应用程序中实现重试机制。

Spring Retry 中最常用的类是 RetryTemplate,它提供了一个 execute 方法,可以让我们在方法调用失败时进行重试。RetryTemplate 中可以设置最大重试次数、重试间隔时间等参数。此外,还可以设置重试条件,如重试的异常类型、重试策略等。

今天我们来讲一下Spring Retry

📎Spring Retry的基本使用

📎第一步,引入Spring Retry的jar包

java 复制代码
       <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
            <version>1.3.1</version>
        </dependency>

📎第二步,构建一个RetryTemplate类

这段代码展示了如何使用Spring Retry库创建一个RetryTemplate实例来进行重试操作。该实例最多进行3次尝试,每次重试的时间间隔会指数级增长,最大可达10分钟,重试只会在ArithmeticException异常发生时进行。

java 复制代码
   private static final RetryTemplate RETRY_TEMPLATE = RetryTemplate.builder()
            .maxAttempts(3)
            .exponentialBackoff(5000, 3, 600000L)
            .retryOn(ArithmeticException.class)
            .build();

📎第三步,使用RETRY_TEMPLATE

java 复制代码
        Boolean test2 = RETRY_TEMPLATE.execute((RetryCallback<Boolean, ArithmeticException>) context -> {

            System.out.println("test" + context.getRetryCount());
            int i = 1 / 0;
            System.out.println("test2");

            return Boolean.FALSE;
        });

        System.out.println(test2);

使用 RETRY_TEMPLATE.execute 方法执行一个 RetryCallback,里面放置需要重试的逻辑代码。这段示例代码中,在逻辑代码中将会抛出 ArithmeticException 异常,然后框架会自动尝试重试,最终返回 Boolean.FALSE。

这里的运行结果为

在这个具体的例子中,返回true或者false的区别在于 当RetryTemplate达到最大重试次数时,如果RetryCallback的执行结果为true,则RetryTemplate会认为重试成功并结束重试; 如果RetryCallback的执行结果为false,则RetryTemplate会认为重试失败并抛出RetryException异常。

总的来说,true表示成功,false表示失败。但是需要根据具体的场景和语义来确定具体的含义。在这个例子中,返回true表示重试成功,返回false表示重试失败。即test2的值。

📎注意事项

需要注意的是context.getRetryCount()的值是从0开始的,如果maxAttempts设置为3的话,那就最大值为3-1=2

所以我们可以根据该方法进行业务的判断

值得注意的是,retryOn()只会重试指定类型的错误以及其子类,并且当抛出的错误类型为非运行是异常的情况需要在方法上面抛出

另外,我们可以捕获对应的异常,并且在catch中抛出且可以进行业务的控制

📎拓展方法

RetryTemplate是Spring Retry提供的核心类,可以用来进行方法调用的重试操作。除了上面提到的execute()方法,RetryTemplate还提供了其他一些常用的方法和配置选项,下面介绍一些常见的用法:

📎 降级操作

execute(RetryCallback<T, E> retryCallback, RecoveryCallback<T> recoveryCallback):除了可以传入一个RetryCallback接口,执行需要重试的方法调用外,还可以传入一个RecoveryCallback接口,用于在重试次数达到上限后执行降级操作。RecoveryCallback接口提供一个recover(RetryContext context)方法,可以在该方法中实现降级逻辑。例如:

java 复制代码
RetryTemplate retryTemplate = RetryTemplate.builder()
        .maxAttempts(3)
        .build();

retryTemplate.execute((RetryCallback<Void, RuntimeException>) context -> {
    // 需要重试的方法调用
    someService.someMethod();
    return null;
}, (RecoveryCallback<Void>) context -> {
    // 重试次数达到上限后执行降级操作
    fallbackService.fallbackMethod();
    return null;
});

📎 重试策略:时间策略

setBackOffPolicy(BackOffPolicy backOffPolicy):设置重试策略,即在每次重试之间的等待时间策略。BackOffPolicy接口提供了多个实现类,例如ExponentialBackOffPolicyFixedBackOffPolicy等。例如:

scss 复制代码
ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
backOffPolicy.setInitialInterval(1000);  // 初始等待时间1000ms
backOffPolicy.setMultiplier(2.0);  // 每次重试等待时间乘以2
backOffPolicy.setMaxInterval(60000);  // 最大等待时间60000ms

RetryTemplate retryTemplate = RetryTemplate.builder()
        .maxAttempts(3)
        .backOffPolicy(backOffPolicy)
        .build();

retryTemplate.execute((RetryCallback<Void, RuntimeException>) context -> {
    // 需要重试的方法调用
    someService.someMethod();
    return null;
});

📎 重试策略:指定异常策略

setRetryPolicy(RetryPolicy retryPolicy):设置重试策略,即在哪些异常情况下进行重试。RetryPolicy接口提供了多个实现类,例如SimpleRetryPolicyTimeoutRetryPolicyCompositeRetryPolicy等。例如:

ini 复制代码
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
retryPolicy.setMaxAttempts(3);  // 最大重试次数

RetryTemplate retryTemplate = RetryTemplate.builder()
        .retryPolicy(retryPolicy)
        .build();

retryTemplate.execute((RetryCallback<Void, RuntimeException>) context -> {
    // 需要重试的方法调用
    someService.someMethod();
    return null;
});

RetryPolicyRetryOn都是Spring Retry中的重试机制,但它们的作用略有不同。

  1. RetryPolicy用于定义重试策略,即在发生异常时应该如何重试,它包括重试的次数、重试的间隔时间、是否需要使用指数退避等信息。在RetryTemplate中,我们可以使用RetryPolicy来创建一个重试模板。
  2. RetryOn用于定义哪些异常会触发重试,即重试的条件。在RetryTemplate中,我们可以使用RetryOn来指定需要重试的异常类型。通常,我们使用RetryOn来定义需要重试的异常类型,并使用RetryPolicy来定义重试策略。

总体来说,RetryOnRetryPolicy是配合使用的,RetryOn指定需要重试的异常类型,RetryPolicy定义重试策略。这样,当指定的异常类型发生时,RetryTemplate就会根据定义的重试策略进行重试。

  • Spring Retry为我们提供了丰富的配置选项,允许我们根据具体需求定制重试策略和回退逻辑。无论是简单的定时重试,还是根据异常类型进行有条件的重试,Spring Retry都能灵活满足我们的各种需求。
  • 在使用Spring Retry时,建议根据实际场景仔细选择重试策略,合理设置最大重试次数和重试间隔,以免对系统和依赖造成不必要的压力。同时,对于一些不可恢复的错误,我们也应该考虑合理的异常处理策略,避免陷入无限重试的死循环。

总的来说,Spring Retry是一个强大且易于使用的工具,可以帮助我们有效应对应用程序中的不稳定性。

相关推荐
桃园码工13 分钟前
第一章:Go 语言概述 1.什么是 Go 语言? --Go 语言轻松入门
开发语言·后端·golang
计算机学姐15 分钟前
基于SSM的宠物领养平台
java·vue.js·spring·maven·intellij-idea·mybatis·宠物
泰山小张只吃荷园25 分钟前
期末Python复习-输入输出
java·前端·spring boot·python·spring cloud·docker·容器
Mr_Xuhhh28 分钟前
程序地址空间
android·java·开发语言·数据库
YSRM34 分钟前
异或-java-leetcode
java·算法·leetcode
大明湖的狗凯.37 分钟前
MySQL 中的乐观锁与悲观锁
java·数据库·mysql
z2023050842 分钟前
linux之调度管理(13)- wake affine 唤醒特性
java·开发语言
AI人H哥会Java43 分钟前
【JAVA】Java高级:Java网络编程——TCP/IP与UDP协议基础
java·开发语言
萧萧玉树1 小时前
分布式在线评测系统
前端·c++·后端·负载均衡
桃园码工1 小时前
第一章:Go 语言概述 2.安装和配置 Go 开发环境 --Go 语言轻松入门
开发语言·后端·golang