SpringRetry踩坑记录

Retry简单介绍

  Retry是Spring提供的异常重试框架，只需要引入如下依赖即可安心食用。

       org.springframework.retry
       spring-retry

核心注解

   @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方法返回值需要与重试方法返回值保证一致

使用案例

SpringBoot启动类

@SpringBootApplication
//指明代理方式为CGLIB代理
@EnableRetry(proxyTargetClass = true)
public class RetrystudyApplication {
    public static void main(String[] args) {
        SpringApplication.run(RetrystudyApplication.class, args);
    }

}

业务类

package com.example.retrystudy.service;

import lombok.extern.slf4j.Slf4j;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

/**
 * @author hcq
 * @date 2019/6/30 21:56
 */
@Service
@Slf4j
public class RetryServiceImpl implements RetryService{

    @Override
    @Retryable(value = { RuntimeException.class },maxAttempts = 5,backoff = @Backoff(delay = 500,multiplier = 1))
    public String retry() {
        //代理对象调用原生对象
        log.info("进入业务方法："+this.getClass());
        throw  new RuntimeException("runtime");
        //return "success";
    }
    @Override
    @Recover
    public String recover(RuntimeException e) {
        log.error("handler recover:"+e.getMessage());
        return "fail";
    }
    @Override
    public String handlerRetry() {
      retry();
      return "success";
    }
}

 

踩坑记录   

   Retryable方法只有直接通过代理对象调用时才会生效，通过其他方法间接调用不生效（所有基于AOP的注解都一样）
   温馨提示：在Spring中，只有需要用到Aop代理的类才会生成代理对象，不需要Aop的直接返回原生对象

       一、基于JDK动态代理时，只代理接口中的方法，所以需要注意以下事项
                 @Retryable或者@Recover修饰的方法一定要在接口中声明
                 @Retryable可以修饰在接口的方法声明上，也可以修饰在方法实现上
                 @Recover注解只能修饰在接口的方法声明中（具体原因尚未分析）【Recover修饰在方法实现上时会提示: Cannot                           locate recovery method】

       二、基于CGLIB动态代理时，可以代理目标类所有可继承方法    
                 @Retryable或者@Recover修饰的方法必须可以被继承（不能用final，private修饰）
                 @Retryable与 @Recover直接修饰在方法实现上