1.基本概念
1.1应用场景
1.1.1 数据同步
有时候项目需要进行同步数据(定时任务),一定要同步成功,不然对于业务会有影响,偶发性的会出现调用接口失败,失败并不是特别多,一般的流程如下:
(1)循环的进行远程调用,同步数据,记录一下调用失败的记录
(2)休眠一段时间,继续循环调用失败的记录
(3)如果再调用失败、通过人工二次调用进行修复
1.1.2 抛出xxx异常或者返回结果为x 需要重试
比如:远程调用超时、网络突然中断等可以重试
1.2 重试框架需要解决的问题
1.2.1 重试的策略(RetryPolicy)
无限重试?最多重试几次、指定的时间范围内可以重试、或者多种重试策略组合。
1.2.2 重试的要休眠多久(BackOffPolicy)
重试时间间隔,每次都休眠固定的时间、第一次1s 第二次2s 第三次4s 、随机的休眠时间
1.2.3兜底方案(Recover)
如果所有的重试都失败了、兜底方案是什么?有点类似限流,最差返回你系统繁忙的界面。
2.spring retry
Spring Retry 是从 Spring batch 中独立出来的一个功能,主要实现了重试和熔断,对于那些重试后不会改变结果,毫无意义的操作,不建议使用重试。spring retry提供了注解和编程 两种支持,提供了 RetryTemplate 支持,类似RestTemplate。整个流程如下:
具体使用过程中涉及的核心对象有:
RetryTemplate: 封装了Retry基本操作,是进入spring-retry框架的整体流程入口,通过RetryTemplate可以指定监听、回退策略、重试策略等。
RetryCallback:该接口封装了业务代码,且failback后,会再次调用RetryCallback接口
RetryPolicy:重试策略,描述将以什么样的方式调用RetryCallback接口
BackOffPolicy :回退策略,当出现错误时延迟多少时间继续调用
2.1 添加依赖
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
<version>1.1.5.RELEASE</version>
</dependency>
2.2 使用步骤
(1)定义重试策略RetryPolicy
实际过程如果不定义,则默认SimpleRetryPolicy策略(重试3次)。重试策略有以下种:
NeverRetryPolicy:只允许调用RetryCallback一次,不允许重试;
AlwaysRetryPolicy:允许无限重试,直到成功,此方式逻辑不当会导致死循环;
SimpleRetryPolicy:固定次数重试策略,默认重试最大次数为3次,RetryTemplate默认使用的策略;
TimeoutRetryPolicy:超时时间重试策略,默认超时时间为1秒,在指定的超时时间内允许重试;
CircuitBreakerRetryPolicy:有熔断功能的重试策略,需设置3个参数openTimeout、resetTimeout和delegate;
CompositeRetryPolicy:组合重试策略,有两种组合方式,乐观组合重试策略是指只要有一个策略允许重试即
// 重试策略,指定重试5次
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
retryPolicy.setMaxAttempts(5);
retryTemplate.setRetryPolicy(retryPolicy);
配置之后在RetryTemplate中指定
(2)定义退避策略(BackOffPolicy )
策略主要有以下几种:
FixedBackOffPolicy 固定时间
ExponentialBackOffPolicy 指数退避策略
ExponentialRandomBackOffPolicy 指数随机退避策略
RetryTemplate retryTemplate = new RetryTemplate();
ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
backOffPolicy.setInitialInterval(3000);
backOffPolicy.setMultiplier(2);
backOffPolicy.setMaxInterval(15000);
retryTemplate.setBackOffPolicy(backOffPolicy);
配置之后在RetryTemplate中指定
(3)RetryTemplate执行整体流程
RetryTemplate中指定回退策略为ExponentialBackOffPolicy,指定重试策略为SimpleRetryPolicy,执行操作使用(RetryCallback 执行业务逻辑 ,RecoveryCallback 兜底)。这里面需要用到以下核心对象
RetryCallback :业务回调入口,为retryTemplate.execute时执行的回调
RecoveryCallback :兜底回调入口
RetryContext 重试上下文
//execute接受两个参数(回调函数)业务回调和兜底回调
RefundApplicationFormrefundApplicationForm = retryTemplate.execute(
//RetryCallback
(RetryCallback<RefundApplicationForm, Throwable>) retryContext -> bankAutoRepay(mRefundApplicationForm,
supplierBankId),
//RecoveryCallback兜底
retryContext -> {
// 银行多次重试后异常
mRefundApplicationForm.setRepayStatCd("100");
logger.error("银行多次重试后异常、银行自动退款异常");
return mRefundApplicationForm;
}
);
3.spring retry 注解方式
3.1 启用Spring Retry支持
为了启用Spring Retry的功能,需要向配置类添加@EnableRetry注释。
@SpringBootApplication
@EnableRetry
public class Launcher {
public static void main(String[] args) {
SpringApplication.run(Launcher.class, args);
}
3.2 启用重试特性的方法上使用@Retryable注释
通过此注解设置重试策略和回退策略。Retryable注解参数:
(1)value:指定发生的异常进行重试
(2)include:和value一样,默认空,当exclude也为空时,所有异常都重试
(3)exclude:指定异常不重试,默认空,当include也为空时,所有异常都重试
(4)maxAttemps:重试次数,默认3
(5)backoff:重试补偿机制,默认没有
/**
* 指定异常CustomRetryException重试,重试最大次数为4(默认是3),重试补偿机制间隔200毫秒
* 还可以配置exclude,指定异常不充实,默认为空
* @return result
* @throws CustomRetryException 指定异常
*/
@Retryable(value = {CustomRetryException.class},maxAttempts = 4,backoff = @Backoff(200))
String retry() throws CustomRetryException;
@Backoff 注解 重试补偿策略:
(1)不设置参数时,默认使用FixedBackOffPolicy(指定等待时间),重试等待1000ms
(2)设置delay,使用FixedBackOffPolicy(指定等待设置delay和maxDealy时,重试等待在这两个值之间均态分布)
(3)设置delay、maxDealy、multiplier,使用 ExponentialBackOffPolicy(指数级重试间隔的实现),multiplier即指定延迟倍数,比如delay=5000L,multiplier=2,则第一次重试为5秒,第二次为10秒,第三次为20秒
3.3 @Recover
重试多次失败后,执行兜底方案
@Service
@Slf4j
public class RetryServiceImpl implements RetryService {
private static int count = 1;
@Override
public String retry() throws CustomRetryException {
log.info("retry{},throw CustomRetryException in method retry",count);
count ++;
throw new CustomRetryException("throw custom exception");
}
@Recover
public String recover(Throwable throwable) {
log.info("Default Retry service test");
return "Error Class :: " + throwable.getClass().getName();
}
}
通过Junit进行单元测试。
@Test
void retry() {
try {
final String message = retryService.retry();
log.info("message = "+message);
} catch (CustomRetryException e) {
log.error("Error while executing test {}",e.getMessage());
}