java的spring-retry详解

最新推荐文章于 2025-03-16 17:02:38 发布
转载 最新推荐文章于 2025-03-16 17:02:38 发布 · 501 阅读 · 1 ·
CC 4.0 BY-SA版权
原文链接：https://mp.weixin.qq.com/s?__biz=MzkzNjQzOTE3Nw==&mid=2247489527&idx=1&sn=959791a785fbf2f540b34dd0801770c4&chksm=c35a0ecda312a0e0d740855fbf999b63efa109a3d94f55d8080953502d291c0d552c2a57ee07&scene=126&sessionid=0
文章标签：

#java #spring #php #开发语言 #后端

本文详细介绍了如何在Spring应用中使用spring-retry框架处理网络异常，包括其基本原理、注解式和命令式编码方法，以及如何配置重试策略。

11f27c61020e433a9c3509b6c7248a41.png

以往我们在进行网络请求的时候，需要考虑网络异常的情况，本文就介绍了利用spring-retry框架进行网络异常重试的基础内容。

35a776c92159bc6356379b621ce659f2.jpeg

提示：以下是本篇文章正文内容，下面案例可供参考

一、spring-retry是什么？

Spring Retry是一个用于在Spring应用程序中实现重试机制的框架。它提供了一种简单的方法来处理那些可能因为短暂的错误（如网络抖动或数据库锁）而失败的操作。

重试机制在很多场景下都是非常有用的。例如，当一个操作因为网络问题或数据库锁而失败时，通常只需要稍作等待，然后再次尝试，就可以成功。而手动实现这样的重试逻辑可能会非常繁琐，并且容易出错。

Spring Retry提供了几个注解和接口，使得在Spring应用程序中实现重试机制变得非常简单。

  1. @Retryable：这个注解可以用于方法上，表示这个方法可能会失败，需要重试。你可以指定重试的次数、延迟时间等参数。

  2. @Recover：这个注解用于定义一个全局的恢复方法，当所有重试都失败后，会调用这个方法。

  3. RetryTemplate：这是一个用于执行重试操作的模板类。你可以使用它来配置重试的策略，如重试次数、延迟时间等。

  4. RetryOperations：这是一个接口，用于定义重试操作的策略。你可以实现这个接口，然后使用RetryTemplate来执行你的重试策略。

总的来说，Spring Retry提供了一种简单而强大的方式来处理那些可能因为短暂错误而失败的操作。它可以帮助你减少手动编写重试逻辑的工作量，提高代码的可维护性。

二、使用步骤

1.引入maven库

代码如下（示例）：

<dependency>
        <groupId>org.springframework.retry</groupId>
        <artifactId>spring-retry</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>4.3.9.RELEASE</version>
    </dependency>

2. 在spring启动类上开启重试功能

提示：添加@EnableRetry注解开启

@SpringBootApplication
@EnableRetry
public class SpringRetryDemoApplication {
    public static SpringRetryAnnotationService springRetryAnnotationService;
    public static SpringRetryImperativeService springRetryImperativeService;
    public static TranditionalRetryService tranditionalRetryService;


    @Autowired
    public void setSpringRetryAnnotationService(SpringRetryAnnotationService springRetryAnnotationService) {
        SpringRetryDemoApplication.springRetryAnnotationService = springRetryAnnotationService;
    }


    @Autowired
    public void setSpringRetryImperativeService(SpringRetryImperativeService springRetryImperativeService) {
        SpringRetryDemoApplication.springRetryImperativeService = springRetryImperativeService;
    }


    @Autowired
    public void setTranditionalRetryService(TranditionalRetryService tranditionalRetryService) {
        SpringRetryDemoApplication.tranditionalRetryService = tranditionalRetryService;
    }


    public static void main(String[] args) {
        SpringApplication.run(SpringRetryDemoApplication.class, args);
        springRetryAnnotationService.test();
        springRetryImperativeService.test();
        tranditionalRetryService.test();
    }


}

3.公共业务代码

