SpringBoot中的7种重试机制

末蓝、 2024-03-22 23:20 55阅读 0赞

随着互联网的不断发展，项目中的业务功能变得越来越复杂。在实际开发过程中，我们经常会调用一些第三方接口或者公司内部的其他项目提供的服务来支撑业务需求。然而，远程服务的健壮性和网络稳定性往往是不可控的因素。尽管在测试阶段可能没有出现异常情况，但一旦系统上线，可能会遇到由于内部错误或者网络波动而导致调用接口出错或返回系统异常的情况。为了应对这些不稳定因素，我们必须考虑引入重试机制。

**重试机制是一种有效的策略，它可以提高系统的健壮性，并且减少因网络波动导致依赖服务临时不可用所带来的影响，从而使系统能够更加稳定地运行。**

### 1、手动重试 ###

手动重试：使用 while 循环语句进行重试：

@Service
    public class OrderServiceImpl implements OrderService {
        
    	public void addOrder() {
        
    	    int times = 1;
    	    while (times <= 5) {
        
    	        try {
        
    	            // 故意抛异常
    	            int i = 3 / 0;
    	            // addOrder
    	        } catch (Exception e) {
        
    	            System.out.println("重试" + times + "次");
    	            Thread.sleep(2000);
    	            times++;
    	            if (times > 5) {
        
    	                throw new RuntimeException("不再重试！");
    	            }
    	        }
    	    }
    	}
    }

代码运行结果：  
![在这里插入图片描述][4ce487f2bc4c41a2a7587d3507820ad9.png_pic_center]  
上述代码看上去可以解决重试问题，但实际上存在一些弊端：

1、由于没有重试间隔，很可能远程调用的服务还没有从网络异常中恢复，所以有可能接下来的几次调用都会失败。  
2、代码侵入式太高，调用方代码不够优雅。  
3、项目中远程调用的服务可能有很多，每个都去添加重试会出现大量的重复代码。

### 2、静态代理 ###

上面的处理方式由于需要对业务代码进行大量修改，虽然实现了功能，但是对原有代码的侵入性太强，可维护性差。所以需要使用一种更优雅一点的方式，不直接修改业务代码，那要怎么做呢？

其实很简单，直接在业务代码的外面再包一层就行了，代理模式在这里就有用武之地了。

@Service
    public class OrderServiceProxyImpl implements OrderService {
        
        
        @Autowired
        private OrderServiceImpl orderService;
    
        @Override
        public void addOrder() {
        
            int times = 1;
            while (times <= 5) {
        
                try {
        
                    // 故意抛异常
                    int i = 3 / 0;
                    orderService.addOrder();
                } catch (Exception e) {
        
                    System.out.println("重试" + times + "次");
                    try {
        
                        Thread.sleep(2000);
                    } catch (InterruptedException ex) {
        
                        ex.printStackTrace();
                    }
                    times++;
                    if (times > 5) {
        
                        throw new RuntimeException("不再重试！");
                    }
                }
            }
            
        }
    }

这样，重试逻辑就都由代理类来完成，原业务类的逻辑就不需要修改了，以后想修改重试逻辑也只需要修改这个类就行了。

代理模式虽然要更加优雅，**但是如果依赖的服务很多的时候，要为每个服务都创建一个代理类，显然过于麻烦，而且其实重试的逻辑都大同小异，无非就是重试的次数和延时不一样而已**。如果每个类都写这么一长串类似的代码，显然，不优雅！

### 3、JDK动态代理 ###

基于上述弊端，这时候，动态代理就闪亮登场了。只需要写一个代理处理类就 ok 了。

