本文主要是介绍springboot集成spring retry实现重试机制,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
spring retry是从spring batch独立出来的一个功能,主要实现了重试和熔断。对于重试是有场景限制的,不是什么场景都适合重试,比如参数校验不合法、写操作等(要考虑写是否幂等)都不适合重试。远程调用超时、网络突然中断可以重试。在微服务治理框架中,通常都有自己的重试与超时配置,比如dubbo可以设置retries=1,timeout=500调用失败只重试1次,超过500ms调用仍未返回则调用失败。在spring retry中可以指定需要重试的异常类型,并设置每次重试的间隔以及如果重试失败是继续重试还是熔断(停止重试)。
重试策略RetryPolicy实现
- NeverRetryPolicy:只允许调用RetryCallback一次,不允许重试
- AlwaysRetryPolicy:允许无限重试,直到成功,此方式逻辑不当会导致死循环
- SimpleRetryPolicy:固定次数重试策略,默认重试最大次数为3次,RetryTemplate默认使用的策略
- TimeoutRetryPolicy:超时时间重试策略,默认超时时间为1秒,在指定的超时时间内允许重试
- ExceptionClassifierRetryPolicy:设置不同异常的重试策略,类似组合重试策略,区别在于这里只区分不同异常的重试
- CircuitBreakerRetryPolicy:有熔断功能的重试策略,需设置3个参数openTimeout、resetTimeout和delegate
- CompositeRetryPolicy:组合重试策略,有两种组合方式,乐观组合重试策略是指只要有一个策略允许重试即可以,悲观组合重试策略是指只要有一个策略不允许重试即可以,但不管哪种组合方式,组合中的每一个策略都会执行
使用熔断重试策略模式(CircuitBreakerRetryPolicy), 需要设置如下三个参数:
- delegate:传入RetryPolicy(每个RetryPolicy实现都有自己的重试策略实现),是真正判断是否重试的策略,当重试失败时,则执行熔断策略
- openTimeout:openWindow,配置熔断器电路打开的超时时间,当超过openTimeout之后熔断器电路变成半打开状态(只要有一次重试成功,则闭合电路)
- resetTimeout:timeout,配置重置熔断器重新闭合的超时时间
断路器开闭实现判断
- 当重试失败,且在熔断器打开时间窗口[0,openWindow) 内,立即熔断
- 当重试失败,且超过timeout,熔断器电路重新闭合
- 在熔断器半打开状态[openWindow, timeout] 时,只要重试成功则重置上下文,断路器闭合
回退策略
重试回退策略,指的是每次重试是立即重试还是等待一段时间后重试。默认情况下是立即重试,如果需要配置等待一段时间后重试则需要指定回退策略BackoffRetryPolicy。BackoffRetryPolicy有如下实现:
- NoBackOffPolicy:无退避算法策略,每次重试时立即重试
- FixedBackOffPolicy:固定时间的退避策略,需设置参数sleeper和backOffPeriod,sleeper指定等待策略,默认是Thread.sleep,即线程休眠,backOffPeriod指定休眠时间,默认1秒
- UniformRandomBackOffPolicy:随机时间退避策略,需设置sleeper、minBackOffPeriod和maxBackOffPeriod,该策略在[minBackOffPeriod,maxBackOffPeriod之间取一个随机休眠时间,minBackOffPeriod默认500毫秒,maxBackOffPeriod默认1500毫秒
- ExponentialBackOffPolicy:指数退避策略,需设置参数sleeper、initialInterval、maxInterval和multiplier,initialInterval指定初始休眠时间,默认100毫秒,maxInterval指定最大休眠时间,默认30秒,multiplier指定乘数,即下一次休眠时间为当前休眠时间multiplier
- ExponentialRandomBackOffPolicy:随机指数退避策略,引入随机乘数可以实现随机乘数回退
有状态重试 OR 无状态重试
所谓无状态重试是指重试在一个线程上下文中完成的重试,反之不在一个线程上下文完成重试的就是有状态重试。之前的SimpleRetryPolicy就属于无状态重试,因为重试是在一个循环中完成的。那么什么会后会出现或者说需要有状态重试呢?通常有两种情况:事务回滚和熔断。
数据库操作异常DataAccessException,不能执行重试,而如果抛出其他异常可以重试。
熔断的意思不在当前循环中处理重试,而是全局重试模式(不是线程上下文)。熔断会跳出循环,那么必然会丢失线程上下文的堆栈信息。那么肯定需要一种“全局模式”保存这种信息,目前的实现放在一个cache(map实现的)中,下次从缓存中获取就能继续重试了。
快速入门
<dependency><groupId>org.springframework.retry</groupId><artifactId>spring-retry</artifactId>
</dependency>
@ComponentScan("com.jaemon.spring")
@EnableRetry
public class Application {public static void main(String[] args) throws IllegalAccessException {AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Application.class);RetryService retryService = applicationContext.getBean(RetryService.class);retryService.execute();}
}
@EnableRetry(proxyTargetClass = true): 如果设置了proxyTargetClass=true这使用CGLIB动态代理
编程式
基于最大重试次数策略的重试,如果重试了3次仍然抛出异常则停止重试,执行兜底回调,所以最后的输出结果是Integer.MAX_VALUE:
@Service
public class RetryService {public void execute() throws Exception {RetryTemplate retryTemplate = new RetryTemplate();SimpleRetryPolicy simpleRetryPolicy = new SimpleRetryPolicy();simpleRetryPolicy.setMaxAttempts(3);retryTemplate.setRetryPolicy(simpleRetryPolicy);Integer result = retryTemplate.execute(new RetryCallback<Integer, Exception>() {int i = 0;// 重试操作@Overridepublic Integer doWithRetry(RetryContext retryContext) throws Exception {System.out.println("retry count: " + retryContext.getRetryCount());return len(i++);}// 兜底回调}, retryContext -> {System.out.println("after retry: " + retryContext.getRetryCount() + ", recovery method called!");return Integer.MAX_VALUE;});System.out.println("final result: " + result);}private int len(int i) throws Exception {if (i < 10) {throw new Exception(i + " le 10");}return i;}
}
自定义RetryTemplate
@Configuration
@EnableRetry(proxyTargetClass = true)
public class RetryConfig {@Beanpublic RetryTemplate simpleRetryTemplate() {RetryTemplate retryTemplate = new RetryTemplate();// 最大重试次数策略SimpleRetryPolicy simpleRetryPolicy = new SimpleRetryPolicy(3);retryTemplate.setRetryPolicy(simpleRetryPolicy);FixedBackOffPolicy fixedBackOffPolicy = new FixedBackOffPolicy();// 每隔1s后再重试fixedBackOffPolicy.setBackOffPeriod(1000);retryTemplate.setBackOffPolicy(fixedBackOffPolicy);return retryTemplate;}}
- Spring Retry框架——看这篇就够了
声明式-注解方式
如果每次有重试需求的时候都写一个RetryTemplate太臃肿了,使用注解可以大大简化开发,减少重复代码。下面是一个使用注解实现的最大重试策略的重试:
@Service
public class RetryService {@Retryable(value = IllegalAccessException.class, maxAttempts = 5, listeners = {"defaultRetryListener"},backoff= @Backoff(delay = 3000, maxDelay = 10000, multiplier = 1.5))public void execute() throws IllegalAccessException {System.out.println("service method...");throw new IllegalAccessException("manual exception");}@Recoverpublic void recover(IllegalAccessException e){System.out.println("service retry after Recover => " + e.getMessage());}
}
@Service
public class DefaultRetryListener implements RetryListener {@Overridepublic <T, E extends Throwable> boolean open(RetryContext context, RetryCallback<T, E> callback) {System.out.println("==前置回调==");return true;}@Overridepublic <T, E extends Throwable> void close(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {System.out.println("==后置回调==");}@Overridepublic <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback, Throwable throwable) {System.out.println("==执行报错==");}
}
open 和 close 分别在重试整体的前置和后置被回调一次,onError 则是重试整体过程中,每次异常都会被回调。
第一次重试为3000ms后,第二次为4500ms后,第三次为6750ms后,第四次为10000ms后。
- 第四次实际应该是10125ms后,但由于超过了设定的最大延迟时间10000ms。
- 最大重试次数为5次,由于包含了第一次失败,所以实际重试了4次。
注解说明
- @EnableRetry: 开启重试机制
- @Retryable: 标识方法需要重试
- value: 需重试的异常类型,和include同义。默认为空,如果include参数也为空,所有异常都会重试。
- include: 需重试的异常类型,和value同义 。
- exclude: 需排除重试的异常类型。
- maxAttempts: 重试的最大次数(包含第一次失败),默认3次。
- @Backoff: 重试中的退避策略
- value:与delay等同,delay优先级高于value。默认1000ms。
- delay:与value等同,delay非0时使用delay值忽略value值。
- maxDelay: 最大延迟时间
- multiplier:指定延迟倍数。
- @Recover: 多次重试后还是失败执行的兜底方法
- @CircuitBreaker: 用于方法,实现熔断模式。
- include 指定处理的异常类。默认为空 。
- exclude指定不需要处理的异常。默认为空 。
- vaue指定要重试的异常。默认为空 。
- maxAttempts 最大重试次数。默认3次。
- openTimeout 配置熔断器打开的超时时间,默认5s,当超过openTimeout之后熔断器电路变成半打开状态(只要有一次重试成功,则闭合电路)。
- resetTimeout 配置熔断器重新闭合的超时时间,默认20s,超过这个时间断路器关闭。
注意: 使用了@Retryable的方法不能在本类被调用,不然重试机制不会生效。
这篇关于springboot集成spring retry实现重试机制的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!