@Service
@Slf4j
public class CommonService {
    public void test(String before) {
        for (int i = 0; i < 10; i++) {
            if (i == 2) {
                log.error("{}:有异常哦，我再试多几次看下还有没异常", before);
                throw new RuntimeException();
            }
            log.info("{}:打印次数: {}", before, i + 1);
        }
    }


    public void recover(String before) {
        log.error("{}:还是有异常，程序有bug哦", before);
    }
}

4. 以往的重试做法

@Service
@Slf4j
public class TranditionalRetryService {
    @Autowired
    CommonService commonService;


    public void test() {
        // 定义重试次数以及重试时间间隔
        int retryCount = 3;
        int retryTimeInterval = 3;
        for (int r = 0; r < retryCount; r++) {
            try {
                commonService.test("以前的做法");
            } catch (RuntimeException e) {
                if (r == retryCount - 1) {
                    commonService.recover("以前的做法");
                    return;
                }
                try {
                    Thread.sleep(retryTimeInterval * 1000);
                } catch (InterruptedException ex) {
                    ex.printStackTrace();
                }
            }


        }


    }
}

5. 使用spring-retry的命令式编码

5.1 定义重试监听器

提示：监听重试过程的生命周期

@Slf4j
public class MyRetryListener extends RetryListenerSupport {
    @Override
    public <T, E extends Throwable> void close(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
        log.info("监听到重试过程关闭了");
        log.info("=======================================================================");
    }


    @Override
    public <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
        log.info("监听到重试过程错误了");
    }


    @Override
    public <T, E extends Throwable> boolean open(RetryContext context, RetryCallback<T, E> callback) {
        log.info("=======================================================================");
        log.info("监听到重试过程开启了");
        return true;
    }


}

5.2 定义重试配置

提示：配置RetryTemplate重试模板类

@Configuration
public class RetryConfig {
    @Bean
    public RetryTemplate retryTemplate() {
        // 定义简易重试策略，最大重试次数为3次,重试间隔为3s
        RetryTemplate retryTemplate = RetryTemplate.builder()
                .maxAttempts(3)
                .fixedBackoff(3000)
                .retryOn(RuntimeException.class)
                .build();
        retryTemplate.registerListener(new MyRetryListener());
        return retryTemplate;
    }


}

5.3 命令式编码

@Service
@Slf4j
public class SpringRetryImperativeService {
    @Autowired
    RetryTemplate retryTemplate;
    @Autowired
    CommonService commonService;


    public void test() {
        retryTemplate.execute(
                retry -> {
                    commonService.test("命令式");
                    return null;
                },
                recovery -> {
                    commonService.recover("命令式");
                    return null;
                }
        );
    }
}

6 使用spring-retry的注解式编码

@Service
@Slf4j
public class SpringRetryAnnotationService {
    @Autowired
    CommonService commonService;


    /**
     * 如果失败，定义重试3次，重试间隔为3s，指定恢复名称,指定监听器
     */
    @Retryable(value = RuntimeException.class, maxAttempts = 3, backoff = @Backoff(value = 3000L), recover = "testRecover", listeners = {"myRetryListener"})
    public void test() {
        commonService.test("注解式");
    }


    @Recover
    public void testRecover(RuntimeException runtimeException) {
        commonService.recover("注解式");
    }
}

7 启动打印效果

