聊聊一个注解实现接口重试

开发 前端
通常来说,会用try/catch,while​循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。然而spring-retry却可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。

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

  • 发送消息失败。
  • 调用远程服务失败。
  • 争抢锁失败。

这些错误可能是因为网络波动造成的,等待过后重处理就能成功。通常来说,会用try/catch,while​循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。然而spring-retry却可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。

1.@Retryable是什么?

spring系列的spring-retry​是另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。在spring-retry中,所有配置都是基于简单注释的。

2.使用步骤

(1) POM依赖

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

(2)启用@Retryable

@EnableRetry
@SpringBootApplication
public class HelloApplication {

public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}

}

(3)在方法上添加@Retryable

import com.mail.elegant.service.TestRetryService;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
import java.time.LocalTime;

@Service
public class TestRetryServiceImpl implements TestRetryService {

@Override
@Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
public int test(int code) throws Exception{
System.out.println("test被调用,时间:"+LocalTime.now());
if (code==0){
throw new Exception("情况不对头!");
}
System.out.println("test被调用,情况对头了!");

return 200;
}
}

来简单解释一下注解中几个参数的含义:

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

当重试耗尽时还是失败,会出现什么情况呢?

当重试耗尽时,RetryOperations​可以将控制传递给另一个回调,即RecoveryCallback。Spring-Retry​还提供了@Recover注解,用于@Retryable重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。

(4)@Recover

@Recover
public int recover(Exception e, int code){
System.out.println("回调方法执行!!!!");
//记日志到数据库 或者调用其余的方法
return 400;
}

可以看到传参里面写的是 Exception e​,这个是作为回调的接头暗号(重试次数用完了,还是失败,我们抛出这个Exception e​通知触发这个回调方法)。对于@Recover注解的方法,需要特别注意的是:

  • 方法的返回值必须与@Retryable方法一致。
  • 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable​配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)。
  • 该回调方法与重试方法写在同一个实现类里面。
  • 复java面试,获取最新面试题资料。

(5)注意事项

  • 由于是基于AOP实现,所以不支持类里自调用方法。
  • 如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void。
  • 方法内不能使用try catch,只能往外抛异常。
  • @Recover​注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。

3.总结

本篇主要简单介绍了Springboot中的Retryable的使用,主要的适用场景和注意事项,当需要重试的时候还是很有用的。

责任编辑:武晓燕 来源: 码猿技术专栏
相关推荐

2023-11-06 08:00:38

接口高可用机制

2023-06-05 08:22:20

2022-11-17 07:43:13

2022-06-21 14:44:38

接口数据脱敏

2024-11-08 15:56:36

2024-11-07 10:55:26

2023-08-01 08:54:02

接口幂等网络

2009-08-24 10:47:45

C#接口重实现

2022-05-16 10:45:22

Redis接口限流缓存

2023-08-21 08:01:03

2024-07-15 08:25:07

2021-04-28 14:31:35

Dubbo接口日志

2021-11-05 07:59:25

HashMapJava知识总结

2022-05-26 10:42:30

数据权限注解

2024-04-07 08:48:13

WebSocket集群MQ

2022-03-06 19:57:50

状态机easyfsm项目

2022-11-11 07:34:43

2022-03-22 06:33:49

Python内置模块函数

2022-06-14 10:47:27

项目日志PUT

2022-11-15 07:39:48

点赞
收藏

51CTO技术栈公众号