使用Spring-Retry优雅实现异常重试

简介: 使用Spring-Retry优雅实现异常重试

最近在项目代码CR过程中,同事针对我代码中的方法重试提了一个优雅的解决方式:Spring异常重试框架Spring-Retry。而我之前处理重试的方式,就是for循环,正常返回或循环结束的时候就跳出循环,代码示例如下:

public Boolean invokeDoSomething(){
    Boolean result = false;
    int retryCount = 3;
    for(int i = 0;i<retryCount;i++)
    {
      try{
        return doSomething();
      } catch(Exception e){
        log.error("执行异常:",e);
        try {
            Thread.sleep(100);
          } catch (InterruptedException e1) {
            log.error("休眠执行异常:", e1);
          }
      }
      }
    return false;
}


说实在的,和异常重试框架比起来的,我的这种重试方式好low啊。庆幸,自己又学到东西了。下面进入正题,开始介绍Spring异常重试框架Spring Retry


@Retryable和@Recover实现了重处理,重处理的场景是十分常见的,例如发起网络请求的时候,经常会因为网络波动等原因造成请求失败,产生异常,这时候可以使用@Retryable和@Recover简单的实现重处理。


Spring Retry支持集成到Spring或者Spring Boot项目中,下面演示一下快速集成的代码样例:

@Service
@EnableRetry
class Service {
    @Retryable(RemoteAccessException.class)
    public service() {
        // ... do something
    }
}


下面是基于Spring Boot项目的集成步骤:


POM:添加maven依赖:

<!-- Spring Retry -->
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
            <version>1.2.5.RELEASE</version>
        </dependency>


Service:

@Service
@EnableRetry
public class RemoteService {
    private final static Logger logger = LoggerFactory.getLogger(RemoteService.class);
    @Retryable(value = { RemoteAccessException.class }, maxAttempts = 3, backoff = @Backoff(delay = 5000l, multiplier = 1))
    public void call(String param) throws Exception {
        logger.info(LocalTime.now()+" do something...");
        throw new RemoteAccessException("RPC调用异常");
    }
    @Recover
    public void recover(RemoteAccessException e,String param) {
        logger.info(e.getMessage());
    }
}


@Retryable注解:


被注解的方法发生异常时会重试


  • value:指定发生的异常进行重试
  • include:和value一样,默认空,当exclude也为空时,所有异常都重试
  • exclude:指定异常不重试,默认空,当include也为空时,所有异常都重试
  • maxAttemps:重试次数,默认3
  • backoff:重试补偿机制,默认没有
  • @Backoff注解


delay:指定延迟后重试


multiplier:指定延迟的倍数,比如delay=5000l,multiplier=2时,第一次重试为5秒后,第二次为10秒,第三次为20秒


@Recover 注解:


当重试到达指定次数时,被注解的方法将被回调,可以在该方法中进行日志处理。需要注意的是recover方法入参中的异常要被注解@Retryable修饰的方法内部抛出的异常保持一致,至于其他参数,从原方法上根据情况进行选择即可(针对这个点,我看很多文章中都有错误,所以一定要自己亲自尝试一下,一定不能盲信)。


说明:


  1. 项目基于springboot,@EnableRetry注解可以添加在项目启动类上,也可以直接添加在具有@Retryable注解方法的类上。上面代码,我是直接添加到方法的类上。


  1. 使用了@Retryable的方法不能在本类被调用,不然重试机制不会生效。也就是要标记为@Service,然后在其它类使用@Autowired注入或者@Bean去实例才能生效。这是因为retry用到了aspect增强,在方法内部调用的时候,会使aspect增强失效,那么retry当然也会失效。


  1. 使用了@Retryable的方法里面不能使用try...catch包裹,要在方法上抛出异常,不然不会触发。


  1. 在重试期间这个方法是同步的,如果使用类似Spring Cloud这种框架的熔断机制时,可以结合重试机制来重试后返回结果。


  1. Spring Retry不是只能注入方式去实现,还可以通过API的方式实现,类似熔断处理的机制就基于API方式实现会比较宽松。


当使用成对配置@Retryable和@Recover实现了失败重试的时候,我就想如果一个类中有两个方法使用了@Retryable注解,那么它们是如何找到自己的recover方法呢。经过查看官方文档,里面提到针对解决多个可选择用于恢复的方法之间的冲突问题,可以显式地指定恢复方法名称,代码示例如下:

@Service
class Service {
    @Retryable(recover = "service1Recover", value = RemoteAccessException.class)
    public void service1(String str1, String str2) {
        // ... do something
    }
    @Retryable(recover = "service2Recover", value = RemoteAccessException.class)
    public void service2(String str1, String str2) {
        // ... do something
    }
    @Recover
    public void service1Recover(RemoteAccessException e, String str1, String str2) {
        // ... error handling making use of original args if required
    }
    @Recover
    public void service2Recover(RemoteAccessException e, String str1, String str2) {
        // ... error handling making use of original args if required
    }
}


