在项目中,调用第三方接口响应比较慢,或者由于网络抖动等原因,导致无响应或响应超时的情况,就要用到重试机制。比较简单成熟的方案就是使用spring-retry功能,spring-retry需要使用aop的特性,所以需要引入aspectj

1. 添加依赖

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

2. 核心注解有3个: @EnableRetry,@Retryable 和 @Recover

@EnableRetry:此注解用于开启重试框架,可以修饰在SpringBoot启动类上面,也可以修饰在需要重试的类上
   proxyTargetClass:Boolean类型,用于指明代理方式【true:cglib代理,false:jdk动态代理】默认使用jdk动态代理
@Retryable
   value:Class[]类型,用于指定需要重试的异常类型,
   include:Class[]类型,作用于value类似,区别尚未分析
   exclude:Class[]类型,指定不需要重试的异常类型
   maxAttemps:int类型,指定最多重试次数,默认3
   backoff:Backoff类型,指明补偿机制
   @BackOff
      delay:指定延迟后重试,默认为1000L,即1s后开始重试 ;
      multiplier:指定延迟的倍数
@Recover
   当重试次数耗尽依然出现异常时,执行此异常对应的@Recover方法。
   异常类型需要与Recover方法参数类型保持一致,
   recover方法返回值需要与重试方法返回值保证一致

3. 使用步骤

① SpringBoot启动类上增加@EnableRetry注解

@SpringBootApplication
@EnableRetry
public class DemoApplication {

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

}

② 接口

@RestController
public class RetryController {

    @Autowired
    RetryService retryService;

    @GetMapping("/retry")
    public String retry (@RequestParam("num") final int num) throws Exception {
        return retryService.doRetry(num);
    }

}

③ 在需要重试的接口上添加@Retryable注解

添加重试注解,当有异常时触发重试机制,设置重试4次,默认是3.延时2000ms再次执行,每次延时是上次延时的1.5倍.当返回结果不符合要求时,主动报错触发重试.

@Retryable(value = Exception.class, maxAttempts = 4, backoff = @Backoff(delay = 2000, multiplier = 1.5))
public String doRetry (int num) throws Exception {
    System.err.println("doRetry开始执行" + LocalDateTime.now());
    if (num <= 0) {
        throw new Exception("异常了");
    }
    return "输入的数值是:" + num;
}

④ 增加重试依然失败后回调的方法上加@Recover注解,如果不写,将正常的抛出异常

@Recover
public String recover (Exception e) {
    return "num必须大于0";
}

SpringBatch retry skip 执行顺序_异常类型

SpringBatch retry skip 执行顺序_异常类型_02

采坑记录:

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方法

解决方案就这这两句话:

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

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