SpringBoot整合Retry实现错误重试过程逐步介绍

更新时间：2023年02月27日 11:24:29 作者：彭世瑜

重试的使用场景比较多，比如调用远程服务时，由于网络或者服务端响应慢导致调用超时，此时可以多重试几次。用定时任务也可以实现重试的效果，但比较麻烦，用Spring Retry的话一个注解搞定所有，感兴趣的可以了解一下

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

完整依赖pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.7</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- spring-retry -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

开启spring-retry

启动类上增加注解 @EnableRetry

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.retry.annotation.EnableRetry;
@EnableRetry
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

使用重试注解

@Retryable注解

value，可重试的异常类型。含义同include。默认为空(如果excludes也为空，则重试所有异常)
include：可重试的异常类型。默认为空(如果excludes也为空，则重试所有异常)
exclude：无需重试的异常类型。默认为空(如果includes也为空，则重试所有异常)
maxAttempts：最大重试次数(包括第一次失败)，默认为3次
backoff：重试等待策略,下面会在@Backoff中介绍
recover：表示重试次数到达最大重试次数后的回调方法

@Backoff注解

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

使用示例

package com.example.demo.component;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Component;
@Component
public class HttpRequest {
    private int count = 0;
    /**
     * 模拟网络请求异常
     * @return
     */
    @Retryable(recover = "errorHandler")
    public String getResponse() {
        count++;
        System.out.println("time: " + count);
        if (count < 4) {
            throw new RuntimeException("count: " + count);
        }
        return "success";
    }
    /**
     * 错误处理函数
     * 注意：需要返回 String，否则会抛出方法找不到异常
     * org.springframework.retry.ExhaustedRetryException: Cannot locate recovery method
     *
     * @param e
     * @return
     */
    @Recover
    public String errorHandler(RuntimeException e) {
        System.out.println("errorHandler");
        return "ok";
    }
}

测试

package com.example.demo.component;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class HttpRequestTest {
    @Autowired
    private HttpRequest httpRequest;
    @Test
    public void getResponse(){
        httpRequest.getResponse();
    }
}

输出结果

time: 1
time: 2
time: 3
errorHandler

参考

SpringBoot 中使用 spring-retry 轻松解决重试

到此这篇关于SpringBoot整合Retry实现错误重试过程逐步介绍的文章就介绍到这了,更多相关SpringBoot Retry错误重试内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

通过简单步骤实现SpringMVC文件上传
这篇文章主要介绍了通过简单步骤实现SpringMVC文件上传,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-11-11
解读Spring接口方法加@Transactional失效的原因
这篇文章主要介绍了Spring接口方法加@Transactional失效的原因解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
前后端项目分离解决cors错误的方法详解
随着前后端分离技术的越来越盛行,跨域问题也逐渐凸显了出来,下面这篇文章主要给大家介绍了关于前后端项目分离解决cors错误的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-02-02
SpringBoot2.0集成Swagger2访问404的解决操作
这篇文章主要介绍了SpringBoot2.0集成Swagger2访问404的解决操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-09-09
举例说明Java中代码块的执行顺序
这篇文章主要介绍了举例说明Java中代码块的执行顺序,包括静态属性和非静态属性以及构造函数等相关的执行先后,需要的朋友可以参考下
2015-07-07
详解SpringBoot启动项目后执行方法的几种方式
在项目开发中某些场景必须要用到启动项目后立即执行方式的功能,本文主要聊聊实现立即执行的几种方法,具有一定的参考价值,感兴趣的可以了解一下
2023-09-09
jmeter断言的三种实现方式
在使用Jmeter进行性能测试或者接口自动化测试工作中,经常会用到的一个功能,就是断言,本文主要介绍了jmeter断言的三种实现方式,
2024-01-01
详解PowerDesigner之CDM、PDM、SQL之间转换
这篇文章主要介绍了详解PowerDesigner之CDM、PDM、SQL之间转换的相关资料,希望通过本文能帮助到大家，需要的朋友可以参考下
2017-10-10
浅谈spring boot使用thymeleaf版本的问题
这篇文章主要介绍了spring boot使用thymeleaf版本的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
Java IO流文件的编码实例代码
本文通过实例代码给大家介绍了java io流文件编码的方法，非常不错，具有参考借鉴价值，需要的朋友参考下吧
2017-05-05