Spring-Retry重试框架使用教程

Spring Retry 提供了两种主要的使用方式：注解驱动的方式和使用 RetryTemplate 编程式的方式。以下是详细的介绍和示例代码。

1. 注解方式

Spring Retry 提供了注解支持，可以通过简单的注解配置来启用重试逻辑。

引入依赖

首先，确保在项目的 pom.xml 中引入 Spring Retry 的依赖：

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

配置 Spring Retry

在 Spring Boot 应用的主类或者任意配置类上启用 Spring Retry 支持：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.retry.annotation.EnableRetry;

@SpringBootApplication
@EnableRetry
public class RetryApplication {

    public static void main(String[] args) {
        SpringApplication.run(RetryApplication.class, args);
    }
}

使用 @Retryable 注解

在需要重试的服务方法上使用 @Retryable 注解来配置重试逻辑：

import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.retry.annotation.Recover;
import org.springframework.stereotype.Service;

@Service
public class RetryService {

    @Retryable(value = {IOException.class}, maxAttempts = 5, backoff = @Backoff(delay = 2000))
    public void performOperation() throws IOException {
        System.out.println("Trying to perform operation...");
        if (someCondition()) {
            throw new IOException("Operation failed, will retry...");
        }
        System.out.println("Operation succeeded!");
    }

    @Recover
    public void recover(IOException e) {
        System.out.println("Recovering from exception: " + e.getMessage());
    }

    private boolean someCondition() {
        return true; // Simulate a failure condition
    }
}

说明

• @Retryable: 指定重试的异常类型 value = {IOException.class}，最大重试次数 maxAttempts = 5，以及重试之间的延迟时间 backoff = @Backoff(delay = 2000)（单位为毫秒）。
• @Recover: 当重试次数耗尽且仍然失败时，将调用这个方法进行恢复操作。@Recover 方法的参数类型应与重试时抛出的异常类型相匹配。

2. 使用 RetryTemplate

RetryTemplate 提供了更灵活的编程式重试机制，适合在复杂场景中使用。

引入依赖

同样地，需要在 pom.xml 中引入 Spring Retry 的依赖：

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

使用 RetryTemplate

创建并配置一个 RetryTemplate 实例：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.RetryListener;
import org.springframework.retry.support.RetryTemplate;

import java.io.IOException;

@Configuration
public class RetryConfig {

    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate retryTemplate = RetryTemplate.builder()
            .maxAttempts(5)
            .fixedBackoff(2000)
            .retryOn(IOException.class)
            .withListener(new DefaultRetryListener())
            .build();
        return retryTemplate;
    }

    public static class DefaultRetryListener implements RetryListener {
        @Override
        public <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {
            System.out.println("Retry attempt " + context.getRetryCount() + " failed: " + throwable.getMessage());
        }
    }
}

在服务类中使用 RetryTemplate 来执行带有重试机制的操作：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.retry.RetryCallback;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.stereotype.Service;

import java.io.IOException;

@Service
public class RetryService {

    @Autowired
    private RetryTemplate retryTemplate;

    public void performOperation() {
        try {
            retryTemplate.execute((RetryCallback<Void, IOException>) context -> {
                System.out.println("Trying to perform operation...");
                if (someCondition()) {
                    throw new IOException("Operation failed, will retry...");
                }
                System.out.println("Operation succeeded!");
                return null;
            });
        } catch (IOException e) {
            System.out.println("Operation failed after retries: " + e.getMessage());
        }
    }

    private boolean someCondition() {
        return true; // Simulate a failure condition
    }
}

说明

• RetryTemplate.builder(): 通过流式 API 创建和配置 RetryTemplate，例如 maxAttempts、fixedBackoff、retryOn 等。
• RetryListener: 自定义的监听器 DefaultRetryListener 用于在每次重试失败时记录日志或执行其他操作。
• RetryCallback: 在 retryTemplate.execute() 中定义要执行的重试逻辑。您可以在回调中捕获和处理异常。

总结

• 注解方式：简单、直观，适用于大多数常见的重试场景。通过 @Retryable 注解快速实现重试机制，并通过 @Recover 处理重试失败后的恢复逻辑。
• RetryTemplate：更灵活、可编程，适用于复杂或高度自定义的场景。通过编程方式构建和执行重试操作，可以在运行时动态调整重试行为。