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

最新推荐文章于 2024-11-12 21:57:48 发布
最新推荐文章于 2024-11-12 21:57:48 发布
阅读量1.5w 收藏 42
点赞数 64
分类专栏： Spring Boot 文章标签： spring spring boot 后端 重试机制 spring retry
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lhmyy521125/article/details/139661753
版权

在这里插入图片描述

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

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

1、前言

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

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

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

2、什么是 Spring Retry？

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

Spring Retry 的特性

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

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;

@RestController

public class RetryController {
    @Autowired
    private 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;
    @Override
    public 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 { /* ... */ }
	
	//在重试操作开始时创建新的上下文对象，用于存储重试信息
	@Override
    public RetryContext open(RetryContext retryContext) {
        return null;
    }

	//在重试操作结束时执行清理或记录操作
    @Override
    public void close(RetryContext retryContext) {

    }

	//在重试过程中遇到异常时记录异常信息
    @Override
    public 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 {

    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate retryTemplate = new RetryTemplate();

        // 设置自定义的RetryPolicy
        CustomRetryPolicy retryPolicy = new CustomRetryPolicy(5);

        // 还可以设置其他的策略，如BackoffPolicy等  
        FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
        backOffPolicy.setBackOffPeriod(2000);

        retryTemplate.setRetryPolicy(retryPolicy);
        retryTemplate.setBackOffPolicy(backOffPolicy);

        return retryTemplate;
    }
}

❷ 使用 RetryTemplate

