使用Spring-Retry优雅实现异常重试

最近在项目代码CR过程中,同事针对我代码中的方法重试提了一个优雅的解决方式:Spring异常重试框架Spring-Retry。而我之前处理重试的方式,就是for循环,正常返回或循环结束的时候就跳出循环,代码示例如下:

public Boolean invokeDoSomething(){
    Boolean result = false;
    int retryCount = 3;
    for(int i = 0;i<retryCount;i++)
    {
      try{
        return doSomething();
      } catch(Exception e){
        log.error("执行异常:",e);
        try {
            Thread.sleep(100);
          } catch (InterruptedException e1) {
            log.error("休眠执行异常:", e1);
          }
      }
      }
    return false;
}

说实在的,和异常重试框架比起来的,我的这种重试方式好low啊。庆幸,自己又学到东西了。下面进入正题,开始介绍Spring异常重试框架Spring Retry

@Retryable和@Recover实现了重处理,重处理的场景是十分常见的,例如发起网络请求的时候,经常会因为网络波动等原因造成请求失败,产生异常,这时候可以使用@Retryable和@Recover简单的实现重处理。

Spring Retry支持集成到Spring或者Spring Boot项目中,下面演示一下快速集成的代码样例:

@Service
@EnableRetry
class Service {
    @Retryable(RemoteAccessException.class)
    public service() {
        // ... do something
    }
}

下面是基于Spring Boot项目的集成步骤:

POM:添加maven依赖:

        <!-- Spring Retry -->
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
            <version>1.2.5.RELEASE</version>
        </dependency>

Service:

@Service
@EnableRetry
public class RemoteService {
    
    private final static Logger logger = LoggerFactory.getLogger(RemoteService.class);
    
    @Retryable(value = { RemoteAccessException.class }, maxAttempts = 3, backoff = @Backoff(delay = 5000l, multiplier = 1))
    public void call(String param) throws Exception {
        logger.info(LocalTime.now()+" do something...");
        throw new RemoteAccessException("RPC调用异常");
    }

    @Recover
    public void recover(RemoteAccessException e,String param) {
        logger.info(e.getMessage());
    }
}

@Retryable注解:
被注解的方法发生异常时会重试

  • value:指定发生的异常进行重试
  • include:和value一样,默认空,当exclude也为空时,所有异常都重试
  • exclude:指定异常不重试,默认空,当include也为空时,所有异常都重试
  • maxAttemps:重试次数,默认3
  • backoff:重试补偿机制,默认没有
  • @Backoff注解
    delay:指定延迟后重试
    multiplier:指定延迟的倍数,比如delay=5000l,multiplier=2时,第一次重试为5秒后,第二次为10秒,第三次为20秒

@Recover 注解:

当重试到达指定次数时,被注解的方法将被回调,可以在该方法中进行日志处理。需要注意的是recover方法入参中的异常要被注解@Retryable修饰的方法内部抛出的异常保持一致,至于其他参数,从原方法上根据情况进行选择即可(针对这个点,我看很多文章中都有错误,所以一定要自己亲自尝试一下,一定不能盲信)。

说明:

  1. 项目基于springboot,@EnableRetry注解可以添加在项目启动类上,也可以直接添加在具有@Retryable注解方法的类上。上面代码,我是直接添加到方法的类上。

  2. 使用了@Retryable的方法不能在本类被调用,不然重试机制不会生效。也就是要标记为@Service,然后在其它类使用@Autowired注入或者@Bean去实例才能生效。这是因为retry用到了aspect增强,在方法内部调用的时候,会使aspect增强失效,那么retry当然也会失效。

  3. 使用了@Retryable的方法里面不能使用try...catch包裹,要在方法上抛出异常,不然不会触发。

  4. 在重试期间这个方法是同步的,如果使用类似Spring Cloud这种框架的熔断机制时,可以结合重试机制来重试后返回结果。

  5. Spring Retry不是只能注入方式去实现,还可以通过API的方式实现,类似熔断处理的机制就基于API方式实现会比较宽松。

当使用成对配置@Retryable和@Recover实现了失败重试的时候,我就想如果一个类中有两个方法使用了@Retryable注解,那么它们是如何找到自己的recover方法呢。经过查看官方文档,里面提到针对解决多个可选择用于恢复的方法之间的冲突问题,可以显式地指定恢复方法名称,代码示例如下:

@Service
class Service {
    @Retryable(recover = "service1Recover", value = RemoteAccessException.class)
    public void service1(String str1, String str2) {
        // ... do something
    }

    @Retryable(recover = "service2Recover", value = RemoteAccessException.class)
    public void service2(String str1, String str2) {
        // ... do something
    }

    @Recover
    public void service1Recover(RemoteAccessException e, String str1, String str2) {
        // ... error handling making use of original args if required
    }

    @Recover
    public void service2Recover(RemoteAccessException e, String str1, String str2) {
        // ... error handling making use of original args if required
    }
}

我试了一下,@Retryable注解中包括recover属性,只是从1.3.0+版本才出现的,我用1.3.1试了一下,发现并没有生效,由于1.3.0+的版本还没有release版本,所以线上环境我就暂不考虑冲突的问题,但日后该组件高版本发布了release版本,再来做补充说明吧。

参考:
https://github.com/spring-projects/spring-retry(官网)

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

推荐阅读更多精彩内容