Spring Retry

server/2025/3/18 0:38:19/

1. Spring Retry 的工作原理

内部机制

Spring Retry 主要通过 AOP(面向切面编程)实现重试逻辑。以下是 Spring Retry 的内部工作流程:

  1. AOP 拦截器:当一个方法被标记为需要重试,并且该方法抛出了指定类型的异常时,Spring AOP 拦截器会拦截该调用。
  2. 异常捕获:如果该方法抛出指定类型的异常,AOP 拦截器会检查是否符合重试条件。
  3. 重试策略判断:根据配置的 RetryPolicy 和 BackOffPolicy,决定是否进行重试以及重试的时间间隔。
  4. 等待:根据 BackOffPolicy 等待一段时间。
  5. 重试:再次调用目标方法。
  6. 恢复逻辑:如果所有重试都失败,则执行 @Recover 注解定义的恢复逻辑。
RetryTemplate 的工作流程

RetryTemplate 是 Spring Retry 的核心类,它负责管理重试逻辑。以下是它的主要步骤:

  1. 初始化:根据配置初始化 RetryPolicy 和 BackOffPolicy
  2. 方法调用:尝试调用目标方法。
  3. 异常捕获:如果方法抛出异常,检查是否符合重试条件。
  4. 等待:根据 BackOffPolicy 等待一段时间。
  5. 重试:再次调用目标方法。
  6. 恢复:如果所有重试都失败,执行 RecoveryCallback

2. 核心概念的深度解析

RetryPolicy

RetryPolicy 定义了重试策略,决定了在什么情况下应该重试。Spring 提供了几种内置的 RetryPolicy 实现,同时支持自定义实现。

  • SimpleRetryPolicy:基于尝试次数的简单策略。

    java">SimpleRetryPolicy policy = new SimpleRetryPolicy();
    policy.setMaxAttempts(5); // 设置最大重试次数为5次
  • TimeoutRetryPolicy:基于时间的策略,允许在指定时间内进行重试。

    java">TimeoutRetryPolicy timeoutPolicy = new TimeoutRetryPolicy();
    timeoutPolicy.setTimeout(5000L); // 设置超时时间为5秒
  • ExceptionClassifierRetryPolicy:根据异常类型决定是否重试。可以通过该策略为不同的异常设置不同的重试策略。

    java">Map<Class<? extends Throwable>, Boolean> retryableExceptions = new HashMap<>();
    retryableExceptions.put(IllegalArgumentException.class, true);
    retryableExceptions.put(NullPointerException.class, false);ExceptionClassifierRetryPolicy classifier = new ExceptionClassifierRetryPolicy();
    classifier.setPolicyMap(retryableExceptions);
  • CompositeRetryPolicy:组合多个 RetryPolicy,可以定义复杂的重试策略。

BackOffPolicy

BackOffPolicy 控制每次重试之间的等待时间。常见的策略包括:

  • FixedBackOffPolicy:固定延迟时间。

    java">FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
    backOffPolicy.setBackOffPeriod(2000L); // 设置每次重试之间的延迟时间为2秒
  • ExponentialBackOffPolicy:指数增长的延迟时间。

    java">ExponentialBackOffPolicy exponentialBackOffPolicy = new ExponentialBackOffPolicy();
    exponentialBackOffPolicy.setInitialInterval(1000L); // 初始延迟时间1秒
    exponentialBackOffPolicy.setMultiplier(2.0); // 每次重试延迟时间乘以2
    exponentialBackOffPolicy.setMaxInterval(10000L); // 最大延迟时间10秒
  • NoBackOffPolicy:无延迟,立即重试。

  • UniformRandomBackOffPolicy:随机延迟时间,但有上下限。

RecoveryCallback

当所有重试都失败后执行的回调函数。用于处理最终失败的情况。

java">@Recover
public void recover(RuntimeException e) {System.out.println("All retries failed due to: " + e.getMessage());
}

3. 配置方式

注解方式
主配置类

首先,在主配置类中启用重试功能:

java">import org.springframework.context.annotation.Configuration;
import org.springframework.retry.annotation.EnableRetry;@Configuration
@EnableRetry // 启用Spring Retry功能
public class AppConfig {
}
服务层实现

然后,在需要重试的方法上添加 @Retryable 注解,并且可以定义恢复逻辑:

