Spring Boot集成 Spring Retry 实现容错重试机制并附源码

在这里插入图片描述

😄 19年之后由于某些原因断更了三年,23年重新扬帆起航,推出更多优质博文,希望大家多多支持~
🌷 古之立大事者,不惟有超世之才,亦必有坚忍不拔之志
🎐 个人CSND主页——Micro麦可乐的博客
🐥《Docker实操教程》专栏以最新的Centos版本为基础进行Docker实操教程,入门到实战
🌺《RabbitMQ》专栏主要介绍使用JAVA开发RabbitMQ的系列教程,从基础知识到项目实战
🌸《设计模式》专栏以实际的生活场景为案例进行讲解,让大家对设计模式有一个更清晰的理解
💕《Jenkins实战》专栏主要介绍Jenkins+Docker的实战教程,让你快速掌握项目CI/CD,是2024年最新的实战教程
🌞《Spring Boot》专栏主要介绍我们日常工作项目中经常应用到的功能以及技巧,代码样例完整
如果文章能够给大家带来一定的帮助!欢迎关注、评论互动~

Spring Boot集成 Spring Retry 实现容错重试机制

  • 1、前言
  • 2、什么是 Spring Retry?
  • 3、开始简单集成
  • 4、Spring Retry的高级配置
    • ❶ 自定义重试策略
      • canRetry方法的介绍
      • open方法的介绍
      • close方法的介绍
      • registerThrowable方法的介绍
    • ❷ 使用 RetryTemplate
  • 5、代码汇总
  • 6、总结

1、前言

本文对应源码下载地址: https://download.csdn.net/download/lhmyy521125/89430153 无需积分

在日常开发过程中,我们经常会与第三方接口进行交互,例如:短信发送远程服务调用争抢锁等场景,当正常调用发生异常时,例如:网络延迟服务宕机临时故障等问题,会导致本次请求交互失败,而借助 Spring Retry 能够帮助我们在方法调用失败时自动重试,从而提高系统的稳定性和健壮性。

本文跟着博主由浅入深一起来学习 Spring Retry
在这里插入图片描述

2、什么是 Spring Retry?

Spring Retry 是一个用于简化 Java 方法重试逻辑的库,它能够在方法调用失败时自动重试,并提供了丰富的配置选项,支持重试次数、重试间隔时间、异常类型等配置。通过使用 Spring Retry,可以方便地在 Spring Boot 应用中实现容错和重试机制。

Spring Retry 的特性

  • 自动重试:当方法调用失败时,根据配置的重试策略自动重试
  • 支持多种异常类型:可以配置在遇到特定异常时重试,如 IOExceptionSQLException
  • 重试间隔控制:支持配置重试间隔时间,可以设置固定间隔或指数增长间隔
  • 自定义重试策略:提供了灵活的重试策略接口,可以实现自定义的重试逻辑

3、开始简单集成

构建你的 Spring Boot 项目,在pom.xml中引入依赖

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

配置 Spring Retry 可以通过注解或配置文件进行配置。下面展示如何使用注解方式配置

使用@EnableRetry注解开启
在主类 或对应配置类上加@EnableRetry注解,表示启用重试机制

@SpringBootApplication
@EnableRetry
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}

使用 @Retryable 注解
@Retryable 注解是 Spring Retry 的核心注解,用于标记需要重试的方法。示例代码如下:

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;@Service
public class RetryService {//初始化重试次数private int attempt = 0;@Retryable(value = {RuntimeException.class}, maxAttempts = 5, backoff = @Backoff(delay = 2000))public String retryMethod() {attempt++;System.out.println("重试次数Attempt: " + attempt);if (attempt < 3) {throw new RuntimeException("出现故障, 重试中...");}return "Success!";}
}

配置参数说明
value 指定了需要重试的异常类型,这里是 RuntimeException
maxAttempts 设置了最大重试次数,这里是 5 次
backoff 设置了重试间隔,使用 @Backoff 注解指定延迟时间,单位是毫秒,这里是 2000 毫秒(2秒)

创建一个controller,用于调用重试方法,并测试重试逻辑:

import com.example.demo.service.RetryService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class RetryController {@Autowiredprivate RetryService retryService;@GetMapping("/retry")public String retry() {try {return retryService.retryMethod();} catch (Exception e) {return "重试失败: " + e.getMessage();}}
}

接口请求测试
在这里插入图片描述

观察控制台
在这里插入图片描述
测试你会发现接口请求过程中,控制台一直输出了三次重试次数后成功返回,你以为Spring Retry 就这么点东西?我们继续往下看

4、Spring Retry的高级配置

❶ 自定义重试策略