@Slf4j
    public class RetryInvocationHandler implements InvocationHandler {
        
     
        private final Object subject;
     
        public RetryInvocationHandler(Object subject) {
        
            this.subject = subject;
        }
     
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        
            int times = 0;
     
            while (times < RetryConstant.MAX_TIMES) {
        
                try {
        
                    return method.invoke(subject, args);
                } catch (Exception e) {
        
                    times++;
                    log.info("times:{},time:{}", times, LocalTime.now());
                    if (times >= RetryConstant.MAX_TIMES) {
        
                        throw new RuntimeException(e);
                    }
                }
     
                // 延时一秒
                try {
        
                    Thread.sleep(1000);
                } catch (InterruptedException e) {
        
                    e.printStackTrace();
                }
            }
     
            return null;
        }
     
        /**
         * 获取动态代理
         *
         * @param realSubject 代理对象
         */
        public static Object getProxy(Object realSubject) {
        
            InvocationHandler handler = new RetryInvocationHandler(realSubject);
            return Proxy.newProxyInstance(handler.getClass().getClassLoader(),
                    realSubject.getClass().getInterfaces(), handler);
        }
     
    }

测试：

@Test
    public void helloDynamicProxy() {
        
        IHelloService realService = new HelloService();
        IHelloService proxyService = (IHelloService)RetryInvocationHandler.getProxy(realService);
     
        String hello = proxyService.hello();
        log.info("hello:{}", hello);
    }

输出如下：
    hello times:1
    发生异常，time：11:22:20.727586700
    times:1,time:11:22:20.728083
    hello times:2
    发生异常，time：11:22:21.728858700
    times:2,time:11:22:21.729343700
    hello times:3
    发生异常，time：11:22:22.729706600
    times:3,time:11:22:22.729706600
    hello times:4
    hello:hello

在重试了4次之后输出了Hello，符合预期。

动态代理可以将重试逻辑都放到一块，显然比直接使用代理类要方便很多，也更加优雅。

不过不要高兴的太早，这里因为被代理的HelloService是一个简单的类，没有依赖其它类，所以直接创建是没有问题的，但如果被代理的类依赖了其它被Spring容器管理的类，则这种方式会抛出异常，因为没有把被依赖的实例注入到创建的代理实例中。

这种情况下，就比较复杂了，需要从Spring容器中获取已经装配好的，需要被代理的实例，然后为其创建代理类实例，并交给Spring容器来管理，这样就不用每次都重新创建新的代理类实例了。

新建一个工具类，用来获取代理实例：

@Component
    public class RetryProxyHandler {
        
     
        @Autowired
        private ConfigurableApplicationContext context;
     
        public Object getProxy(Class clazz) {
        
            // 1. 从Bean中获取对象
            DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory)context.getAutowireCapableBeanFactory();
            Map<String, Object> beans = beanFactory.getBeansOfType(clazz);
            Set<Map.Entry<String, Object>> entries = beans.entrySet();
            if (entries.size() <= 0){
        
                throw new ProxyBeanNotFoundException();
            }
            // 如果有多个候选bean, 判断其中是否有代理bean
            Object bean = null;
            if (entries.size() > 1){
        
                for (Map.Entry<String, Object> entry : entries) {
        
                    if (entry.getKey().contains(PROXY_BEAN_SUFFIX)){
        
                        bean = entry.getValue();
                    }
                };
                if (bean != null){
        
                    return bean;
                }
                throw new ProxyBeanNotSingleException();
            }
     
            Object source = beans.entrySet().iterator().next().getValue();
            Object source = beans.entrySet().iterator().next().getValue();
     
            // 2. 判断该对象的代理对象是否存在
            String proxyBeanName = clazz.getSimpleName() + PROXY_BEAN_SUFFIX;
            Boolean exist = beanFactory.containsBean(proxyBeanName);
            if (exist) {
        
                bean = beanFactory.getBean(proxyBeanName);
                return bean;
            }
     
            // 3. 不存在则生成代理对象
            bean = RetryInvocationHandler.getProxy(source);
     
            // 4. 将bean注入spring容器
            beanFactory.registerSingleton(proxyBeanName, bean);
            return bean;
        }
    }

使用的是JDK动态代理：

