spring-retry(1.概念和基本用法)


准备好好看看一下spring-cloud的源码,把其中实现的原理搞清楚,而不是仅仅会配几个注解,会配几个参数,把“微服务”框架搭建起来。在查看其中pom的的依赖关系时,发现spring-cloud对于spring不仅仅是bean,aop,context等,居然spring-cloud-commons依赖了一个spring-retry的东西。

官方定义:

This project provides declarative retry support for Spring applications. It is used in Spring Batch, Spring Integration, Spring for Apache Hadoop (amongst others).

该项目给spring应用提供了声明式的重试支持。它被使用在spring批处理,spring集成,Apache Hadoop集成pring几个项目中。

一、概念
spring对于重试机制的实现,给了几个抽象。

  1. BackOff:补偿值,一般指失败后多久进行重试的延迟值。
  2. Sleeper:暂停应用的工具,通常用来应用补偿值。
  3. BackOffPolicy:补偿策略,决定失败后如何确定补偿值。
  4. RetryContext:重试上下文,代表了能被重试动作使用的资源。
  5. RetryPolicy:重试策略,决定失败能否重试。
  6. RecoveryCallback:定义一个动作recover,在重试耗尽后的动作。
  7. RetryCallback:具体的重试动作。
  8. RetryOperations:通过传递RetryCallback,进行重试操作。
  9. RetryState:重试状态,通常包含一个重试的键值。
  10. RetryStatistics和RetryListener,用来监控Retry的执行情况,并生成统计信息。

二、声明式使用
官方给的代码如下:

@Configuration
@EnableRetry
public class Application {

    @Bean
    public Service service() {
        return new Service();
    }

}

@Service
class Service {
    @Retryable(RemoteAccessException.class)
    public void service() {
        // ... do something
    }
    @Recover
    public void recover(RemoteAccessException e) {
       // ... panic
    }
}

通过@EnableRetry就可以启用Retry功能了,需要被重试的方法加上@Retryable(),就能在指定的异常出现情况下重试,而当默认的失败次数到达后(查看SimpleRetryPolicy可知,就是试3次),就会调用@Recover注解的方法,进行恢复。
当然在@Retryable上,可以配置属性,更加细化
例如:@Retryable(value= {RemoteAccessException.class},maxAttempts = 5,backoff = @Backoff(delay = 5000l,multiplier = 1))
指定,重试5次,每次补偿(延迟5秒),每次倍数为1(不变)。

几个注解的参数解释

@EnableRetry能否重试。当proxyTargetClass属性为true时,使用CGLIB代理。默认使用标准JAVA注解。在spring Boot中此参数写在程序入口即可。
@Retryable 标注此注解的方法在发生异常时会进行重试

  • value:指定处理的异常类
  • include:指定处理的异常类和value一样,默认为空,当exclude也为空时,默认所有异常
  • exclude:指定异常不处理,默认空,当include也为空时,默认所有异常
  • maxAttempts:最大重试次数。默认3次
    -backoff: 重试补偿策略。默认使用@Backoff注解

@Backoff 重试补偿策略

  • 不设置参数时,默认使用FixedBackOffPolicy(指定等待时间),重试等待1000ms
  • 设置delay,使用FixedBackOffPolicy(指定等待- - 设置delay和maxDealy时,重试等待在这两个值之间均态分布
  • 设置delay、maxDealy、multiplier,使用 ExponentialBackOffPolicy(指数级重试间隔的实现 ),multiplier即指定延迟倍数,比如delay=5000l,multiplier=2,则第一次重试为5秒,第二次为10秒,第三次为20秒

@Recover 用于@Retryable重试失败后处理方法,此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。

三、核心API-RetryTemplate
声明式的使用,实际上是由spring-retry在内部生成了一个默认的RetryTemplate,由它封装我们自己写的函数完成的重试。这有点像@Scheduled,内部生成了一个ThreadPoolTaskExecutor完成定时任务的调度。虽然简单,但是可配置的东西太少了,如果想用spring-retry强大的策略机制,并必须定制化RetryTemplate。

官方的API使用demo如下:

RetryTemplate template = new RetryTemplate();

TimeoutRetryPolicy policy = new TimeoutRetryPolicy();
policy.setTimeout(30000L);

template.setRetryPolicy(policy);

Foo result = template.execute(new RetryCallback<Foo>() {

    public Foo doWithRetry(RetryContext context) {
        // Do stuff that might fail, e.g. webservice operation
        return result;
    }

});

可以看出,new出一个RetryTemplate对象后,可以给它设置重试策略、补偿策略、重试监听器等属性。核心是在template.execute(),传递一个RetryCallback,内部执行我们需要重试的具体方法。
RetryTemplate是标准spring的××Template风格(脑补jdbcTemplate),内部doExecute()方法实现了如何开启重试上下文,获取补偿上下文,在try/catch中执行doWithRetry(),出现异常捕捉下来,如何应用重试策略决定重试,最后如何应用回退方法,关闭上下文等。这些都模板化了,我们只需要要传入RetryCallback和RecoveryCallback(连这个也可省)。

参考:

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容