Spring Boot 中使用 Spring Retry 重试：再也不怕代码“掉链子”了-51CTO.COM

引言：生活需要重试，代码也一样！

想象一下，你正在网上支付，结果网络突然卡顿，支付失败。这时候你会怎么做？当然是再试一次！生活中我们经常会遇到各种“失败”，但我们会选择再试一次，而不是轻易放弃。

代码也一样！在网络世界中，我们的 Spring Boot 应用会遇到各种“意外情况”，比如网络连接中断、数据库连接超时等等。如果不对这些异常情况进行处理，应用就会“崩溃”，用户体验也会非常糟糕。

为了让我们的应用更加健壮，就像拥有了“再来一次”的勇气，我们可以使用 Spring Retry 框架来实现重试机制。

Spring Retry：代码的“再来一次”神器

Spring Retry 是 Spring 家族中的一员，它提供了一种简单易用的方式来实现重试功能。简单来说，Spring Retry 可以让你的代码在遇到异常时自动进行重试，直到成功或者达到预设的重试次数。

Spring Boot 集成 Spring Retry：三步轻松搞定

在 Spring Boot 中使用 Spring Retry 非常简单，只需要三个步骤：

(1) 添加依赖：在 pom.xml 文件中添加 spring-retry 依赖：

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>1.
2.
3.
4.

(2) 开启重试功能：在 Spring Boot 应用的启动类上添加 @EnableRetry 注解：

@SpringBootApplication
@EnableRetry
public class MyApplication {
    // ...
}1.
2.
3.
4.
5.

(3) 使用 @Retryable 注解：在需要进行重试的方法上添加 @Retryable 注解，并配置重试策略：

@Service
public class MyService {

    @Retryable(
        value = {IOException.class, SQLException.class}, 
        maxAttempts = 3, 
        backoff = @Backoff(delay = 1000)
    )
    public void myMethod() throws IOException, SQLException {
        // ... 可能抛出异常的代码
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

这段代码表示，当 myMethod() 方法抛出 IOException 或 SQLException 异常时，会进行最多 3 次重试，每次重试的间隔时间为 1 秒。

@Retryable 注解详解：定制你的重试策略

@Retryable 注解提供了丰富的属性，可以灵活地配置重试策略：

value：指定需要重试的异常类型，可以指定多个异常类型。
include 和 exclude：更细粒度地控制需要重试的异常类型。
maxAttempts：设置最大重试次数。
backoff：配置重试间隔时间，支持固定间隔、指数退避等策略。
stateful：指定重试是否是有状态的。如果为 true，则在重试过程中，异常信息会保留。

@Recover 注解详解：最后的防线

@Recover 注解用于标记一个方法，该方法会在 @Retryable 注解标记的方法重试失败后被调用。它就像是一位经验丰富的“替补队员”，在主力队员（重试机制）多次尝试失败后，冷静地接手处理“烂摊子”。注解标记的方法会在以下情况下被调用：

@Retryable 注解标记的方法在指定的最大重试次数后仍未成功。
@Retryable 注解标记的方法抛出了指定的异常，并且所有重试尝试均失败。

实战演练：用 Spring Retry 解决实际问题

场景一：调用第三方 API 经常超时

@Service
public class MyService {

    @Retryable(
        value = {SocketTimeoutException.class}, 
        maxAttempts = 3, 
        backoff = @Backoff(delay = 2000, multiplier = 2)
    )
    public String callApi(String url) throws SocketTimeoutException {
        // ... 调用第三方 API 的代码
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

这段代码表示，当调用第三方 API 超时时，会进行最多 3 次重试，每次重试的间隔时间分别为 2 秒、4 秒、8 秒。

场景二：数据库连接偶尔失败

@Service
public class MyService {

    @Retryable(
        value = {SQLException.class}, 
        maxAttempts = 2, 
        backoff = @Backoff(delay = 500)
    )
    public void updateData(Data data) throws SQLException {
        // ... 更新数据库的代码
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

这段代码表示，当更新数据库失败时，会进行最多 2 次重试，每次重试的间隔时间为 500 毫秒。

场景三：@Retryable 标记的方法重试次数耗尽后自动调用 @Recover 方法

@Service
public class MyService {

    @Retryable(
        value = {SQLException.class}, 
        maxAttempts = 2, 
        backoff = @Backoff(delay = 500)
    )
    public void updateData(Data data) throws SQLException {
        // ... 更新数据库的代码，可能抛出 SQLException 异常
    }

    @Recover
    public void recoverFromUpdateError(SQLException e, Data data) {
        // ... 处理 updateData 方法重试失败后的逻辑，例如记录错误日志、发送告警信息等
        log.error("更新数据失败，数据: {}", data, e);
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.

结语

通过本文，我们了解了 Spring Retry 的基本用法，以及如何在 Spring Boot 中轻松集成这一强大的功能。使用它可以让你的代码更具弹性，更能应对各种“意外情况”。不过也要注意，虽然重试是应对短暂故障的好办法，但也要合理设定重试次数和间隔，防止无限循环和资源浪费。希望这篇文章能帮助你更好地理解和使用 Spring Retry，写出更加健壮的 Spring Boot 应用！