spring-retry(1.概念和基本用法)


准备好好看看一下spring-cloud的源码,把其中实现的原理搞清楚,而不是仅仅会配几个注解,会配几个参数,把“微服务”框架搭建起来。在查看其中pom的的依赖关系时,发现spring-cloud对于spring不仅仅是bean,aop,context等,居然spring-cloud-commons依赖了一个spring-retry的东西。

官方定义:

This project provides declarative retry support for Spring applications. It is used in Spring Batch, Spring Integration, Spring for Apache Hadoop (amongst others).

该项目给spring应用提供了声明式的重试支持。它被使用在spring批处理,spring集成,Apache Hadoop集成pring几个项目中。

一、概念
spring对于重试机制的实现,给了几个抽象。

  1. BackOff:补偿值,一般指失败后多久进行重试的延迟值。
  2. Sleeper:暂停应用的工具,通常用来应用补偿值。
  3. BackOffPolicy:补偿策略,决定失败后如何确定补偿值。
  4. RetryContext:重试上下文,代表了能被重试动作使用的资源。
  5. RetryPolicy:重试策略,决定失败能否重试。
  6. RecoveryCallback:定义一个动作recover,在重试耗尽后的动作。
  7. RetryCallback:具体的重试动作。
  8. RetryOperations:通过传递RetryCallback,进行重试操作。
  9. RetryState:重试状态,通常包含一个重试的键值。
  10. RetryStatistics和RetryListener,用来监控Retry的执行情况,并生成统计信息。

二、声明式使用
官方给的代码如下:

@Configuration
@EnableRetry
public class Application {

    @Bean
    public Service service() {
        return new Service();
    }

}

@Service
class Service {
    @Retryable(RemoteAccessException.class)
    public void service() {
        // ... do something
    }
    @Recover
    public void recover(RemoteAccessException e) {
       // ... panic
    }
}

通过@EnableRetry就可以启用Retry功能了,需要被重试的方法加上@Retryable(),就能在指定的异常出现情况下重试,而当默认的失败次数到达后(查看SimpleRetryPolicy可知,就是试3次),就会调用@Recover注解的方法,进行恢复。
当然在@Retryable上,可以配置属性,更加细化
例如:@Retryable(value= {RemoteAccessException.class},maxAttempts = 5,backoff = @Backoff(delay = 5000l,multiplier = 1))
指定,重试5次,每次补偿(延迟5秒),每次倍数为1(不变)。

几个注解的参数解释

@EnableRetry能否重试。当proxyTargetClass属性为true时,使用CGLIB代理。默认使用标准JAVA注解。在spring Boot中此参数写在程序入口即可。
@Retryable 标注此注解的方法在发生异常时会进行重试

  • value:指定处理的异常类
  • include:指定处理的异常类和value一样,默认为空,当exclude也为空时,默认所有异常
  • exclude:指定异常不处理,默认空,当include也为空时,默认所有异常
  • maxAttempts:最大重试次数。默认3次
    -backoff: 重试补偿策略。默认使用@Backoff注解

@Backoff 重试补偿策略

  • 不设置参数时,默认使用FixedBackOffPolicy(指定等待时间),重试等待1000ms
  • 设置delay,使用FixedBackOffPolicy(指定等待- - 设置delay和maxDealy时,重试等待在这两个值之间均态分布
  • 设置delay、maxDealy、multiplier,使用 ExponentialBackOffPolicy(指数级重试间隔的实现 ),multiplier即指定延迟倍数,比如delay=5000l,multiplier=2,则第一次重试为5秒,第二次为10秒,第三次为20秒

@Recover 用于@Retryable重试失败后处理方法,此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。

三、核心API-RetryTemplate
声明式的使用,实际上是由spring-retry在内部生成了一个默认的RetryTemplate,由它封装我们自己写的函数完成的重试。这有点像@Scheduled,内部生成了一个ThreadPoolTaskExecutor完成定时任务的调度。虽然简单,但是可配置的东西太少了,如果想用spring-retry强大的策略机制,并必须定制化RetryTemplate。

官方的API使用demo如下:

RetryTemplate template = new RetryTemplate();

TimeoutRetryPolicy policy = new TimeoutRetryPolicy();
policy.setTimeout(30000L);

template.setRetryPolicy(policy);

Foo result = template.execute(new RetryCallback<Foo>() {

    public Foo doWithRetry(RetryContext context) {
        // Do stuff that might fail, e.g. webservice operation
        return result;
    }

});

可以看出,new出一个RetryTemplate对象后,可以给它设置重试策略、补偿策略、重试监听器等属性。核心是在template.execute(),传递一个RetryCallback,内部执行我们需要重试的具体方法。
RetryTemplate是标准spring的××Template风格(脑补jdbcTemplate),内部doExecute()方法实现了如何开启重试上下文,获取补偿上下文,在try/catch中执行doWithRetry(),出现异常捕捉下来,如何应用重试策略决定重试,最后如何应用回退方法,关闭上下文等。这些都模板化了,我们只需要要传入RetryCallback和RecoveryCallback(连这个也可省)。

参考:

推荐阅读更多精彩内容