@Slf4j
    public class RetryInvocationHandler implements InvocationHandler {
        
     
        private final Object subject;
     
        public RetryInvocationHandler(Object subject) {
        
            this.subject = subject;
        }
     
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        
            int times = 0;
     
            while (times < RetryConstant.MAX_TIMES) {
        
                try {
        
                    return method.invoke(subject, args);
                } catch (Exception e) {
        
                    times++;
                    log.info("retry times:{},time:{}", times, LocalTime.now());
                    if (times >= RetryConstant.MAX_TIMES) {
        
                        throw new RuntimeException(e);
                    }
                }
     
                // 延时一秒
                try {
        
                    Thread.sleep(1000);
                } catch (InterruptedException e) {
        
                    e.printStackTrace();
                }
            }
     
            return null;
        }
     
        /**
         * 获取动态代理
         *
         * @param realSubject 代理对象
         */
        public static Object getProxy(Object realSubject) {
        
            InvocationHandler handler = new RetryInvocationHandler(realSubject);
            return Proxy.newProxyInstance(handler.getClass().getClassLoader(),
                    realSubject.getClass().getInterfaces(), handler);
        }
     
    }

至此，主要代码就完成了，修改一下HelloService类，增加一个依赖：

@Slf4j
    @Component
    public class HelloService implements IHelloService{
        
     
        private static AtomicLong helloTimes = new AtomicLong();
     
        @Autowired
        private NameService nameService;
     
        public String hello(){
        
            long times = helloTimes.incrementAndGet();
            log.info("hello times:{}", times);
            if (times % 4 != 0){
        
                log.warn("发生异常，time：{}", LocalTime.now() );
                throw new HelloRetryException("发生Hello异常");
            }
            return "hello " + nameService.getName();
        }
    }

NameService其实很简单，创建的目的仅在于测试依赖注入的Bean能否正常运行:

@Service
    public class NameService {
        
     
        public String getName(){
        
            return "Frank";
        }
    }

测试：

@Test
    public void helloJdkProxy() throws InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException {
        
        IHelloService proxy = (IHelloService) retryProxyHandler.getProxy(HelloService.class);
        String hello = proxy.hello();
        log.info("hello:{}", hello);
    }

hello times:1
    发生异常，time：14:40:27.540672200
    retry times:1,time:14:40:27.541167400
    hello times:2
    发生异常，time：14:40:28.541584600
    retry times:2,time:14:40:28.542033500
    hello times:3
    发生异常，time：14:40:29.542161500
    retry times:3,time:14:40:29.542161500
    hello times:4
    hello:hello Frank

完美，这样就不用担心依赖注入的问题了，因为从Spring容器中拿到的Bean对象都是已经注入配置好的。当然，这里仅考虑了单例Bean的情况，可以考虑的更加完善一点，判断一下容器中Bean的类型是Singleton还是Prototype，如果是Singleton则像上面这样进行操作，如果是Prototype则每次都新建代理类对象。

另外，**这里使用的是JDK动态代理，因此就存在一个天然的缺陷，如果想要被代理的类，没有实现任何接口，那么就无法为其创建代理对象，这种方式就行不通了**。

### 4、CGLib动态代理 ###

既然已经说到了JDK动态代理，那就不得不提CGLib动态代理了。使用JDK动态代理对被代理的类有要求，不是所有的类都能被代理，而CGLib动态代理则刚好解决了这个问题。

创建一个CGLib动态代理类：

@Slf4j
    public class CGLibRetryProxyHandler implements MethodInterceptor {
        
        private Object target;//需要代理的目标对象
     
        //重写拦截方法
        @Override
        public Object intercept(Object obj, Method method, Object[] arr, MethodProxy proxy) throws Throwable {
        
            int times = 0;
     
            while (times < RetryConstant.MAX_TIMES) {
        
                try {
        
                    return method.invoke(target, arr);
                } catch (Exception e) {
        
                    times++;
                    log.info("cglib retry :{},time:{}", times, LocalTime.now());
                    if (times >= RetryConstant.MAX_TIMES) {
        
                        throw new RuntimeException(e);
                    }
                }
     
                // 延时一秒
                try {
        
                    Thread.sleep(1000);
                } catch (InterruptedException e) {
        
                    e.printStackTrace();
                }
            }
            return null;
        }
        //定义获取代理对象方法
        public Object getCglibProxy(Object objectTarget){
        
            this.target = objectTarget;
            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(objectTarget.getClass());
            enhancer.setCallback(this);
            Object result = enhancer.create();
            return result;
        }
    }

