SpringBoot3应用中集成和使用Spring Retry的实践记录

 更新时间:2025年06月16日 14:23:57   作者:CoderJia_  
SpringRetry为SpringBoot3提供重试机制,支持注解和编程式两种方式,可配置重试策略与监听器,适用于临时性故障场景,需合理设置次数、退避策略并做好监控,本文给大家详细介绍如何在 SpringBoot 3 应用中集成和使用 Spring Retry,感兴趣的朋友一起看看吧

1. 简介

Spring Retry是Spring生态系统中的一个重要组件,它提供了自动重试失败操作的能力。在分布式系统中,由于网络抖动、服务暂时不可用等临时性故障,重试机制显得尤为重要。本文将详细介绍如何在 SpringBoot 3 应用中集成和使用 Spring Retry。

2. 环境准备

首先在 SpringBoot 3 项目中添加必要的依赖:

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>2.0.5</version>
</dependency>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-aspects</artifactId>
    <version>6.1.13</version>
</dependency>

在启动类或配置类上添加 @EnableRetry 注解以启用重试功能:

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

3. 使用方式

3.1 注解方式 基础使用

最简单的使用方式是通过 @Retryable 注解:

@Service
public class UserService {
    @Retryable
    public void riskyOperation() {
        // 可能失败的操作
    }
}

自定义重试策略

可以通过 @Retryable 注解的参数来自定义重试行为:

@Service
@Slf4j
public class EmailServiceImpl implements IEmailService {
    @Resource
    private JavaMailSender mailSender;
    @Value("${spring.mail.username}")
    private String from;
    /**
     * 发送简单文本邮件
     *
     * @param to
     * @param subject
     * @param text
     */
    @Override
    @Retryable(retryFor = MailSendException.class, maxAttempts = 3, backoff = @Backoff(delay = 1000))
    public void sendSimpleEmail(String to, String subject, String text) {
        try {
            SimpleMailMessage message = new SimpleMailMessage();
            message.setFrom(from);
            message.setTo(to);
            message.setSubject(subject);
            message.setText(text);
            mailSender.send(message);
            log.info("Simple email sent successfully to: {}", to);
        } catch (Exception e) {
            log.error("Failed to send simple email", e);
            throw new MailSendException("Failed to send email", e);
        }
    }
}

当执行发生指定异常,将会尝试进行重试,一旦达到最大尝试次数,但仍有异常发生,就会抛出 ExhaustedRetryException。重试最多可进行三次,两次重试之间的延迟时间默认为一秒。

失败恢复机制

使用 @Recover 注解定义重试失败后的恢复方法:

    /**
     * 发送简单文本邮件
     *
     * @param to
     * @param subject
     * @param text
     */
    @Override
    @Retryable(retryFor = MailSendException.class, // 指定异常类型
            maxAttempts = 3, // 最大重试次数
            backoff = @Backoff(delay = 1000) // 指定退避策略,例如延迟时间
    )
    public void sendSimpleEmail(String to, String subject, String text) {
        try {
            SimpleMailMessage message = new SimpleMailMessage();
            message.setFrom(from);
            message.setTo(to);
            message.setSubject(subject);
            message.setText(text);
            mailSender.send(message);
            log.info("Simple email sent successfully to: {}", to);
        } catch (Exception e) {
            log.error("Failed to send simple email", e.getMessage());
            throw new MailSendException("Failed to send email", e);
        }
    }
    @Recover
    public void recover(MailSendException e, String param) {
        // 处理最终失败的情况
        log.error("Final recovery : {}", param);
    }

重试和失败恢复效果

重试和失败恢复效果

注意事项

注意@Recover 失效的情况:

  • @Recover 方法的参数类型与实际异常不匹配;
  • @Recover 方法的返回类型与 @Retryable 方法不一致;
  • @Recover 方法的其他参数与 @Retryable 方法参数不匹配。

3.2 编程式使用

除了注解方式,Spring Retry 还提供了 RetryTemplate 用于编程式重试:

@Configuration
public class RetryConfig {
    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate template = new RetryTemplate();
        // 配置重试策略
        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
        retryPolicy.setMaxAttempts(3);
        // 配置退避策略
        FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
        backOffPolicy.setBackOffPeriod(1000L);
        template.setRetryPolicy(retryPolicy);
        template.setBackOffPolicy(backOffPolicy);
        return template;
    }
}

使用RetryTemplate:

@Service
public class UserService {
    @Autowired
    private RetryTemplate retryTemplate;
    public void executeWithRetry() {
        retryTemplate.execute(context -> {
            // 需要重试的业务逻辑
            return null;
        });
    }
}

