脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot @Retryable注解

SpringBoot @Retryable注解使用

 更新时间：2024年12月10日 09:54:00   作者：LBL_lin  
SpringBoot提供的@Retryable注解可以方便地实现方法的重试机制,可以在不侵入原有逻辑代码的方式下,优雅地实现重处理功能

前言

在使用第三方接口的时候，一般都会有一些类似登录客户端的处理，或者发送消息这些场景，有时候会出现网络抖动、连接超时等异常，这时候就需要进行多次重试。

一般如果我们自己实现重试机制，都是使用循环，但是这样并不优雅。

在SpringBoot中已经提供了实现重试机制的功能——@Retryable注解，可以在不侵入原有逻辑代码的方式下，优雅的实现重处理功能。

一、@Retryable是什么？

@Retryable是Spring提供的可重试注解，该注解一般用于方法上，实现方法的重试机制。

二、使用步骤

POM依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
</dependency>

启动@Retryable

在启动类上加上@EnableRetry，开启重试机制。

@EnableRetry
@SpringBootApplication
public class SpringBootRetryApplication {

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

Service类

在需要重试方法上加上@Restryable

@Slf4j
@Service
public class LoginService {

    @Retryable(value = Exception.class, maxAttempts = 5, backoff = @Backoff(delay = 2000L, multiplier = 1))
    public void login(boolean isRetry) throws Exception {
        log.info("----------开始登录----------");
        if (isRetry) {
            throw new Exception("重试登录");
        }
    }
}

这里解释一下@Retryable常用的几个参数的含义：

  • value：抛出指定的异常才会重试
  • include：和value一样，默认为空，当exclude也为空时，默认所有异常
  • exclude：指定不处理的异常
  • maxAttempts：最大重试次数，默认是3次
  • backoff：重试等待策略，默认使用@Backoff，value为重试间隔，delay为重试之间的等待时间(毫秒为单位)，multiplier指定延迟的倍数。

查看效果

可以看到，重试5次之后抛出异常，不再重试。

@Recover

当重试耗尽完后还是失败，会出现什么情况？

RetryOperations可以将控制传递给另一个回调，即RecoveryCallback。Spring还提供了@Recover注解，用于@Retryable重试失败后处理方法，此方法里的异常一定要是@Retryable方法里抛出的异常，否则不会回调这个方法。

    @Recover
    public void doRecover(Exception e) {
        log.info("----------重试失败回调方法----------");
        log.info(e.getMessage());
    }

@Recover注解需要注意的点：

  1. 方法的返回值必须与@Retryable方法一致
  2. 方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要与@Retryable方法的参数一致。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

最新评论