想要换用CGLib动态代理，替换一下这两行代码即可：

// 3. 不存在则生成代理对象
    //        bean = RetryInvocationHandler.getProxy(source);
    CGLibRetryProxyHandler proxyHandler = new CGLibRetryProxyHandler();
    bean = proxyHandler.getCglibProxy(source);

测试：

@Test
    public void helloCGLibProxy() {
        
        IHelloService proxy = (IHelloService) retryProxyHandler.getProxy(HelloService.class);
        String hello = proxy.hello();
        log.info("hello:{}", hello);
     
        hello = proxy.hello();
        log.info("hello:{}", hello);
    }

hello times:1
    发生异常，time：15:06:00.799679100
    cglib retry :1,time:15:06:00.800175400
    hello times:2
    发生异常，time：15:06:01.800848600
    cglib retry :2,time:15:06:01.801343100
    hello times:3
    发生异常，time：15:06:02.802180
    cglib retry :3,time:15:06:02.802180
    hello times:4
    hello:hello Frank
    hello times:5
    发生异常，time：15:06:03.803933800
    cglib retry :1,time:15:06:03.803933800
    hello times:6
    发生异常，time：15:06:04.804945400
    cglib retry :2,time:15:06:04.805442
    hello times:7
    发生异常，time：15:06:05.806886500
    cglib retry :3,time:15:06:05.807881300
    hello times:8
    hello:hello Frank

这样就很棒了，完美的解决了JDK动态代理带来的缺陷。优雅指数上涨了不少。

但这个方案仍旧存在一个问题，那就是需要对原来的逻辑进行侵入式修改，在每个被代理实例被调用的地方都需要进行调整，这样仍然会对原有代码带来较多修改。

### 5、手动AOP ###

想要无侵入式的修改原有逻辑？想要一个注解就实现重试？用Spring AOP不就能完美实现吗？使用AOP来为目标调用设置切面，即可在目标方法调用前后添加一些额外的逻辑。

自定义注解：

@Documented
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyRetryable {
        
        
        // 最大重试次数
        int retryTimes() default 3;
        // 重试间隔
        int retryInterval() default 1;
    
    }

然后在需要重试的方法上加上注解：

@Retryable(retryTimes = 4, retryInterval = 2)
    public String hello(){
        
        long times = helloTimes.incrementAndGet();
        log.info("hello times:{}", times);
        if (times % 4 != 0){
        
            log.warn("发生异常，time：{}", LocalTime.now() );
            throw new HelloRetryException("发生Hello异常");
        }
        return "hello " + nameService.getName();
    }

接着，进行最后一步，编写AOP切面：

@Slf4j
    @Aspect
    @Component
    public class RetryAspect {
        
     
        @Pointcut("@annotation(com.mfrank.springboot.retry.demo.annotation.Retryable)")
        private void retryMethodCall(){
        }
     
        @Around("retryMethodCall()")
        public Object retry(ProceedingJoinPoint joinPoint) throws InterruptedException {
        
            // 获取重试次数和重试间隔
            Retryable retry = ((MethodSignature)joinPoint.getSignature()).getMethod().getAnnotation(Retryable.class);
            int maxRetryTimes = retry.retryTimes();
            int retryInterval = retry.retryInterval();
     
            Throwable error = new RuntimeException();
            for (int retryTimes = 1; retryTimes <= maxRetryTimes; retryTimes++){
        
                try {
        
                    Object result = joinPoint.proceed();
                    return result;
                } catch (Throwable throwable) {
        
                    error = throwable;
                    log.warn("调用发生异常，开始重试，retryTimes:{}", retryTimes);
                }
                Thread.sleep(retryInterval * 1000);
            }
            throw new RetryExhaustedException("重试次数耗尽", error);
        }
    }

测试：

@Autowired
    private HelloService helloService;
     
    @Test
    public void helloAOP(){
        
        String hello = helloService.hello();
        log.info("hello:{}", hello);
    }

