关于java:零侵入性一个注解优雅的实现循环重试功能

6次阅读

共计 2256 个字符，预计需要花费 6 分钟才能阅读完成。

前言

在理论工作中，重解决是一个十分常见的场景，比方:

发送音讯失败。
调用近程服务失败。
争抢锁失败。

这些谬误可能是因为网络稳定造成的，期待过后重解决就能胜利。通常来说，会用 try/catch，while 循环之类的语法来进行重解决，然而这样的做法不足统一性，并且不是很不便，要多写很多代码。然而 spring-retry 却能够通过注解，在不入侵原有业务逻辑代码的形式下，优雅的实现重解决性能。

一、@Retryable 是什么？

spring 系列的 spring-retry 是另一个实用程序模块，能够帮忙咱们以规范形式解决任何特定操作的重试。在 spring-retry 中，所有配置都是基于简略正文的。

二、应用步骤

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 办法中有的）
该回调办法与重试办法写在同一个实现类外面

5. 注意事项

因为是基于 AOP 实现，所以不反对类里自调用办法
如果重试失败须要给 @Recover 注解的办法做后续解决，那这个重试的办法不能有返回值，只能是 void
办法内不能应用 try catch，只能往外抛异样
@Recover 注解来开启重试失败后调用的办法 (留神, 需跟重解决办法在同一个类中)，此注解正文的办法参数肯定要是 @Retryable 抛出的异样，否则无奈辨认，能够在该办法中进行日志解决。

总结

本篇次要简略介绍了 Springboot 中的 Retryable 的应用，次要的实用场景和注意事项，当须要重试的时候还是很有用的。

起源：blog.csdn.net/h254931252/article/details/109257998

正文完