@Retryable SpringBoot 实现优雅重试机制

一、@Retryable是什么?

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

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

  • 发送消息失败
  • 调用远程服务失败
  • 争抢锁失败

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

二、使用步骤

2.1 导入依赖

<dependency>
 <groupId>org.springframework.retry</groupId>
 <artifactId>spring-retry</artifactId>
</dependency>

2.2 启用 @Retryable

@EnableRetry
@SpringBootApplication
public class HelloApplication {
    public static void main(String[] args) {
        SpringApplication.run(HelloApplication.classargs);
    }
}

2.3 使用

在方法上添加 @Retryable

@Service
@Slf4j
@RequiredArgsConstructor
public class AliYunSmsServiceImpl implements AliYunSmsService {
    private final AliYunProperties aliYunProperties;

    @Override
    @Retryable(value = {ServerException.classClientException.class}, maxAttempts 3, backoff = @Backoff(delay = 2000, multiplier = 1.5))
    public Boolean sendSms(String phone) throws Exception {
        SendSmsRequest sendSmsRequest = getSendSmsRequest(phone);
        SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(sendSmsRequest);
        log.info("[发送短信]phone={}, result={}", phone, sendSmsResponse.getCode());
        return sendSmsResponse.getCode() != null && "OK".equals(sendSmsResponse.getCode());
    }
}

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

  • value:抛出指定异常才会重试
  • includeinclude:和 value 一样,默认为空,当 exclude 也为空时,默认所有异常
  • exclude:指定不处理的异常
  • maxAttempts :最大重试次数,默认3次
  • backoff:重试等待策略,默认使用 @Backoff,@Backoff 的 value 默认为 1000L,我们设置为 2000L;multiplier(指定延迟倍数)默认为 0,表示固定暂停 1 秒后进行重试,如果把 multiplier 设置为 1.5,则第一次重试为 2 秒,第二次为 3 秒,第三次为 4.5 秒。

2.4 回调 @Recover

当重试耗尽时还是失败,会出现什么情况呢?

当重试耗尽时,RetryOperations 可以将控制传递给另一个回调,即 RecoveryCallbackSpring-Retry 还提供了 @Recover 注解,用于 @Retryable 重试失败后处理方法。如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。

@Recover

/**
 * 发送短信失败 写入数据库
 * @return
 * @throws Exception
 */

@Recover
public Boolean recover(Exception e) throws Exception {
    // TODO 写入数据库
    log.warn("发送短信失败");
    throw e;
}

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

  • 方法的返回值必须与 @Retryable 方法一致
  • 方法的第一个参数,必须是 Throwable 类型的,建议是与 @Retryable 配置的异常一致,其他的参数,需要哪个参数,写进去就可以了
  • 该回调方法与重试方法写在同一个实现类里面

2.5 注意事项

  • 由于是基于 AOP 实现,所以不支持类里自调用方法
  • 如果重试失败需要给 @Recover 注解的方法做后续处理,那这个重试的方法不能有返回值,只能是 void
  • 方法内不能使用 try catch,只能往外抛异常
  • @Recover 注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是 @Retryable 抛出的异常,否则无法识别,可以在该方法中进行日志处理。


原文始发于微信公众号(连帆起航):@Retryable SpringBoot 实现优雅重试机制

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/239294.html

(0)
小半的头像小半

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!