Spring框架中一个有用的小组件之Spring Retry组件详解

更新时间：2021年07月23日 09:15:50 作者：码农熊猫

Spring Retry 是从 Spring batch 中独立出来的一个功能，主要实现了重试和熔断，对于那些重试后不会改变结果，毫无意义的操作，不建议使用重试，今天通过本文给大家介绍Spring Retry组件详解，感兴趣的朋友一起看看吧

1、概述

Spring Retry 是Spring框架中的一个组件，
它提供了自动重新调用失败操作的能力。这在错误可能是暂时发生的（如瞬时网络故障）的情况下很有帮助。

在本文中，我们将看到使用Spring Retry的各种方式：注解、RetryTemplate以及回调。

2、Maven依赖

让我们首先将spring-retry依赖项添加到我们的pom.xml文件中：

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

我们还需要将Spring AOP添加到我们的项目中：

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

可以查看Maven Central来获取最新版本的spring-retry
和spring-aspects 依赖项。

3、开启Spring Retry

要在应用程序中启用Spring Retry，我们需要将@EnableRetry注释添加到我们的@Configuration类：

@Configuration
@EnableRetry
public class AppConfig { ... }

4、使用Spring Retry

4.1、@Retryable而不用恢复

我们可以使用@Retryable注解为方法添加重试功能：

@Service
public interface MyService {
    @Retryable(value = RuntimeException.class)
    void retryService(String sql);

}

在这里，当抛出RuntimeException时尝试重试。

根据@Retryable的默认行为，重试最多可能发生3次，重试之间有1秒的延迟。

4.2、@Retryable和@Recover

现在让我们使用@Recover注解添加一个恢复方法：

@Service
public interface MyService {
    @Retryable(value = SQLException.class)
    void retryServiceWithRecovery(String sql) throws SQLException;
        
    @Recover
    void recover(SQLException e, String sql);
}

这里，当抛出SQLException时重试会尝试运行。当@Retryable方法因指定异常而失败时，@Recover注解定义了一个单独的恢复方法。

因此，如果retryServiceWithRecovery方法在三次尝试之后还是抛出了SQLException，那么recover()方法将被调用。

恢复处理程序的第一个参数应该是Throwable类型（可选）和相同的返回类型。其余的参数按相同顺序从失败方法的参数列表中填充。

4.3、自定义@Retryable的行为

为了自定义重试的行为，我们可以使用参数maxAttempts和backoff：

@Service
public interface MyService {
    @Retryable( value = SQLException.class, 
      maxAttempts = 2, backoff = @Backoff(delay = 100))
    void retryServiceWithCustomization(String sql) throws SQLException;
}

这样最多将有两次尝试和100毫秒的延迟。

4.4、使用Spring Properties

我们还可以在@Retryable注解中使用properties。

为了演示这一点，我们将看到如何将delay和maxAttempts的值外部化到一个properties文件中。

首先，让我们在名为retryConfig.properties的文件中定义属性：

retry.maxAttempts=2
retry.maxDelay=100

然后我们指示@Configuration类加载这个文件：

@PropertySource("classpath:retryConfig.properties")
public class AppConfig { ... }
// ...

最后，我们可以在@Retryable的定义中注入retry.maxAttempts和retry.maxDelay的值：

@Service 
public interface MyService { 
  @Retryable( value = SQLException.class, maxAttemptsExpression = "${retry.maxAttempts}",
            backoff = @Backoff(delayExpression = "${retry.maxDelay}")) 
  void retryServiceWithExternalizedConfiguration(String sql) throws SQLException; 
}

请注意，我们现在使用的是maxAttemptsExpression和delayExpression而不是maxAttempts和delay。

5、RetryTemplate

5.1、RetryOperations

Spring Retry提供了RetryOperations接口，它提供了一组execute()方法：

public interface RetryOperations {
    <T> T execute(RetryCallback<T> retryCallback) throws Exception;

    ...
}

execute()方法的参数RetryCallback，是一个接口，可以插入需要在失败时重试的业务逻辑：

public interface RetryCallback<T> {
    T doWithRetry(RetryContext context) throws Throwable;
}

5.2、RetryTemplate配置

RetryTemplate是RetryOperations的一个实现。

让我们在@Configuration类中配置一个RetryTemplate的bean：

@Configuration
public class AppConfig {
    //...
    @Bean
    public RetryTemplate retryTemplate() {
        RetryTemplate retryTemplate = new RetryTemplate();
		
        FixedBackOffPolicy fixedBackOffPolicy = new FixedBackOffPolicy();
        fixedBackOffPolicy.setBackOffPeriod(2000l);
        retryTemplate.setBackOffPolicy(fixedBackOffPolicy);

        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
        retryPolicy.setMaxAttempts(2);
        retryTemplate.setRetryPolicy(retryPolicy);
		
        return retryTemplate;
    }
}

这个RetryPolicy确定了何时应该重试操作。

其中SimpleRetryPolicy定义了重试的固定次数，另一方面，BackOffPolicy用于控制重试尝试之间的回退。

最后，FixedBackOffPolicy会使重试在继续之前暂停一段固定的时间。

5.3、使用RetryTemplate

要使用重试处理来运行代码，我们可以调用retryTemplate.execute()方法：