RetryTemplate 是 Spring 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 {
    @Autowired
    private RetryService retryService;

    @Autowired
    private 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，可以显著提升系统的可靠性。

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

在这里插入图片描述

Micro麦可乐
关注
专栏目录
基于springboot整合spring-retry
软件老王
06-09 697
1、背景 本系统调用外围系统接口（http+json），但是发现有时外围系统服务不太稳定，有时候会出现返回一串xml或者gateway bad的信息，导致调用失败，基于这一原因，采用基于springboot，整合spring-retry的重试机制到系统工程中，demo已经放到github上。 2、解决方案 简要说明：demo工程基于springboot，为了方便验证，采用swagger进行测试验证。 2.1 pom文件 <?xml version="1.0" encoding="UTF-8"?>
【SpringBoot】spring-retry(重试机制)
墩墩分墩
11-27 5638
在调用第三方接口或者使用Mq时，会出现网络抖动，连接超时等网络异常，所以需要重试。 网络抖动：标识一个网络的稳定性。抖动越小，网络越稳定。 Spring Retry是从Spring Batch 2.2.0版本独立出来的一个功能，主要实现了重试和熔断。 在 Spring Retry需要指定触发重试的异常类型，并设置每次重试的间隔以及如果重试失败是继续重试还是熔断（停止重试）。 对于重试是有场景限制的，不是什么场景都适合重试，比如参数校验不合法、写操作等（要考虑写是否幂等）都不适合重试。远程调用超时、网
编码技巧——重试模板RetryTemplate
娜娜米的博客
04-20 4911
本篇介绍Spring RetryTemplate的原理及使用的代码示例； 日常开发中，经常会遇到这样的场景：执行一次接口调用，如RPC调用，偶现失败，原因可能是dubbo超时、连接数耗尽、http网络抖动等，出现异常时我们并不能立即知道原因并作出反应，可能只是一个普通的RpcException或RuntimeException， 对于这种小概率的异常，往往需要尝试再次调用（前提是接口是幂等的），因为由于网络问题、下游服务暂时的不稳定导致的异常，段时间后理论上是可以自恢复的；
Spring 框架——@Retryable 注解与 @Recover 注解
代码星辰的博客
09-10 1405
本文介绍了 @Retryable 注解与 @Recover 注解的相关知识。
Spring Boot集成Spring Retry快速入门Demo
HBLOG
04-03 743
1.Retry介绍Spring Retry提供了自动重新调用失败的操作的功能。这在错误可能是暂时的（例如瞬时网络故障）的情况下很有用。从2.2.0版本开始，重试功能已从Spring Batch中撤出，成为一个独立的新库：Spring Retry使用场景在日常开发过程中，难免会与第三方接口发生交互，例如：短信发送、远程服务调用、争抢锁等场景，当正常调用发生异常时，例如：网络抖动，这些间歇性的异常在一...
Spring Boot-整合Retry框架重试机制
qq_37661970的博客
03-22 1330
Retry重试框架，支持AOP切入的方式使用，支持注解;重试次数，重试延迟、重试触发条件、重试的回调方法等功能来实现重试机制项目中我们可以通过两种不同的方式使用Spring Retry重试功能，一种是@Retryable注解的方式，另种是RetryTemplate方式。
Spring Boot 中使用 Spring Retry 重试：再也不怕代码“掉链子”了
05-28 1582
Recover注解用于标记一个方法，该方法会在 @Retryable 注解标记的方法重试失败后被调用。它就像是一位经验丰富的“替补队员”，在主力队员（重试机制）多次尝试失败后，冷静地接手处理“烂摊子”。@Retryable 注解标记的方法在指定的最大重试次数后仍未成功。@Retryable 注解标记的方法抛出了指定的异常，并且所有重试尝试均失败。通过本文，我们了解了 Spring Retry 的基本用法，以及如何在 Spring Boot 中轻松集成这一强大的功能。
Spring Boot集成 Spring Retry 实现容错重试机制教程配套源码
06-13
该源码对应个人博客【Spring Boot集成 Spring Retry 实现容错重试机制】配套教程，地址：https://blog.csdn.net/lhmyy521125/article/details/139661753 小伙伴可以自行下载学习！不需要积分！不需要积分！不需要...
SpringCloud Alibaba系列——10Dubbo的集群容错原理
Eclipse_2019的博客
08-02 460
Dubbo的集群容错有哪几种及各自的特点；Dubbo的集群容错原理。
Spring Cloud Circuit Breaker：服务容错保护
最新发布
m0_64132144的博客
11-12 534
在微服务架构中，服务与服务之间通过远程调用的方式进行通信，一旦某个被调用的服务发生了故障，其依赖服务也会发生故障，此时就会发生故障的蔓延，最终导致系统瘫痪。Circuit Breaker实现了断路器模式，当某个服务发生故障时，断路器会根据设置的容错保护策略，给调用方返回一个错误响应，而不是长时间的等待，这样就不会使得调用方由于长时间得不到响应而占用线程，从而防止故障的蔓延。Circuit Breaker具备服务熔断、接口限流、请求重试、超时控制等强大功能。
SpringCloudHytrix服务容错—源码分析
weixin_44969687的博客
05-23 878
SpringCloudHytrix服务容错机制 文章目录SpringCloudHytrix服务容错机制服务雪崩集群容错服务隔离服务熔断服务降级SpringCloud容错方案Hytrix原理实现--源码分析@EnableCircuitBreaker注解EnableCircuitBreakerImportSelector导入类HystrixCircuitBreakerConfiguration配置类HystrixCommandAspect切面HytrixInvokable接口的两个实现类1. AbstractC
详解spring boot使用@Retryable来进行重处理
08-30
本篇文章主要介绍了详解spring boot使用@Retryable来进行重处理，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Spring boot使用spring retry重试机制的方法示例
08-25
主要介绍了Spring boot使用spring retry重试机制的方法示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
springboot整合springcloud的eureka、配置中心、服务调用、Hystrix、Zuul网关
weixin_45865428的博客
07-11 1118
前言：springboot整合springcloud的eureka、配置中心、服务调用、Hystrix、Zuul网关
springboot集成spring retry实现重试机制
Jaemon
05-04 954
springboot集成spring retry实现重试机制
SpringBoot集成retry（7）
qq_43334498的博客
08-08 274
代码】SpringBoot集成retry（7）
SpringBoot Retry机制
myli92的博客
11-18 3292
重试机制在网络服务中非常的重要，由于网路可能存在延迟，网络抖动，网络不稳定的情况。同时在分布式服务中网络的请求的高度密集，有些服务不一定能在规定的时间内完成访问。应该请求服务需要重试几次。以保证服务请求成功。
spring-boot+spring-retry
guduyishuai的博客
11-25 690
废话不多说，直接上干货 一、maven org.springframework.boot spring-boot-starter-aop org.springframework.retry spring-retry             二、接口的方法 如果需要retry的方法为接口的方法，那需要加入如下配置
springboot整合spring retry 重试机制
Elvira_Sunset的博客
05-13 448
当我们调用一个接口可能由于网络等原因造成第一次失败，再去尝试就成功了，这就是重试机制，spring支持重试机制，并且在Spring Cloud中可以与Hystaix结合使用，可以避免访问到已经不正常的实例。 但是切记非幂等情况下慎用重试 一 加入依赖 <dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId&g
评论 46
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Micro麦可乐

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值