Spring异常重试框架Spring Retry

在调用第三方接口或者使用mq时，会出现网络抖动，连接超时等网络异常，所以需要重试。为了使处理更加健壮并且不太容易出现故障，后续的尝试操作，有时候会帮助失败的操作最后执行成功。例如，由于网络故障或数据库更新中的DeadLockLoserException导致Web服务或RMI服务的远程调用可能会在短暂等待后自行解决。为了自动执行这些操作的重试，Spring Batch具有RetryOperations策略。不过该重试功能从Spring Batch 2.2.0版本中独立出来，变成了Spring Retry模块。

快速集成的代码样例：

@Configuration
@EnableRetry
public class Application {@Beanpublic Service service() {return new Service();}}@Service
class Service {@Retryable(RemoteAccessException.class)public service() {// ... do something}
}

引入依赖

    <dependency><groupId>org.springframework.retry</groupId><artifactId>spring-retry</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.aspectj</groupId><artifactId>aspectjweaver</artifactId></dependency>

需要引入Spring-retry和aspectjweaver的依赖。

入口类


@SpringBootApplication
@EnableRetry
public class SpringbootRetryApplication {public static void main(String[] args) {SpringApplication.run(SpringbootRetryApplication.class, args);}
}

入口类上开启retry的拦截，使用@EnableRetry注解。

Service

@Service
public class PayService {private Logger logger = LoggerFactory.getLogger(getClass());private final int totalNum = 100000;@Retryable(value = Exception.class, maxAttempts = 3, backoff = @Backoff(delay = 2000L, multiplier = 1.5))public int minGoodsnum(int num) throws Exception {logger.info("减库存开始" + LocalTime.now());try {int i = 1 / 0;} catch (Exception e) {logger.error("illegal");}if (num <= 0) {throw new IllegalArgumentException("数量不对");}logger.info("减库存执行结束" + LocalTime.now());return totalNum - num;}
}

@Retryable注解

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

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

@Backoff注解

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

@Recover

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

测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootRetryApplicationTests {@Autowiredprivate PayService payService;@Testpublic void payTest() throws Exception {int store = payService.minGoodsnum(-1);System.out.println("库存为：" + store);}}

运行的控制台结果如下：

可以看到，三次之后抛出了IllegalArgumentException异常。

当重试耗尽时，RetryOperations可以将控制传递给另一个回调，即RecoveryCallback。Spring-Retry还提供了@Recover注解，用于@Retryable重试失败后处理方法，此方法里的异常一定要是@Retryable方法里抛出的异常，否则不会调用这个方法。

@Recover
public int recover(Exception e) {logger.warn("减库存失败！！！" + LocalTime.now());return totalNum;
}

在Service中，加上如上的方法之后，进行测试。

可以看到当三次重试执行完之后，会调用Recovery方法，也不会再次抛出异常。

说明：

1、使用了@Retryable的方法不能在本类被调用，不然重试机制不会生效。也就是要标记为@Service，然后在其它类使用@Autowired注入或者@Bean去实例才能生效。

2、要触发@Recover方法，那么在@Retryable方法上不能有返回值，只能是void才能生效。

3、使用了@Retryable的方法里面不能使用try...catch包裹，要在发放上抛出异常，不然不会触发。

4、在重试期间这个方法是同步的，如果使用类似Spring Cloud这种框架的熔断机制时，可以结合重试机制来重试后返回结果。

5、Spring Retry不只能注入方式去实现，还可以通过API的方式实现，类似熔断处理的机制就基于API方式实现会比较宽松。

总结

本文主要讲了在Spring Boot项目中的Spring-Retry简单应用，主要是基于注解配置一些重试的策略，使用比较简单。主要的适用场景为在调用第三方接口或者使用mq时。由于会出现网络抖动，连接超时等网络异常，这时就需要重试。

本文的代码： https://github.com/keets2012/Spring-Cloud_Samples/tree/master/springboot-retry

参考：

https://www.cnblogs.com/EasonJim/p/7684649.html

https://www.jianshu.com/p/cc7abf831900