2022-05-06 11:53:12.044  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : =======================================================================
2022-05-06 11:53:12.044  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程开启了
2022-05-06 11:53:12.048  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 1
2022-05-06 11:53:12.048  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 2
2022-05-06 11:53:12.049 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 注解式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:12.049  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:15.062  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 1
2022-05-06 11:53:15.062  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 2
2022-05-06 11:53:15.062 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 注解式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:15.062  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:18.065  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 1
2022-05-06 11:53:18.065  INFO 21812 --- [           main] c.e.s.service.CommonService              : 注解式:打印次数: 2
2022-05-06 11:53:18.065 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 注解式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:18.065  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:18.066 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 注解式:还是有异常，程序有bug哦
2022-05-06 11:53:18.066  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程关闭了
2022-05-06 11:53:18.066  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : =======================================================================
2022-05-06 11:53:18.067  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : =======================================================================
2022-05-06 11:53:18.067  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程开启了
2022-05-06 11:53:18.067  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 1
2022-05-06 11:53:18.067  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 2
2022-05-06 11:53:18.067 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 命令式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:18.067  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:21.079  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 1
2022-05-06 11:53:21.079  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 2
2022-05-06 11:53:21.079 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 命令式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:21.079  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 1
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.service.CommonService              : 命令式:打印次数: 2
2022-05-06 11:53:24.082 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 命令式:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程错误了
2022-05-06 11:53:24.082 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 命令式:还是有异常，程序有bug哦
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : 监听到重试过程关闭了
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.listener.MyRetryListener           : =======================================================================
2022-05-06 11:53:24.082  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 1
2022-05-06 11:53:24.083  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 2
2022-05-06 11:53:24.083 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:27.084  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 1
2022-05-06 11:53:27.084  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 2
2022-05-06 11:53:27.084 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:30.090  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 1
2022-05-06 11:53:30.090  INFO 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:打印次数: 2
2022-05-06 11:53:30.090 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:有异常哦，我再试多几次看下还有没异常
2022-05-06 11:53:30.090 ERROR 21812 --- [           main] c.e.s.service.CommonService              : 以前的做法:还是有异常，程序有bug哦

三、总结

本文仅仅简单介绍了spring-retry的基本使用，相较于以往的做法，个人认为注解式更为简便，命令式看个人喜好。

