SpringBoot——异常重试Spring-Retry

前言

spring retry是从spring batch独立出来的一个能功能，主要实现了重试和熔断。对于重试是有场景限制的，不是什么场景都适合重试，比如参数校验不合法、写操作等（要考虑写是否幂等）都不适合重试。远程调用超时、网络突然中断可以重试。在微服务治理框架中，通常都有自己的重试与超时配置，比如dubbo可以设置retries=1，timeout=500调用失败只重试1次，超过500ms调用仍未返回则调用失败。在spring retry中可以指定需要重试的异常类型，并设置每次重试的间隔以及如果重试失败是继续重试还是熔断（停止重试）。

 

Spring Retry支持集成到Spring或者Spring Boot项目中，而它支持AOP的切面注入写法，所以在引入时必须引入aspectjweaver.jar包。

核心注解

核心注解3个: @EnableRetry、@Retryable 和 @Recover

@EnableRetry

• 此注解用于开启重试框架，可以修饰在SpringBoot启动类上面，也可以修饰在需要重试的类上
• proxyTargetClass：Boolean类型，用于指明代理方式【true：cglib代理，false：jdk动态代理】默认使用jdk动态代理

@Retryable注解

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

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

@Backoff注解

• delay：指定延迟后重试，默认为1000L，即1s后开始重试。
• multiplier：指定延迟的倍数，比如delay=5000L，multiplier=2时，第一次重试为5秒后，第二次为10秒，第三次为20秒

@Recover

• 当重试次数耗尽依然出现异常时，执行此异常对应的@Recover方法。
• 异常类型需要与Recover方法参数类型保持一致。
• recover方法返回值需要与重试方法返回值保证一致。

下面是基于Spring Boot项目的集成步骤：

1、引入maven依赖

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

2、service

@Service @Slf4j public class RemoteService { /** * 添加重试注解,当有异常时触发重试机制.设置重试5次,默认是3.延时2000ms再次执行,每次延时提高1.5倍.当返回结果不符合要求时,主动报错触发重试. * @param count * @return * @throws Exception */ @Retryable(value = {RemoteAccessException.class }, maxAttempts = 5, backoff = @Backoff(delay = 2000, multiplier = 1.5)) public String call(Integer count) throws Exception { if(count == 10){ log.info("Remote RPC call do something... {}",LocalTime.now()); throw new RemoteAccessException("RPC调用异常"); } return "SUCCESS"; } /** * 定义回调,注意异常类型和方法返回值类型要与重试方法一致 * @param e * @return */ @Recover public String recover(RemoteAccessException e) { log.info("Remote RPC Call fail",e); return "recover SUCCESS"; } }

3、Controller

@RestController @RequestMapping("/retry") @Slf4j public class RetryController { @Autowired private RemoteService remoteService; @RequestMapping("/show/{count}") public String show(@PathVariable Integer count){ try { return remoteService.call(count); } catch (Exception e) { log.error("RetryController.show Exception",e); return "Hello SUCCESS"; } } }

4、springboot开启重试

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

效果

采坑记录:

1、retry重试机制无效

由于retry用到了aspect增强，所有会有aspect的坑，就是方法内部调用，会使aspect增强失效，那么retry当然也会失效。

public class demo { public void A() { B(); } @Retryable(Exception.class) public void B() { throw new RuntimeException("retry..."); } }

这种情况B()不会重试。

2、recover回调报错

org.springframework.retry.ExhaustedRetryException: Cannot locate recovery method 报错显示找不到recovery方法

解决方案就这这两句话:

• 1、异常类型需要与Recover方法参数类型保持一致
• 2、recover方法返回值需要与重试方法返回值保证一致

异常类型和返回值要一致!

 

参考： https://www.cnblogs.com/EasonJim/p/7684649.html

https://www.cnblogs.com/linyufeng/p/13361188.html