3.3 监听重试过程

通过实现RetryListener接口,可以监听重试的整个生命周期:

public class CustomRetryListener extends RetryListenerSupport {
    @Override
    public <T, E extends Throwable> void onError(RetryContext context, 
            RetryCallback<T, E> callback, Throwable throwable) {
        // 记录错误日志
        log.error("Retry error occurred", throwable);
    }
    @Override
    public <T, E extends Throwable> void close(RetryContext context,
            RetryCallback<T, E> callback, Throwable throwable) {
        // 重试结束时的处理
        log.info("Retry completed");
    }
}

将监听器注册到RetryTemplate:

@Configuration
public class RetryConfig {
    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate template = new RetryTemplate();
        // ... 其他配置 ...
        template.registerListener(new CustomRetryListener());
        return template;
    }
}

监听重试效果

监听重试过程

4. 最佳实践

  • 明确重试场景:只对临时性故障使用重试机制,对于业务错误或永久性故障应直接失败。
  • 设置合理的重试次数:通常3-5次即可,过多的重试可能会加重系统负担。
  • 使用退避策略:建议使用指数退避策略(ExponentialBackOffPolicy),避免立即重试对系统造成冲击。
  • 添加监控和日志:通过RetryListener记录重试情况,便于问题排查。
  • 设置超时时间:避免重试过程持续时间过长。

5. 总结

Spring Retry为Spring应用提供了强大而灵活的重试机制,既可以通过注解优雅地实现重试,也可以使用RetryTemplate进行更细粒度的控制。在实际应用中,合理使用重试机制可以提高系统的健壮性和可用性。

需要注意的是,重试机制并非万能药,在使用时要根据具体场景选择合适的重试策略,并做好监控和告警,以便及时发现和处理问题。

到此这篇关于SpringBoot3应用中集成和使用Spring Retry的实践记录的文章就介绍到这了,更多相关SpringBoot3 Spring Retry内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java导出生成word的简单方法

    java导出生成word的简单方法

    这篇文章主要为大家详细介绍了java导出生成word的简单方法,感兴趣的朋友可以参考一下
    2016-03-03
  • SpringBoot在一定时间内限制接口请求次数的实现示例

    SpringBoot在一定时间内限制接口请求次数的实现示例

    在项目中,接口的暴露在外面,很多人就会恶意多次快速请求,本文主要介绍了SpringBoot在一定时间内限制接口请求次数的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2022-03-03
  • java实现文件保存到本地的方法

    java实现文件保存到本地的方法

    本篇文章主要介绍了java实现文件保存到本地的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • 浅谈如何在项目中使用Spring Cloud Alibaba Sentinel组件

    浅谈如何在项目中使用Spring Cloud Alibaba Sentinel组件

    随着微服务的流行,服务和服务之间的稳定性变得越来越重要。本文主要介绍了使用Spring Cloud Alibaba Sentinel组件,感兴趣的可以了解一下
    2021-07-07
  • Java调用HTTPS接口的两种方式及完整代码

    Java调用HTTPS接口的两种方式及完整代码

    HTTPS是以安全为目标的HTTP通道,在HTTP的基础上通过传输加密和身份认证保证了传输过程的安全性 ,HTTPS在HTTP的基础下加SSL,HTTPS的安全基础是SSL,因此加密的详细内容就需要SSL,本文给大家介绍了Java调用https接口的两种方式及完整代码,需要的朋友可以参考下
    2025-05-05
  • JAVA使用hutool工具实现查询树结构数据(省市区)

    JAVA使用hutool工具实现查询树结构数据(省市区)

    今天通过本文给大家分享JAVA使用hutool工具实现查询树结构数据(省市区),代码分为表结构和数据结构,代码简单易懂,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2021-08-08
  • 几道java循环练习题(适合新人)

    几道java循环练习题(适合新人)

    这篇文章主要给大家介绍了几道java循环练习题,非常适合刚入门的java新人,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • Java数组与堆栈相关知识总结

    Java数组与堆栈相关知识总结

    今天给大家带来的是关于Java的相关知识,文章围绕着Java数组与堆栈展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • java实现CSV 字段分割

    java实现CSV 字段分割

    这篇文章主要介绍了java实现CSV 字段分割的相关资料,需要的朋友可以参考下
    2015-07-07
  • shade解决mybatis包冲突问题及项目引用的方法

    shade解决mybatis包冲突问题及项目引用的方法

    这篇文章主要介绍了shade解决mybatis包冲突问题及项目引用的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08

最新评论