spring boot 最佳实践（七）-- spring-retry

实际工作中由于网络波动等原因导致代码执行失败需要重新执行,保证最终能够完成业务功能。通常来说,会用try/catch,while循环或者定时任务重处理。但是这样的做法缺乏统一性,要多写很多代码。spring-retry组件可以通过注解优雅的实现重处理功能。

实战spring-retry

###1.pom引用

<dependency>
  <groupId>org.springframework.retrygroupId>
  <artifactId>spring-retryartifactId>
dependency>

###2.应用启动类开启retry

@EnableRetry
public class Application {
    .......
}

###3.在指定方法上标记@Retryable来开启重试

@Retryable(value={A异常.class,B异常.class},
     maxAttempts=重试次数,
     backoff = @Backoff(delay = 延迟毫秒数,multiplier = 延迟倍数))
public void retryTest() throws Exception {
    System.out.println(Thread.currentThread().getName()+" do something...");
    throw new RemoteAccessException("RemoteAccessException....");
}

###4.在指定方法上标记@Recover来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)

  @Recover
  public void recover(A异常 e) {
    // ... do something
  }
  
  @Recover
  public void recover(B异常 e) {
    // ... do something
  }

使用详解

spring-retry通过AOP实现对目的方法的封装，执行在当前线程下，所以重试过程中当前线程会堵塞。如果BackOff时间设置比较长，最好起异步线程重试（也可以加@Async注解）。

@Retryable注解

被注解的方法发生异常时会重试

• value:指定发生的异常进行重试
• include:和value一样，默认空，当exclude也为空时，所有异常都重试
• exclude:指定异常不重试，默认空，当include也为空时，所有异常都重试
• maxAttemps:重试次数，默认3
• backoff:重试补偿机制，默认没有

@Backoff注解

• delay:指定延迟后重试
• multiplier:指定延迟的倍数，比如delay=5000l,multiplier=2时，第一次重试为5秒后，第二次为10秒，第三次为20秒

@Recover

• 当重试到达指定次数时，被注解的方法将被回调，可以在该方法中进行日志处理。需要注意的是发生的异常和入参类型一致时才会回调

本文参考

1. Spring重试支持Spring Retry
2. 最佳实践】如何优雅的进行重试