java">import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;@Service
public class MyService {/*** 使用@Retryable注解的方法,允许在遇到特定异常时进行重试。*/@Retryable(value = {RuntimeException.class}, // 当发生RuntimeException异常时进行重试maxAttempts = 4, // 设置最大重试次数为4次backoff = @Backoff(delay = 2000) // 设置每次重试之间的延迟时间为2秒)public void serviceMethod() throws Exception {System.out.println("Attempting to execute service method...");throw new RuntimeException("Service failure"); // 模拟服务失败}/*** 定义恢复逻辑,当所有重试都失败后执行。*/@Recover // 定义恢复逻辑,当所有重试都失败后执行public void recover(RuntimeException e) {System.out.println("All retries failed due to: " + e.getMessage());}
}
Java 配置类方式

通过 Java 配置类的方式可以手动配置重试模板和拦截器:

java">import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.retry.backoff.ExponentialBackOffPolicy;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.support.RetryTemplate;@Configuration
public class RetryConfig {@Beanpublic RetryTemplate retryTemplate() {RetryTemplate retryTemplate = new RetryTemplate();SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();retryPolicy.setMaxAttempts(4); // 设置最大重试次数为4次retryTemplate.setRetryPolicy(retryPolicy);ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();backOffPolicy.setInitialInterval(2000L); // 初始延迟时间2秒retryTemplate.setBackOffPolicy(backOffPolicy);return retryTemplate;}
}

4. 高级用法

自定义 RetryPolicy 和 BackOffPolicy

你可以创建自定义的 RetryPolicyBackOffPolicy,以满足特定需求。例如,创建一个基于业务逻辑的重试策略:

java">import org.springframework.retry.RetryPolicy;
import org.springframework.retry.RetryContext;public class CustomRetryPolicy implements RetryPolicy {private int attempts = 0;private final int maxAttempts = 3;@Overridepublic boolean canRetry(RetryContext context) {attempts++;return attempts <= maxAttempts;}@Overridepublic void close(RetryContext context) {// 清理资源}@Overridepublic void registerThrowable(RetryContext context, Throwable throwable) {// 处理抛出的异常}
}
异常分类器

可以使用 ExceptionClassifierRetryPolicy 来根据不同的异常类型应用不同的重试策略:

java">import org.springframework.retry.policy.ExceptionClassifierRetryPolicy;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.policy.TimeoutRetryPolicy;@Bean
public RetryTemplate customRetryTemplate() {ExceptionClassifierRetryPolicy classifier = new ExceptionClassifierRetryPolicy();Map<Class<? extends Throwable>, RetryPolicy> policyMap = new HashMap<>();policyMap.put(IllegalArgumentException.class, new SimpleRetryPolicy(3));policyMap.put(NullPointerException.class, new TimeoutRetryPolicy());classifier.setPolicyMap(policyMap);RetryTemplate template = new RetryTemplate();template.setRetryPolicy(classifier);return template;
}
使用 RetryTemplate 手动控制重试

除了使用注解外,你还可以手动使用 RetryTemplate 来控制重试逻辑:

java">@Autowired
private RetryTemplate retryTemplate;public void performOperation() {retryTemplate.execute(context -> {try {// 执行业务逻辑return null;} catch (Exception e) {throw new RuntimeException(e);}});
}

5. 常见问题及解决方案

1. 重试不生效

确保已经正确启用了 @EnableRetry 注解,并且你的方法上有 @Retryable 注解。同时检查异常类型是否匹配。

2. 事务回滚问题

如果你在重试过程中使用了事务,确保事务能够正确回滚。可以使用 @Transactional 注解来管理事务。

java">import org.springframework.transaction.annotation.Transactional;@Service
public class MyService {@Transactional@Retryable(value = {RuntimeException.class},maxAttempts = 4,backoff = @Backoff(delay = 2000))public void serviceMethod() throws Exception {// 业务逻辑}
}
3. 性能瓶颈

过多的重试可能导致性能瓶颈。确保只在必要的情况下使用重试,并合理设置重试次数和延迟时间。

示例代码详解

示例1:结合 Spring Boot 和 Spring Retry

以下是一个完整的 Spring Boot 应用示例,展示了如何结合 Spring Retry 来处理临时性故障:

java">import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.retry.annotation.EnableRetry;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;@SpringBootApplication
@EnableRetry // 启用Spring Retry功能
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}@Service
public class MyService {@Retryable(value = {RuntimeException.class},maxAttempts = 4,backoff = @Backoff(delay = 2000))public void serviceMethod() throws Exception {System.out.println("Attempting to execute service method...");throw new RuntimeException("Service failure");}@Recoverpublic void recover(RuntimeException e) {System.out.println("All retries failed due to: " + e.getMessage());}
}
示例2:自定义重试策略

以下是一个自定义重试策略的示例:

java">import org.springframework.retry.RetryPolicy;
import org.springframework.retry.RetryContext;public class CustomRetryPolicy implements RetryPolicy {private int attempts = 0;private final int maxAttempts = 3;@Overridepublic boolean canRetry(RetryContext context) {attempts++;return attempts <= maxAttempts;}@Overridepublic void close(RetryContext context) {// 清理资源}@Overridepublic void registerThrowable(RetryContext context, Throwable throwable) {// 处理抛出的异常}
}

6. 最佳实践与注意事项

选择合适的异常类型

只对那些预期可能会暂时失败的操作进行重试,例如网络请求失败、远程服务不可用等情况。避免对非幂等操作进行重试,以免产生副作用。

设置合理的最大尝试次数和延迟
  • maxAttempts:设定最大尝试次数,避免无限重试导致系统资源耗尽。
  • delay:设定重试间隔时间,防止过快重试对系统造成额外压力。
事务管理

如果操作涉及到数据库事务,需注意重试机制如何与事务交互。通常,Spring Retry 不会自动回滚事务,因此你可能需要手动处理事务回滚。

幂等性

确保重试的方法是幂等的,即多次执行同样的操作不会产生副作用或错误结果。这对于涉及数据修改的操作尤为重要。

异常传播

如果所有重试都失败了,最后一个异常会被传播给调用者。可以通过 @Recover 注解定义恢复逻辑。

性能考虑

考虑到重试机制带来的性能开销,确保只在必要的地方使用重试,并合理配置重试策略。

日志记录

在重试逻辑中加入适当的日志记录,有助于调试和监控系统的运行状态。


http://www.ppmy.cn/server/175817.html

相关文章

[RN 实践有效]Expo+cross-env配置项目环境变量

首先,从中可以看出,cross-env的主要作用是跨平台设置环境变量,而Expo项目通常通过app.config.js或.env文件来管理这些变量。需要强调安装cross-env的必要性,以及如何在package.json中正确配置脚本命令。 接下来,用户的问题是关于Expo中cross-env的详细配置,因此需要分步骤…

Maven核心包:maven-resolver-api

在阅读 nexus-pubic 开源项目过程中&#xff0c;使用了大量的核心组件进行轻量化集成。它的这种构建方式&#xff0c;在阅读过程中不得不感概&#xff0c;节省成本从构建项目的方式上就遥遥领先了。但是 maven核心包&#xff0c;依然使用前几年的aether-spi&#xff0c;却没有更…

[网络] 网络基础概念--socket编程预备

文章目录 1. 理解 ip 地址和目的 IP 地址 -> 区分主机唯一性2. 认识端口号3. socket 套接字4. 传输层的代表协议 -> tcp & udp5. 网络字节序列 -> 大端序列6. socket 编程接口 继前文, 前文提到了网络传输的基本流程, 那下面我们继续来讨论一点关于网络基础概念的…

ubuntu-linux-系统用户界面无法显示-弹出报警框!

文章目录 简介方法一&#xff1a;使用第二用户使用文本控制台 方法二&#xff1a;结语扩展&#xff08;请务必阅读&#xff09; 简介 请创建第二用户或者准备u盘启动盘&#xff08;ubuntu系统就行&#xff09;&#xff01; 原因&#xff1a;本人电脑在后续的开机过程中&#x…

QT信号与槽:实现方法、技术细节、高级用法和底层机制

1. 基本概念 信号&#xff08;signals&#xff09;&#xff1a;当对象的状态发生变化或发生特定事件时&#xff0c;自动触发的通知。比如PushButton常见的信号是clicked()信号。 槽&#xff1a;接收信号并执行逻辑的成员函数。可定义在类的任何部分&#xff08;public、priva…

【leetcode hot 100 199】二叉树的右视图

解法一&#xff1a;层级遍历&#xff0c;右侧看到的节点就是每一层最后一个元素 /*** Definition for a binary tree node.* public class TreeNode {* int val;* TreeNode left;* TreeNode right;* TreeNode() {}* TreeNode(int val) { this.val val; }…

Chrome/Edge浏览器离线安装插件全攻略:CRX/ZIP文件手动安装教程

&#x1f527; 准备工作 从可信渠道下载扩展文件&#xff1a; .crx 格式&#xff08;Chrome/Edge原生插件包&#xff09;.zip 格式&#xff08;已解压的插件文件夹&#xff09; &#x1f4a1; 推荐下载源&#xff1a; Chrome插件镜像站 &#x1f6e0;️ 详细安装步骤 步骤1&a…

江科大51单片机笔记【12】AT24C02(I2C总线)

写在前言 此为博主自学江科大51单片机&#xff08;B站&#xff09;的笔记&#xff0c;方便后续重温知识 在后面的章节中&#xff0c;为了防止篇幅过长和易于查找&#xff0c;我把一个小节分成两部分来发&#xff0c;上章节主要是关于本节课的硬件介绍、电路图、原理图等理论知识…