下载安卓APP箭头
箭头给我发消息

客服QQ:3315713922

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

作者:匿名     来源: 编程语言点击数:766发布时间: 2022-06-10 22:13:22

标签: 接口重试while

大神带你学编程,欢迎选课

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

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

  发送消息失败。

  调用远程服务失败。

  争抢锁失败。

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

  1.@Retryable是什么?

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

  2.使用步骤

  (1) POM依赖

  复制  

  1. <dependency>

  2. <groupIdorg>org.springframework.retry

  3. <artifactId>spring-retry</artifactId>

  4. <dependency>

  (2)启用@Retryable

  复制

  1. @EnableRetry

  2. @SpringBootApplication

  3. public class HelloApplication {

  4.

      5. public static void main(String[] args) {

  6. SpringApplication.run(HelloApplication.class, args);

  7. }

      8.

  9. }

  (3)在方法上添加@Retryable

  复制

  1. import com.mail.elegant.service.TestRetryService;

  2. import org.springframework.retry.annotation.Backoff;

  3. import org.springframework.retry.annotation.Retryable;

  4. import org.springframework.stereotype.Service;

  5. import java.time.LocalTime;

  6.

      7. @Service

  8. public class TestRetryServiceImpl implements TestRetryService {

  9.

     10. @Override

  11. @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))

  12. public int test(int code) throws Exception{

  13. System.out.println("test被调用,时间:"+LocalTime.now());

  14. if (code==0){

  15. throw new Exception("情况不对头!");

  16. }

  17. System.out.println("test被调用,情况对头了!");

      18.

  19. return 200;

  20. }

  21. }

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

  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

  复制

  1. @Recover

  2. public int recover(Exception e, int code){

  3. System.out.println("回调方法执行!!!!");

  4. //记日志到数据库 或者调用其余的方法

  5. return 400;

  6. }

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

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

  方法的第一个参数,必须是Throwable类型的,建议是与@Retryable​配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)。

  该回调方法与重试方法写在同一个实现类里面。

  复java面试,获取最新面试题资料。

  (5)注意事项

  由于是基于AOP实现,所以不支持类里自调用方法。

  如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void。

  方法内不能使用try catch,只能往外抛异常。

  @Recover​注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。

  3.总结

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

  来源: 码猿技术专栏

    >>>>>>点击进入编程语言专题

赞(14)
踩(0)
分享到:
华为认证网络工程师 HCIE直播课视频教程