使用 Spring Retry 实现数据库连接重试案例


一个金融应用程序：当客户发送请求时，使用客户端的用户ID从第三方服务获取他们的账户信息，保存交易并更新缓存中的详细信息。

尽管整个流程看似简单，但每个下游系统都不可靠。

我们必须在每个层上实现重试，而且我们必须控制重试的次数和每次重试之间的延迟，这样我们就不会让下游系统超载。

由于我们必须在每个层上实现重试，我们不得不编写大量的模板代码，这不仅容易出错，而且难以维护。

由于每个下游系统都有自己的重试要求，我们不得不添加越来越多的代码，这就像在现有的垃圾上添加垃圾一样。随着时间的推移，代码变得非常脆弱，即使是很小的改动也会破坏整个系统。

为了解决这个问题，我们决定使用Spring Retry。

Spring Retry 是 Spring Batch 的一个子项目，它提供了一组注释和接口，您可以使用它们向代码添加重试逻辑。它提供了一种向代码添加重试逻辑的声明性方法。要了解有关 Spring Retry 的更多信息，参考此处的文档

1、加入依赖：

<dependency>
   <groupId>org.springframework.retry</groupId>
   <artifactId>spring-retry</artifactId>
   <version>2.0.0</version>
</dependency>

<dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-aspects</artifactId>
   <version>5.2.8.RELEASE</version>
</dependency>

2、激活retry:

@Configuration
@EnableRetry
public class ApplicationConfig { }

3、常用参数解释：

  • 通过@Retryable注解，可以指定想重试的异常，
  • 通过maxAttempts，可以指定我想重试的次数。
  • 使用指数延迟的CacheRetries
  • 通过backoff，可以指定每次重试之间的延迟。

4. 使用 RetryListenerSupport 消除错误和重试时的重复操作
对以下事件发出度量，例如：

  • 连接到MySql数据库时
  • 连接MySql数据库失败时 用尽所有重试

使用RetryTemplate上的registerListener方法注册RetryListenerSupport：

@Configuration
public class ApplicationConfig {
 
  @Bean
  public RetryTemplate installTemplate() {
     RetryTemplate retryTemplate = new RetryTemplate();
     retryTemplate.registerListener(new DefaultListenerSupport());
     return retryTemplate;
  }
}

RetryListenerSupport提供了三个方法，我们可以覆盖这些方法来添加我们的自定义逻辑：

  • onError - 当出现错误时调用该方法
  • close- 当所有重试结束时调用该方法。
  • open - 当重试开始时调用该方法。

使用RetryListenerSupport能替代以下MySQL连接重试代码：