@Retryable注解优雅的实现循环重试功能
在实际工作中,处理可能出现的错误情况是不可避免的。例如,
发送消息失败。
调用远程服务失败。
争抢锁失败。
可由于网络不稳定或其他临时问题,能会导致操作失败。为了确保应用程序的稳定性和可靠性,需要考虑如何处理这些情况。
传统的错误处理方式,如使用 try/catch
块和 while
循环,确实可以解决这些问题。然而,这种方式往往需要在每个可能出错的地方编写重试逻辑,导致代码重复和不一致性,增加了维护成本。而且,这种做法很容易让原本清晰的业务逻辑变得混乱不堪。
在这种情况下,Spring Boot 中的 @Retryable
注解以一种优雅而统一的方式解决了这个问题。通过使用这个注解,您可以将重试逻辑从业务逻辑中分离出来,使代码更加整洁和易于理解。不仅如此,`@Retryable` 还提供了更多的配置选项,可以让您根据具体的需求来调整重试的行为,包括重试次数、延迟时间和触发重试的异常类型。
通过将 @Retryable
注解应用于方法上,您可以确保方法在遇到指定异常时会自动进行重试,无需在每个调用点都编写重试逻辑。这种方式不仅节省了开发时间,还有助于维护代码的一致性和可读性。而且,由于重试逻辑被封装在注解中,您可以在不影响业务逻辑的情况下随时调整重试策略,以适应不同的情况。
总之,Spring Boot 的 @Retryable
注解提供了一种优雅、统一且灵活的方式来处理重试场景,使您能够更好地应对因网络问题、外部依赖故障或其他临时错误而引起的失败情况。这种方式不仅简化了代码,还提高了应用程序的可靠性和稳定性。
@Retryable是什么?
spring系列的spring-retry
是另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。在spring-retry
中,所有配置都是基于简单注释的
使用步骤
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);
}
}
以下是一个示例,在这个示例中,doSomething()
方法被标记为 @Retryable
,当遇到 SomeException.class
异常时,将自动进行重试。
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
@Service
public class MyService {
@Retryable(value = SomeException.class, maxAttempts = 3)
public void doSomething() {
// Your code here
}
}
来简单解释一下注解中几个参数的含义:
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重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。
@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
的使用,主要的适用场景和注意事项,当需要重试的时候还是很有用的。
评论区