使用spring-retry优雅实现接口重试

在实际工作中,重处理是一个非常常见的场景,比如:

发送消息失败。

调用远程服务失败。


这些错误可能是因为网络波动造成的,等待过后重处理就能成功。通常来说,会用try/catch,while循环之类的语法来进行重处理,但是这样的做法缺乏统一性,要多写很多重复代码。

public String doSth(String param) { int count = 0; String result = ""; while (count < 3) { try { result = retryRequestService.request(param); break; } catch (Exception e) { count++; } } return "响应是" + result;}

spring-retry 可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。

spring-retry 是 Spring 全家桶中提供的开源重试框架,如果你用的是 Spring Boot 项目,那么接入起来会非常简单,只需要三步即可实现快速接入。

引入依赖

<dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId></dependency>

启动类添加注解

在启动类上加注解 @EnableRetry,让 Spring Boot 项目支持 spring-retry 的重试功能。

@SpringBootApplication@EnableRetrypublic class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); }}

方法上添加 @Retryable

@Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 100))public void retry(int code) throws Exception { System.out.println("test被调用,时间:"+ LocalDateTime.now()); if (code == 0){ throw new Exception("===========出现异常了!==========="); } System.out.println("方法执行结束=============");}

@RequestMapping(value = "/test")public void test(int code) throws Exception { cityService.retry(code);}

test被调用,时间:2022-12-06T10:56:20.081 test被调用,时间:2022-12-06T10:56:20.183 test被调用,时间:2022-12-06T10:56:20.293 test被调用,时间:2022-12-06T10:56:20.404 test被调用,时间:2022-12-06T10:56:20.521 2022-12-06 10:56:20.525 ERROR 16696 --- [nio-8080-exec-1] o.a.c.c.C.[.[.[/].[dispatcherServlet] : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.Exception: ===========出现异常了!===========] with root cause

value:抛出指定异常才会重试 include:和value一样,默认为空,当exclude也为空时,默认所有异常 exclude:指定不处理的异常 maxAttempts:最大重试次数,默认3次 backoff:重试等待策略,默认使用@Backoff,@Backoff的value默认为1000(单位毫秒),我们设置为2000;multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。

backoff = @Backoff(delay = 100) delay=100 意味着下一次的重试,要等 100 毫秒之后才能执行。

当重试耗尽时,RetryOperations可以将控制传递给另一个回调,即RecoveryCallback。Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。回调方法不是必要的。

@Recover public void recover(Exception e, int code){ System.out.println("回调方法执行!!!!"); System.out.println("retryParam参数值为:"+ code); System.out.println("异常信息:"+e.getMessage()); }

回调方法的参数可以可选地包括抛出的异常和(可选)传递给原始可重试方法的参数。

  • 方法的返回值必须与@Retryable方法一致

  • 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致

  • 回调方法与重试方法写在同一个类里面

test被调用,时间:2022-12-06T11:37:39.272 test被调用,时间:2022-12-06T11:37:39.386 test被调用,时间:2022-12-06T11:37:39.497 test被调用,时间:2022-12-06T11:37:39.604 test被调用,时间:2022-12-06T11:37:39.712 回调方法执行!!!! retryParam参数值为:0 异常信息:===========出现异常了!===========

本文使用 文章同步助手 同步


在实际工作中,重处理是一个非常常见的场景,比如:

发送消息失败。

调用远程服务失败。

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

推荐阅读更多精彩内容