在某些情况下,默认的重试策略可能无法满足需求,这时可以通过实现 RetryPolicy 接口来自定义重试策略,控制重试的逻辑和条件

import org.springframework.retry.RetryContext;
import org.springframework.retry.RetryPolicy;public class CustomRetryPolicy implements RetryPolicy {private static final int MAX_RETRIES = 3;@Overridepublic boolean canRetry(RetryContext context) {// 检查重试次数int retryCount = context.getRetryCount();if (retryCount >= MAX_RETRIES) {return false; // 如果重试次数达到最大值,不再重试}// 检查异常类型Throwable lastException = context.getLastThrowable();if (lastException instanceof MyCustomException) {// 如果是我们关心的特定异常类型,允许重试return true;}// 其他情况下不允许重试return false;}//MyCustomException 是你定义的异常类型public class MyCustomException extends Exception { /* ... */ }//在重试操作开始时创建新的上下文对象,用于存储重试信息@Overridepublic RetryContext open(RetryContext retryContext) {return null;}//在重试操作结束时执行清理或记录操作@Overridepublic void close(RetryContext retryContext) {}//在重试过程中遇到异常时记录异常信息@Overridepublic void registerThrowable(RetryContext retryContext, Throwable throwable) {}
}

canRetry方法的介绍

boolean canRetry(RetryContext context);

canRetry 方法是重试策略的核心逻辑,通过检查当前的重试上下文信息,决定是否可以继续进行重试。通常会根据重试次数、异常类型等条件来判断是否继续重试

作用:判断是否应该继续进行重试操作
参数:RetryContext context,表示当前的重试上下文,包含了重试次数、上次异常等信息
返回值:boolean,返回 true 表示可以继续重试,返回 false 表示停止重试

open方法的介绍

RetryContext open(RetryContext parent);

在重试操作开始时,Spring Retry 会调用 open 方法创建一个新的 RetryContext,这个上下文对象会在整个重试过程中传递,用于存储重试相关的信息

作用:创建并返回一个新的 RetryContext 对象,表示一次新的重试操作的上下文信息
参数:RetryContext parent,表示父级上下文,如果没有父级上下文则为 null
返回值:RetryContext,表示新的重试上下文

close方法的介绍

当重试操作完成后,无论是否成功,Spring Retry 都会调用 close 方法,可以在这个方法中执行一些清理操作或记录日志

void close(RetryContext context);

作用:在重试操作完成时(无论成功或失败)调用,用于清理或记录重试操作的结束
参数:RetryContext context,表示当前的重试上下文

registerThrowable方法的介绍

void registerThrowable(RetryContext context, Throwable throwable);

在重试过程中,如果遇到异常,Spring Retry 会调用 registerThrowable 方法,将异常信息记录到 RetryContext 中。这个信息可以在后续的重试操作中使用

作用:在重试过程中遇到异常时调用,用于记录当前的异常信息
参数:RetryContext context,表示当前的重试上下文
参数:Throwable throwable,表示当前遇到的异常

Spring配置中使用自定义 RetryPolicy ,同时也可以配置定制 RetryTemplate

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.retry.backoff.FixedBackOffPolicy;
import org.springframework.retry.support.RetryTemplate;@Configuration
public class RetryConfig {@Beanpublic RetryTemplate retryTemplate() {RetryTemplate retryTemplate = new RetryTemplate();// 设置自定义的RetryPolicyCustomRetryPolicy retryPolicy = new CustomRetryPolicy(5);// 还可以设置其他的策略,如BackoffPolicy等  FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();backOffPolicy.setBackOffPeriod(2000);retryTemplate.setRetryPolicy(retryPolicy);retryTemplate.setBackOffPolicy(backOffPolicy);return retryTemplate;}
}

❷ 使用 RetryTemplate

RetryTemplateSpring Retry 提供的一个模板类,允许我们更细粒度地控制重试逻辑。下面是使用 RetryTemplate 的例子

import org.springframework.retry.support.RetryTemplate;
import org.springframework.stereotype.Service;@Service
public class TemplateRetryService {private final RetryTemplate retryTemplate;public TemplateRetryService(RetryTemplate retryTemplate) {this.retryTemplate = retryTemplate;}public String executeWithRetry() {return retryTemplate.execute(context -> {System.out.println("TemplateRetryService执行重试..");if (Math.random() < 0.7) {throw new RuntimeException("重试失败");}return "Success!";});}
}

5、代码汇总

Spring Retry 也是可以与 Spring AOP 配合使用,通过切面拦截方法调用,实现全局的重试逻辑,只需要创建一个切面即可

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Component;@Aspect
@Component
public class RetryAspect {@Before("@annotation(org.springframework.retry.annotation.Retryable)")public void beforeRetry() {System.out.println("执行重试前...");//比如记录请求发起的时间等}
}

讲解了这么多,我们还是把代码汇总一下,进行一次演示,编写一个Controller用来测试两个重试服务

@RestController
@RequestMapping("/api")
public class RetryController {@Autowiredprivate RetryService retryService;@Autowiredprivate TemplateRetryService templateRetryService;@GetMapping("/retry")public String retry() {try {return retryService.retryMethod();} catch (Exception e) {return "重试失败: " + e.getMessage();}}@GetMapping("/template-retry")public String templateRetry() {return templateRetryService.executeWithRetry();}
}

最终代码结构如下:(目的只是为了演示忽略都在一个包中)

在这里插入图片描述

再次运行测试,分别测试 /api/retry 接口以及模板重试服务的接口 /api/template-retry,结果如下:

在这里插入图片描述

OK,至此 Spring Retry 的介绍以及使用已经讲完了,小伙伴们可以根据代码片段自行定制自己的重试策略

6、总结

Spring Retry 是一个强大的工具,能够帮助我们在系统出现临时故障时自动重试,提高系统的稳定性和健壮性。在实际开发中,根据具体的业务需求和系统情况,合理配置和使用 Spring Retry,可以显著提升系统的可靠性。

本文的代码主要是演示使用,小伙伴们可以根据自己业务需求进行修改升级。如果本文对您有所帮助,希望 一键三连 给博主一点点鼓励,如果您有任何疑问或建议,请随时留言讨论


在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/349427.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

verilog阻塞和非阻塞语法

阻塞和非阻塞是FPGA硬件编程中需要了解的一个概念,绝大部分时候,因为非阻塞的方式更加符合时序逻辑设计的思想,有利于时钟和信号的同步,更加有利于时序收敛,所以除非特殊情况,尽量采用非阻塞方式。 1,非阻塞代码 非阻塞赋值,A和B是同时被赋值的,具体是说在时钟的上升…

论文阅读:H-ViT,一种用于医学图像配准的层级化ViT

来自CVPR的一篇文章&#xff0c;https://openaccess.thecvf.com/content/CVPR2024/papers/Ghahremani_H-ViT_A_Hierarchical_Vision_Transformer_for_Deformable_Image_Registration_CVPR_2024_paper.pdf 用CNNTransformer混合模型做图像配准。可变形图像配准是一种在相同视场…

基于单片机的机械手臂控制系统设计

摘 要&#xff1a; 应用单片机 、 Arduino 及机械臂的有关知识&#xff0c;设计一款基于单片机的六自由度机械手臂&#xff0c;并详述其控制系统的软、 硬件设计 。 该机械手臂能够模仿人的上肢完成简单的动作&#xff0c;因此在实验教学演示平台 、 生产或生活中都极具应用价…

Dubbo 3.x源码(20)—Dubbo服务引用源码(3)

基于Dubbo 3.1&#xff0c;详细介绍了Dubbo服务的发布与引用的源码。 此前我们学习了调用createProxy方法&#xff0c;根据服务引用参数map创建服务接口代理引用对象的整体流程&#xff0c;我们知道会调用createInvokerForRemote方法创建远程引用Invoker&#xff0c;这是Dubbo …

Linux文件系统

目录 1.磁盘的结构 1.1磁盘的物理结构 1.2 磁盘的存储结构 1.3 磁盘的逻辑结构 2.文件系统 在上一篇文章基础IO中&#xff0c;我们主要是讲了被打开的文件与进程的关系&#xff0c;以及操作系统是如何管理这些被打开的文件的&#xff0c;但是磁盘有这么多文件&#xff0c;被打…

QT--DAY1

不使用图形化界面实现一个登陆界面 #include "widget.h"Widget::Widget(QWidget *parent): QWidget(parent) {//设置窗口标题this->setWindowTitle("登录界面");//设置窗口大小this->resize(535,410);//固定窗口大小this->setFixedSize(535,410)…

windows 环境下使用git命令导出差异化文件及目录

一、找出差异化的版本&#xff08;再此使用idea的show history&#xff09; 找到两个提交记录的id 分别为&#xff1a; 二、使用git bash执行命令&#xff08;主要使用 tar命令压缩文件&#xff09; 输出结果&#xff1a;

上心师傅的思路分享(三)--Nacos渗透

目录 1. 前言 2. Nacos 2.1 Nacos介绍 2.2 鹰图语法 2.3 fofa语法 2.3 漏洞列表 未授权API接口漏洞 3 环境搭建 3.1 方式一: 3.2 方式二: 3.3 访问方式 4. 工具监测 5. 漏洞复现 5.1 弱口令 5.2 未授权接口 5.3.1 用户信息 API 5.3.2 集群信息 API 5.3.3 配置…

kubernetes(k8s)集群部署(2)

目录 k8s集群类型 k8s集群规划&#xff1a; 1.基础环境准备&#xff1a; &#xff08;1&#xff09;保证可以连接外网 &#xff08;2&#xff09;关闭禁用防火墙和selinux &#xff08;3&#xff09;同步阿里云服务器时间&#xff08;达到集群之间时间同步&#xff09; &…

pytest并发执行时token异常处理问题

接前面加入钩子函数处理token复用的问题&#xff0c;只保证了用例的串联执行&#xff0c;我的部分测试用例中接入了通义千问的部分接口生成测试数据&#xff0c;七八个场景跑完差不多快要10分钟。考虑使用并发执行。 http://t.csdnimg.cn/ACexL 使用多线程和不使用耗时差距很大…

HyperBDR新版本上线,自动化容灾兼容再升级!

本次HyperBDR v5.5.0版本新增完成HCS&#xff08;Huawei Cloud Stack&#xff09;8.3.x和HCSO&#xff08;Huawei Cloud Stack Online&#xff09;自动化对接&#xff0c;另外还突破性完成了Oracle云(块存储模式)的自动化对接。 HyperBDR&#xff0c;云原生业务级别容灾工具。支…

Unity资源 之 最受欢迎的三消游戏开发包 - Bubble Shooter Kit 【免费领取】

三消游戏开发包 - Bubble Shooter Kit 免费领取 前言资源包内容领取兑换码 前言 如果你是一名 Unity 游戏开发者&#xff0c;并且正在寻找一种快速、简单的方式来创建自己的三消游戏&#xff0c;那么 Bubble Shooter Kit 就是你所需要的。 资源包内容 Bubble Shooter Kit 是…

代码随想录算法训练营第36期 last day

最后一次更新&#xff0c;之后去复习专业课和简历 583两个字符串的删除操作 自己做出来了&#xff1a; Code: class Solution {public://找到公共子序列的最大长度dp 最小步数串1.size-dp串2.size-dp int minDistance(string word1, string word2) { vector<v…

用智能插件(Fitten Code: Faster and Better AI Assistant)再次修改vue3 <script setup>留言板

<template><div><button class"openForm" click"openForm" v-if"!formVisible">编辑</button><button click"closeForm" v-if"formVisible">取消编辑</button><hr /><formv-i…

基于梯度下降的多元线性回归原理

为了展示多元线性回归的迭代过程&#xff0c;我们可以使用梯度下降算法手动实现多元线性回归。梯度下降是一种迭代优化算法&#xff0c;用于最小化损失函数。 我们将以下步骤进行手动实现&#xff1a; 初始化回归系数。计算预测值和损失函数。计算梯度。更新回归系数。重复步…

高分论文密码---大尺度空间模拟预测与数字制图

大尺度空间模拟预测和数字制图技术和不确定性分析广泛应用于高分SCI论文之中&#xff0c;号称高分论文密码。大尺度模拟技术可以从不同时空尺度阐明农业生态环境领域的内在机理和时空变化规律&#xff0c;又可以为复杂的机理过程模型大尺度模拟提供技术基础。我们将结合一些经典…

制造业几大系统(MES/WMS/QMS/ERP)的集成

制造业的几大系统包括MES&#xff08;制造执行系统&#xff09;、WMS&#xff08;仓库管理系统&#xff09;、QMS&#xff08;质量管理系统&#xff09;和ERP&#xff08;企业资源计划&#xff09;系统。这些系统在制造业中扮演着不同的角色&#xff0c;可以通过集成实现更高效…

Kafka高频面试题整理

文章目录 1、什么是Kafka?2、kafka基本概念3、工作流程4、Kafka的数据模型与消息存储机制1)索引文件2)数据文件 5、ACKS 机制6、生产者重试机制:7、kafka是pull还是push8、kafka高性能高吞吐的原因1&#xff09;磁盘顺序读写&#xff1a;保证了消息的堆积2&#xff09;零拷贝机…

SqlSugar有实体CURD应用-C#

本文所述开发环境&#xff1a;.C#、NET8、Visual Studio2022 SqlSugar有实体查询数据表 首先根据《SqlSugar使用DbFirst对象根据数据库表结构创建实体类-C#》中的描述的表结构创建所有表的实体类如下&#xff1a; 表名创建的实体类名tb_studentStudenttb_teacherTeachertb_c…

linux的UDP广播测试:C语言代码

测试代码 #include <stdio.h> #include <stdlib.h> #include <string.h> #include <unistd.h> #include <sys/types.h> #include <sys/socket.h> #include <netinet/in.h> #include <arpa/inet.h> #include <netdb.h>#…