Spring Retry重试机制怎么用？一文搞懂@Retryable与@Recover注解_Java

在分布式系统开发中，网络波动、服务暂时不可用等问题时有发生。

为了提高系统的健壮性，我们需要一种优雅的方式来处理这些临时性故障——这就是spring retry的作用！

什么是spring retry？

spring retry 是spring生态系统中的一个轻量级重试框架，它提供了声明式的重试机制，让开发者能够轻松地为方法添加重试逻辑，而无需编写复杂的重试代码。

1.核心注解介绍

1.1@retryable - 重试标记

@retryable(
    value = {exception.class},           // 指定需要重试的异常类型
    maxattempts = 3,                     // 最大重试次数(包括第一次调用)
    backoff = @backoff(delay = 1000)     // 重试间隔时间(ms)
)
public string callexternalservice() {
    // 业务逻辑
}

参数说明：

@retryable 参数详解

value/include: 需要重试的异常类型
exclude: 不需要重试的异常类型
maxattempts: 最大尝试次数，默认3次
backoff: 重试等待策略

@backoff 参数配置

delay: 固定延迟时间
multiplier: 延迟倍数（实现指数退避）
maxdelay: 最大延迟时间
random: 是否启用随机延迟

1.2@recover - 回退处理

当重试达到最大次数仍然失败时，可以通过 @recover 注解指定回退方法：

@recover
public string recover(exception ex) {
    return "服务调用失败，请稍后再试";
}

@retryable和@recover是spring framework中的注解，用于支持在方法执行期间发生异常时的重试和恢复操作。
@retryable注解用于标记方法，在方法执行期间发生异常时进行重试。重试行为可以使用spring retry框架提供的默认策略或自定义策略来定义。我们可以指定要重试的异常类型以及最大重试次数和重试间隔等参数。
@recover注解用于标记一个恢复方法，在最终重试失败后执行该方法，降级处理。恢复方法应尽量具有与重试方法相同的参数和返回类型（提一嘴：两个方法的返回值类型必须相同，捕获异常类型和入参可以不同，后面给出实例），并且应在同一类中声明。如果未指定恢复方法，则重试失败后将抛出最后一次异常。

2.实现步骤

2.1 先加依赖

<!--        重试机制的依赖-->
        <dependency>
            <groupid>org.springframework.retry</groupid>
            <artifactid>spring-retry</artifactid>
        </dependency>
<!--        以下依赖在重试机制中不加会报错-->
        <dependency>
            <groupid>org.aspectj</groupid>
            <artifactid>aspectjweaver</artifactid>
            <version>1.9.6</version>
        </dependency>

2.2 在项目启动类上加注解

3.3 使用

在需要重试的方法上加@retryable注解:

/**
 * @description: 测试重试接口实现类
 * @author yl
 * @date 2024/4/24 16:22
 */
@service
public class retryserviceimpl implements retryservice {

    private static final logger logger = loggerfactory.getlogger(retryserviceimpl.class);

    @autowired
    accountmapper mapper;


    /**
     *value：对方法中抛出什么样的异常进行重试机制
     *maxattempts：重试的次数
     * backoff：重试的策略：delay为相隔多少时间后重试
     */
    @override
    @retryable(value = businessexception.class,maxattempts = 3,backoff = @backoff(delay = 2000,multiplier = 1.5))
    public list<account> getallaccountlist() {
        list<account> list = mapper.selectall();
        vector<account> vector = new vector<>();
        logger.info("获取的数据为：{}",list);
        if(true){
            logger.info("获取的数据为：{}",list);
            throw new businessexception("开始重试了");
        }
        return list;
    }

    /**
     * 测试回复方法：@recover和@retryable在同一个类中
     * @param e 方法名。入参，和@retryable注解方法一致；此外方法中多一个入参为businessexception和@retryable注解的value值一致
     * @return 返回参数类型和@retryable注解方法返回类型一致
     */

    @recover
    public list<account> getallaccountlist(businessexception e) {
        logger.info("在recover方法内，做降级处理");
        list<account> list = new arraylist<>();
        return list;
    }
}