微技术
关注
SpringBoot 消息重试框架 spring-retry 和 guava-retry 详解
专注基础架构领域
12-27 535
spring-retry 和 guava-retry 工具都是线程安全的重试，能够支持并发业务场景的重试逻辑正确性。两者都很好的将正常方法和重试方法进行了解耦，可以设置超时时间、重试次数、间隔时间、监听结果、都是不错的框架。但是明显感觉得到，guava-retry在使用上更便捷，更灵活，能根据方法返回值来判断是否重试，而Spring-retry只能根据抛出的异常来进行重试。
Java 重试框架 Spring-Retry | 进阶使用 - listener及自定义注解
甘蓝的专栏
04-11 1896
Java 重试框架 Spring Retry 进阶使用 - 监听器及自定义注解。
spring-retry
04-28
该项目为Spring应用程序提供了声明式重试支持。 它用于Spring Batch，Spring Integration等。 显式用法也支持命令重试。 快速开始 本节提供了快速入门Spring Retry的快速介绍。 它包括一个说明性示例和一个命令性示例。 声明性示例 下面的示例演示如何以声明式样式使用Spring Retry： @Configuration @EnableRetry public class Application { @Bean public Service service () { return new Service (); } } @Service class Service { @Retryable ( RemoteAccessException . class) public void service
Spring-Retry重试实现原理
Java知音
12-04 793
本文来源：http://r6d.cn/LJJN概要 Spring实现了一套重试机制，功能简单实用。Spring Retry是从Spring Batch独立出来的一个功能，已经广泛应用于S...
Spring Retry机制详解
demon7552003的小本本
01-27 2864
Spring框架提供了Spring Retry能让在项目工程中很方便的使用重试。
spring-retry详解
初心不忘、始终方得
07-19 1632
上面的重试次数用完以后还是异常会抛出异常，此时异常我们可以选择在调用方（Retryable方法的调用法）继续处理，也可以选择单独加个方法只用来处理异常，这样调用方（Retryable方法的调用法）就可以只专注处理正常逻辑即可。可以看到，异常后正常进入到了这个方法，其实就是相当于把这个方法代理下将其放入到Retryable中的方法一起执行，所以需要保持两个方法的的高度一致（主要是出入参，同一个类中）。这也就达到了目的了，基础使用就是这样，下面一起看看参数该如何设置。可以看到确实在异常场景进行了重试，
Java 重试框架 Spring-Retry | @Retryable 注解详解
甘蓝的专栏
04-10 2225
Java 重试框架 Spring Retry 的 @Retryable 注解详解。
Java 重试框架 Spring-Retry | 快速入门
甘蓝的专栏
04-10 995
Java 重试框架 Spring Retry 快速入门。
spring-retry 重试框架
玲珑骰子安红豆，入骨相思知不知
12-26 1453
前言 有些场景需要我们对一些异常情况下面的任务进行重试，比如：调用远程的RPC服务，可能由于网络抖动出现第一次调用失败，尝试几次就可以恢复正常。spring-retry是spring提供的一个基于spring的重试框架，非常好用。 官网地址：GitHub - spring-projects/spring-retry 使用说明 1、引入maven依赖 <dependency> <groupId>org.springframework.retry</group.
SpringRetry重试机制（3秒上手）
weixin_53604412的博客
05-23 1770
这些错误可能是因为网络波动造成的，等待过后重处理就能成功。spring-retry可以通过注解，在不入侵原有业务逻辑代码的方式下，优雅的实现重处理功能。
Spring Retry
最新发布
m0_50742275的博客
03-16 1361
Spring Retry
一文了解Spring Retry的详细教程
攻城狮不是猫
02-28 3301
通过选择合适的 BackOffPolicy 实现，并根据具体的业务需求配置其属性，你可以控制重试操作之间的等待时间，以避免过度地重试或者减少对系统的压力。它在每次重试时增加重试的等待时间，使得重试操作在间隔时间上逐渐增加。通过选择合适的 RetryPolicy 实现，并根据具体的业务需求配置其属性，你可以灵活地控制方法的重试行为，从而增强应用程序的可靠性和稳定性。总之，Spring Retry 的注解提供了一种简单而强大的方式来处理重试操作，使得你可以轻松地增加系统的可靠性和健壮性。
一文带你了解Spring Retry
Reische的博客
12-04 229
工作中，经常遇到需要重试的场景，最简单的方式可以用try...catch...加while循环来实现。那么，有没有统一的、优雅一点儿的处理方式呢？有的，Spring Retry就可以帮我们搞定重试问题。什么情况下去触发重试机制重试多少次，重试的时间间隔是否可以对重试过程进行监视接下来，带着这些思考，一起看下Spring Retry是如何解决这些问题的。
详解Spring Retry实现原理
weixin_34366546的博客
06-07 693
本文通过一个简单的例子演示Spring Retry的实现原理，例子中定义的注解只包含重试次数属性，实际上Spring Retry中注解可设置属性要多的多，单纯为了讲解原理，所以弄简单点，关于Spring Retry可查阅相关文档、博客。注解定义package org.java.base.springretry; import java.lang.annotation.*; @Target(El...
Spring Retry实现原理
JIESA的专栏
08-17 1032
在前面这篇博客中介绍了Spring Retry的使用，本文通过一个简单的例子演示Spring Retry的实现原理，例子中定义的注解只包含重试次数属性，实际上Spring Retry中注解可设置属性要多的多，单纯为了讲解原理，所以弄简单点，关于Spring Retry可查阅相关文档、博客。 注解定义 package retry.annotation; import java.lang
java优雅重试机制spring-retry
qq_34905631的博客
10-02 3918
使用JDK动态代理和CGLib动态代理（对目标类进行增强处理）加上spring的AOP（统一的切入调用拦截）加上反射机制（让公共逻辑更加的通用），通过AOP对方法调用进行拦截然后通过动态代理来生成代理对象给目标类的目标方法的调用的前后进行增强处理同时在加上try/catch处理调用目标方法，这种就可以写成一个公共的实现思路模型。/**log . info("监听到重试过程关闭了");log . info("监听到重试过程错误了");log . info("监听到重试过程开启了");
Spring Retry的使用及原理分析
shuoguobufangqi的博客
02-02 2625
spring retry是spring框架的一个模块，它提供了重新调用失败操作的功能。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值