hello times:1
    发生异常，time：16:49:30.224649800
    调用发生异常，开始重试，retryTimes:1
    hello times:2
    发生异常，time：16:49:32.225230800
    调用发生异常，开始重试，retryTimes:2
    hello times:3
    发生异常，time：16:49:34.225968900
    调用发生异常，开始重试，retryTimes:3
    hello times:4
    hello:hello Frank

这样即不用编写重复代码，实现上也比较优雅了：一个注解就实现重试。

### 6、Spring 的重试注解 ###

实际上Spring中就有比较完善的重试机制，比上面的切面更加好用，还不需要自己动手重新造轮子。

那让我们先来看看这个轮子究竟好不好使。  
先引入重试所需的jar包：

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

然后在启动类或者配置类上添加@EnableRetry注解，接下来在需要重试的方法上添加@Retryable注解（嗯？好像跟我自定义的注解一样？）

@Retryable
    public String hello(){
        
        long times = helloTimes.incrementAndGet();
        log.info("hello times:{}", times);
        if (times % 4 != 0){
        
            log.warn("发生异常，time：{}", LocalTime.now() );
            throw new HelloRetryException("发生Hello异常");
        }
        return "hello " + nameService.getName();
    }

默认情况下，会重试三次，重试间隔为1秒。当然我们也可以自定义重试次数和间隔。这样就跟我前面实现的功能是一毛一样的了。

但Spring里的重试机制还支持很多很有用的特性；  
比如说，可以指定只对特定类型的异常进行重试，这样如果抛出的是其它类型的异常则不会进行重试，就可以对重试进行更细粒度的控制。默认为空，会对所有异常都重试。

@Retryable{
        value = {
        HelloRetryException.class}}
    public String hello(){
        
        ...
    }

该方法调用将会在抛出**HelloRetryException**异常后进行重试，最大重试次数为5，第一次重试间隔为1s，之后以2倍大小进行递增，第二次重试间隔为2s，第三次为4s，第四次为8s。

重试机制还支持使用@Recover注解来进行善后工作，当重试达到指定次数之后，将会调用该方法，可以在该方法中进行日志记录等操作。

这里值得注意的是，想要@Recover注解生效的话，需要跟被@Retryable标记的方法在同一个类中，且被@Retryable标记的方法不能有返回值，否则不会生效。

并且如果使用了@Recover注解的话，重试次数达到最大次数后，如果在@Recover标记的方法中无异常抛出，是不会抛出原异常的。

@Recover
    public boolean recover(Exception e) {
        
        log.error("达到最大重试次数",e);
        return false;
    }

除了使用注解外，Spring Retry 也支持直接在调用时使用代码进行重试：

@Test
    public void normalSpringRetry() {
        
        // 表示哪些异常需要重试,key表示异常的字节码,value为true表示需要重试
        Map<Class<? extends Throwable>, Boolean> exceptionMap = new HashMap<>();
        exceptionMap.put(HelloRetryException.class, true);
     
        // 构建重试模板实例
        RetryTemplate retryTemplate = new RetryTemplate();
     
        // 设置重试回退操作策略，主要设置重试间隔时间
        FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
        long fixedPeriodTime = 1000L;
        backOffPolicy.setBackOffPeriod(fixedPeriodTime);
     
        // 设置重试策略，主要设置重试次数
        int maxRetryTimes = 3;
        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy(maxRetryTimes, exceptionMap);
     
        retryTemplate.setRetryPolicy(retryPolicy);
        retryTemplate.setBackOffPolicy(backOffPolicy);
     
        Boolean execute = retryTemplate.execute(
            //RetryCallback
            retryContext -> {
        
                String hello = helloService.hello();
                log.info("调用的结果:{}", hello);
                return true;
            },
            // RecoverCallBack
            retryContext -> {
        
                //RecoveryCallback
                log.info("已达到最大重试次数");
                return false;
            }
        );
    }

此时唯一的好处是可以设置多种重试策略：

