java的spring-retry详解

最新推荐文章于 2024-07-19 10:54:32 发布
最新推荐文章于 2024-07-19 10:54:32 发布
阅读量169 收藏
点赞数
文章标签： java spring php 开发语言 后端
原文链接：https://mp.weixin.qq.com/s?__biz=MzkzNjQzOTE3Nw==&mid=2247489527&idx=1&sn=959791a785fbf2f540b34dd0801770c4&chksm=c35a0ecda312a0e0d740855fbf999b63efa109a3d94f55d8080953502d291c0d552c2a57ee07&scene=126&sessionid=0
版权

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的基本使用，相较于以往的做法，个人认为注解式更为简便，命令式看个人喜好。

微技术
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring（34）——Spring Retry介绍
Elim的博客
05-18 4311
Spring Retry介绍 Spring retry是Spring提供的一种重试机制的解决方案。它内部抽象了一个RetryOperations接口，其定义如下。 public interface RetryOperations { <T, E extends Throwable> T execute(RetryCallback<T, E> retryCallback...
Spring Retry 和 Guava Retrying重试机制的使用详解
01-26
Spring-Retry更适合已经使用Spring框架的项目，因为它提供了声明式重试，集成简单，但在定制性上可能略逊于Guava Retrying。而Guava Retrying则适用于对重试逻辑有高度定制需求的场景，但可能需要更多的编码工作。 ...
Spring-Retry重试实现原理
Java知音
12-04 615
本文来源：http://r6d.cn/LJJN概要 Spring实现了一套重试机制，功能简单实用。Spring Retry是从Spring Batch独立出来的一个功能，已经广泛应用于S...
spring-retry详解
最新发布
初心不忘、始终方得
07-19 1100
上面的重试次数用完以后还是异常会抛出异常，此时异常我们可以选择在调用方（Retryable方法的调用法）继续处理，也可以选择单独加个方法只用来处理异常，这样调用方（Retryable方法的调用法）就可以只专注处理正常逻辑即可。可以看到，异常后正常进入到了这个方法，其实就是相当于把这个方法代理下将其放入到Retryable中的方法一起执行，所以需要保持两个方法的的高度一致（主要是出入参，同一个类中）。这也就达到了目的了，基础使用就是这样，下面一起看看参数该如何设置。可以看到确实在异常场景进行了重试，
spring-retry
都是浮云
08-16 4811
当由于网络波动或者资源被锁等情况需要再次尝试的时候，可以使用spring-retry项目来实现，该项目已经应用到 Spring Batch, Spring Integration等项目。
Spring 中的重试机制，简单、实用！
emprere的博客
02-28 343
上一篇：再见了，收费的Navicat作者：alben来源：https://albenw.github.io/posts/69a9647f/概要Spring实现了一套重试机制，功能简单实用。...
Spring-retry 1.1.4重试功能.rar
09-16
《Spring-retry 1.1.4重试功能详解》 在Java开发中，Spring框架以其强大的功能和灵活的设计深受广大开发者喜爱。Spring-retry是Spring生态中的一个重要组件，它为应用程序提供了优雅的重试机制，能够处理各种可能...
spring-boot集成RabbitMQ
05-03
**Spring Boot 集成 RabbitMQ 知识点详解** Spring Boot 是一款基于 Spring Framework 的快速开发框架，它简化了新 Spring 应用的初始搭建以及开发过程。RabbitMQ 是一个开源的消息队列系统，遵循 Advanced Message...
Spring Boot整合RabbitMQ开发实战详解
08-28
Spring Boot 整合 RabbitMQ 开发实战详解 首先，需要了解 RabbitMQ 中的一些基本概念，包括交换器（Exchange）、队列（Queue）和绑定（Binding）。交换器就像路由器，把消息发到交换器，然后交换器再根据路由键...
java retry_Spring异常重试框架Spring Retry详解
weixin_34194520的博客
02-16 722
Spring Retry支持集成到Spring或者Spring Boot项目中，而它支持AOP的切面注入写法，所以在引入时必须引入aspectjweaver.jar包。快速集成的代码样例： @Configuration@EnableRetrypublic class Application {@Beanpublic Service service() {return new Service();}...
spring-retry jar
07-30
spring-retry jar
Spring Retry机制详解
demon7552003的小本本
01-27 1966
Spring框架提供了Spring Retry能让在项目工程中很方便的使用重试。
Spring Retry实现原理
JIESA的专栏
08-17 943
在前面这篇博客中介绍了Spring Retry的使用，本文通过一个简单的例子演示Spring Retry的实现原理，例子中定义的注解只包含重试次数属性，实际上Spring Retry中注解可设置属性要多的多，单纯为了讲解原理，所以弄简单点，关于Spring Retry可查阅相关文档、博客。 注解定义 package retry.annotation; import java.lang
给JAVA中加入重试机制(Spring Retry)
weixin_44576697的博客
06-19 596
上代码 import java.time.LocalTime; /** * @ProjectName: user * @Package: com.user.service.Impl * @ClassName: PayServiceImpl * @Author: Pond fish * @Description: 重试机制 * @Date: 2020/6/8 13:17 * @Version: 1.0 */ @Service public class PayServiceImpl {
Spring-Retry（重试机制）
qq_38119124的博客
03-21 873
在实际工作中，重处理是一个非常常见的场景，比如:发送消息失败。调用远程服务失败。争抢锁失败。这些错误可能是因为网络波动造成的，等待过后重处理就能成功。通常来说，会用try/catch，while循环之类的语法来进行重处理，但是这样的做法缺乏统一性，并且不是很方便，要多写很多代码。然而spring-retry却可以通过注解，在不入侵原有业务逻辑代码的方式下，优雅的实现重处理功能。一、@Retryable是什么？
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值