retryTemplate.execute(new RetryCallback<Void, RuntimeException>() {
    @Override
    public Void doWithRetry(RetryContext arg0) {
        myService.templateRetryService();
        ...
    }
});

我们可以使用lambda表达式代替匿名类：

retryTemplate.execute(arg0 -> {
    myService.templateRetryService();
    return null;
});

6、监听器

监听器在重试时提供另外的回调。我们可以用这些来关注跨不同重试的各个横切点。

6.1、添加回调

回调在RetryListener接口中提供：

public class DefaultListenerSupport extends RetryListenerSupport {
    @Override
    public <T, E extends Throwable> void close(RetryContext context,
      RetryCallback<T, E> callback, Throwable throwable) {
        logger.info("onClose");
        ...
        super.close(context, callback, throwable);
    }

    @Override
    public <T, E extends Throwable> void onError(RetryContext context,
      RetryCallback<T, E> callback, Throwable throwable) {
        logger.info("onError"); 
        ...
        super.onError(context, callback, throwable);
    }

    @Override
    public <T, E extends Throwable> boolean open(RetryContext context,
      RetryCallback<T, E> callback) {
        logger.info("onOpen");
        ...
        return super.open(context, callback);
    }
}

open和close的回调在整个重试之前和之后执行，而onError应用于单个RetryCallback调用。

6.2、注册监听器

接下来，我们将我们的监听器（DefaultListenerSupport）注册到我们的RetryTemplate bean：

@Configuration
public class AppConfig {
    ...

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

7、测试结果

为了完成我们的示例，让我们验证一下结果：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(
  classes = AppConfig.class,
  loader = AnnotationConfigContextLoader.class)
public class SpringRetryIntegrationTest {

    @Autowired
    private MyService myService;

    @Autowired
    private RetryTemplate retryTemplate;

    @Test(expected = RuntimeException.class)
    public void givenTemplateRetryService_whenCallWithException_thenRetry() {
        retryTemplate.execute(arg0 -> {
            myService.templateRetryService();
            return null;
        });
    }
}

从测试日志中可以看出，我们已经正确配置了RetryTemplate和RetryListener：

2020-01-09 20:04:10 [main] INFO c.p.s.DefaultListenerSupport - onOpen
2020-01-09 20:04:10 [main] INFO c.pinmost.springretry.MyServiceImpl - throw RuntimeException in method templateRetryService()
2020-01-09 20:04:10 [main] INFO c.p.s.DefaultListenerSupport - onError
2020-01-09 20:04:12 [main] INFO c.pinmost.springretry.MyServiceImpl - throw RuntimeException in method templateRetryService()
2020-01-09 20:04:12 [main] INFO c.p.s.DefaultListenerSupport - onError
2020-01-09 20:04:12 [main] INFO c.p.s.DefaultListenerSupport - onClose

8、结论

在本文中，我们看到了如何使用注解、RetryTemplate和回调监听器来使用Spring Retry。

原文地址：https://www.baeldung.com/spring-retry

到此这篇关于Spring框架中一个有用的小组件：Spring Retry的文章就介绍到这了,更多相关Spring Spring Retry组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java读取其下所有文件夹与文件路径的方法
这篇文章主要为大家详细介绍了Java读取其下所有文件夹与文件路径的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-03-03
java中PriorityBlockingQueue的入队知识点总结
在本篇文章里小编给大家整理一篇关于java中PriorityBlockingQueue的入队知识点总结内容，有需要的朋友们可以学习下。
2021-01-01
关于Controller 层返回值的公共包装类的问题
本文给大家介绍Controller 层返回值的公共包装类-避免每次都包装一次返回-InitializingBean增强，本文通过实例代码给大家介绍的非常详细，需要的朋友参考下吧
2021-09-09
Java中this的用法实例总结
JAVA中的this是一个非常重要的模块,在编程中有非常重要的地位,擅长用this的人常常可以使程序更加简洁和方便,下面这篇文章主要给大家介绍了关于Java中this用法的相关资料,需要的朋友可以参考下
2022-08-08
java开发环境的完整搭建过程
这篇文章主要给大家介绍了关于java开发环境的完整搭建过程，文中介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-02-02
Spring事件监听基本原理与使用详解
这篇文章主要介绍了Spring事件监听基本原理与使用详解,Spring的事件监听机制和发布订阅机制是很相似的：发布了一个事件后,监听该类型事件的所有监听器会触发相应的处理逻辑,需要的朋友可以参考下
2024-01-01
Java使用lombok消除冗余代码的方法步骤
这篇文章主要介绍了Java使用lombok消除冗余代码的方法步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-11-11
Java 异常的知识整理
这篇文章主要介绍了Java 异常的知识整理的相关资料,需要的朋友可以参考下
2017-07-07
Java中ArrayList的removeAll方法详解
这篇文章主要给大家介绍了关于Java中ArrayList的removeAll方法的相关资料，文中通过示例代码介绍的非常详细，对大家具有一定的参考学习价值，需要的朋友们下面跟着小编一起来看看吧。
2017-07-07
解决Java导入excel大量数据出现内存溢出的问题
今天小编就为大家分享一篇解决Java导入excel大量数据出现内存溢出的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2018-06-06