NeverRetryPolicy：只允许调用RetryCallback一次，不允许重试
     
    AlwaysRetryPolicy：允许无限重试，直到成功，此方式逻辑不当会导致死循环
     
    SimpleRetryPolicy：固定次数重试策略，默认重试最大次数为3次，RetryTemplate默认使用的策略
     
    TimeoutRetryPolicy：超时时间重试策略，默认超时时间为1秒，在指定的超时时间内允许重试
     
    ExceptionClassifierRetryPolicy：设置不同异常的重试策略，类似组合重试策略，区别在于这里只区分不同异常的重试
     
    CircuitBreakerRetryPolicy：有熔断功能的重试策略，需设置3个参数openTimeout、resetTimeout和delegate
     
    CompositeRetryPolicy：组合重试策略，有两种组合方式，乐观组合重试策略是指只要有一个策略允许即可以重试，
    悲观组合重试策略是指只要有一个策略不允许即可以重试，但不管哪种组合方式，组合中的每一个策略都会执行

可以看出，Spring中的重试机制还是相当完善的，比上面自己写的AOP切面功能更加强大。

这里还需要再提醒的一点是，由于Spring Retry用到了Aspect增强，所以就会有使用Aspect不可避免的坑——**方法内部调用，如果被 @Retryable 注解的方法的调用方和被调用方处于同一个类中，那么重试将会失效。**

但也还是存在一定的不足，Spring的重试机制只支持对异常进行捕获，而无法对返回值进行校验。

### 7. guava-retry ###

和 Spring Retry 相比，Guava Retry 具有更强的灵活性，并且能够根据 返回值 来判断是否需要重试。

<dependency>
        <groupId>com.github.rholder</groupId>
        <artifactId>guava-retrying</artifactId>
        <version>2.0.0</version>
    </dependency>

@Override
    public String guavaRetry(Integer num) {
        
        Retryer<String> retryer = RetryerBuilder.<String>newBuilder()
                //无论出现什么异常，都进行重试
                .retryIfException()
                //返回结果为 error时，进行重试
                .retryIfResult(result -> Objects.equals(result, "error"))
                //重试等待策略：等待 2s 后再进行重试
                .withWaitStrategy(WaitStrategies.fixedWait(2, TimeUnit.SECONDS))
                //重试停止策略：重试达到 3 次
                .withStopStrategy(StopStrategies.stopAfterAttempt(3))
                .withRetryListener(new RetryListener() {
        
                    @Override
                    public <V> void onRetry(Attempt<V> attempt) {
        
                        System.out.println("RetryListener: 第" + attempt.getAttemptNumber() + "次调用");
                    }
                })
                .build();
        try {
        
            retryer.call(() -> testGuavaRetry(num));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
        return "test";
    }

先创建一个Retryer实例，然后使用这个实例对需要重试的方法进行调用，可以通过很多方法来设置重试机制：

**retryIfException()**：对所有异常进行重试  
**retryIfRuntimeException()**：设置对指定异常进行重试  
**retryIfExceptionOfType()**：对所有 RuntimeException 进行重试  
**retryIfResult()**：对不符合预期的返回结果进行重试  
还有五个以 withXxx 开头的方法，用来对重试策略/等待策略/阻塞策略/单次任务执行时间限制/自定义监听器进行设置，以实现更加强大的异常处理：

**withRetryListener()**：设置重试监听器，用来执行额外的处理工作  
**withWaitStrategy()**：重试等待策略  
**withStopStrategy()**：停止重试策略  
**withAttemptTimeLimiter**：设置任务单次执行的时间限制，如果超时则抛出异常  
**withBlockStrategy()**：设置任务阻塞策略，即可以设置当前重试完成，下次重试开始前的这段时间做什么事情。

### 总结 ###

从手动重试，到使用 Spring AOP 自己动手实现，再到站在巨人肩上使用特别优秀的开源实现 Spring Retry 和 Google guava-retrying，经过对各种重试实现方式的介绍，可以看到以上几种方式基本上已经满足大部分场景的需要：

如果是基于 Spring 的项目，使用 Spring Retry 的注解方式已经可以解决大部分问题  
如果项目没有使用 Spring 相关框架，则适合使用 Google guava-retrying：自成体系，使用起来更加灵活强大。

[4ce487f2bc4c41a2a7587d3507820ad9.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/6b855658d8664e159b39d66095002d84.png