一、前言

发送消息失败,调用远程服务失败,争抢锁失败,这些错误的原因可能是因为出现网络抖动、连接超时造成的,这时候就需要进行多次重试。一般如果我们自己实现重试机制,都是使用try/catch、while循环之类来进行处理,但是这样并不优雅。在SpringBoot中已经提供了实现重试机制的功能——@Retryable注解,可以在不侵入原有逻辑代码的方式下,优雅的实现重处理功能。

二、@Retryable是什么?

SpringBoot的spring-retry是另一个使用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。在spring-retry中,所有配置都是基于简单注释的。

三、使用步骤

        1.POM依赖

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

        2.启用@Retryable

@EnableRetry
@SpringBootApplication
public class HelloApplication {

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

}

         3.在方法上添加@Retryable

@Service
public class TestRetryServiceImpl implements TestRetryService {
 
    @Override
    @Retryable(value = Exception.class,maxAttempts = 3,
        backoff = @Backoff(delay = 2000,multiplier = 1.5))
    public int test(int code) throws Exception{
        System.out.println("test被调用,时间:"+LocalTime.now());
          if (code==0){
              throw new Exception("情况不对头!");
          }
        System.out.println("test被调用,情况对头了!");
 
        return 200;
    }
}

来解释以下注解中几个参数的含义:

value:抛出指定异常才会重试

include:和value一样,默认为空,当exclude也为空时,默认所有异常

exclude:指定不处理的异常

maxAttempts:最大重试次数,默认3次

backoff:重试等待策略,默认使用@Backoff,@Backoff的value默认为1000ms;delay为重试之间的等待时间(单位:ms);multiplier指定延迟的倍数

当重试耗尽时还是失败,会出现什么情况?

RetryOperations可以将控制传递给另一个回调,即Recovery Callback。Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数用完后,如果还没有成功,就抛异常。 

        4.@Recover

@Recover
public int recover(Exception e, int code){
   System.out.println("回调方法执行!!!!");
   //记日志到数据库 或者调用其余的方法
    return 400;
}

Exception e,这个是作为回调的街头暗号(重试次数用完了,还是失败,我们抛出这个Exception e通知触发这个回调方法。

对于@Recover注解的方法,需要特别注意的是:

@Retryable方法一致

@Retryable配置的异常一致,其他的参数,需要哪个写哪个就可以了

        3.该回调方法与重试方法写在同一个实现类里面

        5.注意事项

1) 由于是基于AOP实现,所以不支持类里面自调用方法

2) 如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void

3) 方法不能用try/catch

4) @Recover注解来开启重试失败后调用的方法(注意,需要跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。