利用Spring-Retry提高请求可靠性

一、问题背景

在我们项目中碰到调用第三方组件偶发性失败的问题，所以引入Spring-Retry进行重试。

二、Spring-Retry的使用方法

1.概述

Spring Retry 为 Spring 应用程序提供了声明性重试支持。它用于Spring批处理、Spring集成、Apache Hadoop(等等)。它主要是针对可能抛出异常的一些调用操作，进行有策略的重试。

2.使用步骤

在POM文件中增加Spring-Retry依赖

        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
<!--            <version>1.2.2.RELEASE</version>-->
        </dependency>

准备一个需要执行的任务

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomUtils;
import org.springframework.remoting.RemoteAccessException;

@Slf4j
public class RetryDemoTask {


    /**
     * 重试方法
     * @return
     */
    public static boolean retryTask(String param)  {
        log.info("收到了请求参数为：{}", param);
        int randomInt = RandomUtils.nextInt(0, 11);
        log.info("生成的随机数为：{}", randomInt);

        if (randomInt < 2) {
            log.info("创建虚拟机失败");
            throw new RemoteAccessException("创建虚拟机失败");
        } else {
            log.info("创建虚拟机成功");
            return true;
        }
    }

}

使用SpringRetryTemplate

import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import org.springframework.remoting.RemoteAccessException;
import org.springframework.retry.backoff.FixedBackOffPolicy;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.support.RetryTemplate;
import java.util.HashMap;
import java.util.Map;

@Slf4j
public class SpringRetryTemplateTest {

    /**
     * 重试间隔时间2000ms
     * */
    private long fixedPeriodTime = 2000L;
    /**
     * 最大重试次数5次
     */
    private int maxRetryTimes = 5;
    /**
     * 表示哪些异常需要重试,key表示异常的字节码,value为true表示需要重试
     */
    private Map<Class<? extends Throwable>, Boolean> exceptionMap = new HashMap<>();


    @Test
    public void test() {
        exceptionMap.put(RemoteAccessException.class,true);

        // 构建重试模板实例
        RetryTemplate retryTemplate = new RetryTemplate();

        // 设置重试回退操作策略，主要设置重试间隔时间
        FixedBackOffPolicy backOffPolicy = new FixedBackOffPolicy();
        backOffPolicy.setBackOffPeriod(fixedPeriodTime);

        // 设置重试策略，主要设置重试次数
        SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy(maxRetryTimes, exceptionMap);

        retryTemplate.setRetryPolicy(retryPolicy);
        retryTemplate.setBackOffPolicy(backOffPolicy);

        Boolean execute = retryTemplate.execute(
                //RetryCallback
                retryContext -> {
                    boolean b = RetryDemoTask.retryTask("vmInfo");
                    log.info("调用的结果:{}", b);
                    return b;
                },
                retryContext -> {
                    //RecoveryCallback
                    log.info("已达到最大重试次数或抛出了不重试的异常");
                    return false;
                }
        );

        log.info("执行结果:{}",execute);

    }

}

其中执行重试方法的是RetryTemplate的实例retryTemplate，其设置了重试策略SimpleRetryPolicy和回退操作策略FixedBackOffPolicy，重试策略主要设置重试次数上限，回退策略主要设置重试失败后再次执行的时间间隔，其常见的实现方式如下：

重试策略

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

重试回退策略
重试回退策略，指的是每次重试是立即重试还是等待一段时间后重试。默认情况下是立即重试，如果需要配置等待一段时间后重试则需要指定回退策略BackoffRetryPolicy。

1. NoBackOffPolicy： 无退避算法策略，每次重试时立即重试
2. FixedBackOffPolicy： 固定时间的退避策略，需设置参数sleeper和backOffPeriod，sleeper指定等待策略，默认是Thread.sleep，即线程休眠，backOffPeriod指定休眠时间，默认1秒
3. UniformRandomBackOffPolicy： 随机时间退避策略，需设置sleeper、minBackOffPeriod和maxBackOffPeriod，该策略在minBackOffPeriod,maxBackOffPeriod之间取一个随机休眠时间，minBackOffPeriod默认500毫秒，maxBackOffPeriod默认1500毫秒
4. ExponentialBackOffPolicy： 指数退避策略，需设置参数sleeper、initialInterval、maxInterval和multiplier，initialInterval指定初始休眠时间，默认100毫秒，maxInterval指定最大休眠时间，默认30秒，multiplier指定乘数，即下一次休眠时间为当前休眠时间*multiplier
5. ExponentialRandomBackOffPolicy： 随机指数退避策略，引入随机乘数可以实现随机乘数回退

3.执行效果

三、Spring-Retry的原理

四、代码实践

利用Spring-Retry提高请求可靠性：https://github.com/yangnk/SpringBoot_Learning/tree/master/hfn/src/main/java/com/yangnk/hfn/myTest

---

TODO

• 需要补充Spring-Retry 注解的使用方式。
• 需要补充Spring-Retry 的原理。

参考资料

1. 消息重试框架 Spring-Retry 和 Guava-Retry，这个框架有点意思：https://mp.weixin.qq.com/s/TlnSPZmyvIoixkhkvElixg
2. spring-retry详解：https://juejin.cn/post/7234107489390116925 （讲解了spring-retry原理）
3. Spring-Retry重试实现原理，有点东西哈：https://juejin.cn/post/6943007573041741831 （讲解了spring-retry原理）
4. 🍃【Spring专题】「实战系列」重新回顾一下异常重试框架Spring Retry的功能指南：https://juejin.cn/post/7032294589935550494 讲解了spring-retry原理）