Spring基础篇-08-Spring循环重试注解Retryable和Recover的使用

Alan0517

已于 2023-05-29 19:41:50 修改

阅读量462

点赞数

文章标签： spring java

于 2023-04-20 16:58:59 首次发布

本文链接：https://blog.csdn.net/Hmj050117/article/details/130260789

版权

Spring-基础篇专栏收录该内容

5 篇文章 1 订阅

订阅专栏

文章目录

1. 简介
2. @Retryable是什么？
3. 注意事项

1. 简介

在实际工作中，重处理是一个非常常见的场景，比如:

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

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

2. @Retryable是什么？

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

2.1 引入依赖

这一步基本不需要引入，因为Spring的很多组件都包含了，如果没有可以单独引入

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

2.2 启用@Retryable

/**
 * 启动类
 *
 * @author wql
 * @date 2022/10/31 22:13
 */
@EnableRetry
@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

2.3 使用@Retryable

创建一个接口

/**
 * 测试Spring重试组件
 *
 * @author wql
 * @date 2023/4/20 9:49
 */
public interface TestSpringRetryService {

    int testRetry(int code) throws Exception;
}

实现类

import com.ddmc.punishment.service.TestSpringRetryService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

import java.time.LocalTime;

/**
 * @author wql
 * @date 2023/4/20 9:50
 */
@Service
@Slf4j
public class TestSpringRetryServiceImpl implements TestSpringRetryService {

    /**
     * 重试
     * <p>
     * value：抛出指定异常才会重试
     * include：和value一样，默认为空，当exclude也为空时，默认所有异常
     * exclude：指定不处理的异常
     * maxAttempts：最大重试次数，默认3次
     * backoff：重试等待策略，默认使用@Backoff，
     *
     * @Backoff的value默认为1000L，我们设置为2000L； multiplier（指定延迟倍数）默认为0，表示固定暂停1秒后进行重试，
     * 如果把multiplier设置为1.5，则第一次重试为2秒，第二次为3秒，第三次为4.5秒。
     * <p>
     * <p>
     * 当重试耗尽时还是失败，会出现什么情况呢？
     * <p>
     * 当重试耗尽时，RetryOperations可以将控制传递给另一个回调，
     * 即RecoveryCallback。Spring-Retry还提供了@Recover注解，
     * 用于@Retryable重试失败后处理方法。如果不需要回调方法，可以直接不写回调方法，
     * 那么实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常。
     */
    @Override
    @Retryable(value = Exception.class, maxAttempts = 3, backoff = @Backoff(delay = 2000, multiplier = 1.5))
    public int testRetry(int code) throws Exception {
        System.out.println("test被调用,时间：" + LocalTime.now());
        if (code == 0) {
            System.out.println("继续重试,此时Code为" + code);
            throw new Exception("情况不对头！");
        }
        System.out.println("test被调用,情况对头了！");
        return 200;
    }


    /**
     * 可以看到传参里面写的是 Exception e，
     * 这个是作为回调的接头暗号（重试次数用完了，还是失败，我们抛出这个Exception e通知触发这个回调方法）。
     * 对于@Recover注解的方法，需要特别注意的是：
     * <p>
     * 方法的返回值必须与@Retryable方法一致
     * 方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要哪个参数，写进去就可以了（@Recover方法中有的）
     * 该回调方法与重试方法写在同一个实现类里面
     */
    @Recover
    public int recover(Exception e, int code) {
        System.out.println("回调方法执行！！！！,此时异常为" + e.getMessage() + ",code为" + code);
        //记日志到数据库 或者调用其余的方法
        return 400;
    }
}

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 方法可以发现

可以看到传参里面写的是 Exception e，这个是作为回调的接头暗号（重试次数用完了，还是失败，我们抛出这个Exception e通知触发这个回调方法）。对于@Recover注解的方法，需要特别注意的是：
- 方法的返回值必须与@Retryable方法一致
  方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要哪个参数，写进去就可以了（@Recover方法中有的）
  该回调方法与重试方法写在同一个实现类里面