我试了一下,@Retryable注解中包括recover属性,只是从1.3.0+版本才出现的,我用1.3.1试了一下,发现并没有生效,由于1.3.0+的版本还没有release版本,所以线上环境我就暂不考虑冲突的问题,但日后该组件高版本发布了release版本,再来做补充说明吧。

相关文章
|
1天前
|
Dubbo Java 应用服务中间件
深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案
本文深入探讨了“dubbo+nacos+springboot3的native打包成功后运行出现异常”的原因及解决方案。通过检查GraalVM版本兼容性、配置反射列表、使用代理类、检查配置文件、禁用不支持的功能、查看日志文件、使用GraalVM诊断工具和调整GraalVM配置等步骤,帮助开发者快速定位并解决问题,确保服务的正常运行。
10 1
|
5月前
|
XML Java UED
使用 Spring Boot 实现重试和补偿功能:从理论到实践
【6月更文挑战第17天】在分布式系统中,服务之间的调用可能会因为网络故障、服务器负载等原因偶尔失败。为了提高系统的可靠性和稳定性,我们经常需要实现重试和补偿功能。
114 6
|
27天前
|
Java API Spring
springBoot:注解&封装类&异常类&登录实现类 (八)
本文介绍了Spring Boot项目中的一些关键代码片段,包括使用`@PathVariable`绑定路径参数、创建封装类Result和异常处理类GlobalException、定义常量接口Constants、自定义异常ServiceException以及实现用户登录功能。通过这些代码,展示了如何构建RESTful API,处理请求参数,统一返回结果格式,以及全局异常处理等核心功能。
|
1月前
|
Java 关系型数据库 数据库连接
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第3天】Spring Boot项目中数据库连接问题可能源于配置错误或依赖缺失。YAML配置文件的格式不正确,如缩进错误,会导致解析失败;而数据库驱动不匹配、连接字符串或认证信息错误同样引发连接异常。解决方法包括检查并修正YAML格式,确认配置属性无误,以及添加正确的数据库驱动依赖。利用日志记录和异常信息分析可辅助问题排查。
136 10
|
1月前
|
Java 关系型数据库 MySQL
SpringBoot项目使用yml文件链接数据库异常
【10月更文挑战第4天】本文分析了Spring Boot应用在连接数据库时可能遇到的问题及其解决方案。主要从四个方面探讨:配置文件格式错误、依赖缺失或版本不兼容、数据库服务问题、配置属性未正确注入。针对这些问题,提供了详细的检查方法和调试技巧,如检查YAML格式、验证依赖版本、确认数据库服务状态及用户权限,并通过日志和断点调试定位问题。
|
3月前
|
前端开发 小程序 Java
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅
本文详细介绍了如何在SpringBoot项目中统一处理接口返回结果及全局异常。首先,通过封装`ResponseResult`类,实现了接口返回结果的规范化,包括状态码、状态信息、返回信息和数据等字段,提供了多种成功和失败的返回方法。其次,利用`@RestControllerAdvice`和`@ExceptionHandler`注解配置全局异常处理,捕获并友好地处理各种异常信息。
919 0
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅
|
3月前
|
消息中间件 Java 开发工具
【Azure 事件中心】Spring Cloud Stream Event Hubs Binder 发送Event Hub消息遇见 Spec. Rule 1.3 - onSubscribe, onNext, onError and onComplete signaled to a Subscriber MUST be signaled serially 异常
【Azure 事件中心】Spring Cloud Stream Event Hubs Binder 发送Event Hub消息遇见 Spec. Rule 1.3 - onSubscribe, onNext, onError and onComplete signaled to a Subscriber MUST be signaled serially 异常
|
3月前
|
Java Spring
【Azure 事件中心】Spring Boot 集成 Event Hub(azure-spring-cloud-stream-binder-eventhubs)指定Partition Key有异常消息
【Azure 事件中心】Spring Boot 集成 Event Hub(azure-spring-cloud-stream-binder-eventhubs)指定Partition Key有异常消息
|
3月前
|
Java Spring
【Azure 服务总线】Spring Cloud 的应用 使用Service Bus 引起 org.springframework.beans.BeanInstantiationException 异常,无法启动
【Azure 服务总线】Spring Cloud 的应用 使用Service Bus 引起 org.springframework.beans.BeanInstantiationException 异常,无法启动
|
3月前
|
NoSQL Java Redis
【Azure Spring Cloud】Java Spring Cloud 应用部署到Azure上后,发现大量的 java.lang.NullPointerException: null at io.lettuce.core.protocol.CommandHandler.writeSingleCommand(CommandHandler.java:426) at ... 异常
【Azure Spring Cloud】Java Spring Cloud 应用部署到Azure上后,发现大量的 java.lang.NullPointerException: null at io.lettuce.core.protocol.CommandHandler.writeSingleCommand(CommandHandler.java:426) at ... 异常