Spring-Retry（重试机制）

Spring-Retry（重试机制）

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

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

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

一、@Retryable是什么？

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

二、使用步骤

1.POM依赖

基于AOP实现,因此还需引入aop相关的依赖

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

2.启用@Retryable

@EnableRetry
@SpringBootApplication
public class HelloApplication {

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

}

3.在方法上添加@Retryable

1.创建测试controller

    @GetMapping(value = "/retry")
    @ApiOperation(value = "重试测试")
    public int retry() {
        return testServiceImpl.testRetry(1000);
    }

2.创建service实现类并添加@Retryable

package com.kkd.web.admin.service.impl;

import cn.hutool.json.JSONUtil;
import com.alibaba.fastjson2.JSON;
import com.kkd.common.model.exception.ServiceException;
import org.jetbrains.annotations.NotNull;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

/**
 * @beLongProjecet: kkd-all
 * @beLongPackage: com.kkd.web.admin.service
 * @author: XXY
 * @createTime: 2024/09/21 16:25
 * @description:
 * @version: v1.0
 */
@Service
public class TestServiceImpl {

    int count = 0;

     /**
     * value：抛出指定异常才会重试
     * include：和value一样，默认为空，当exclude也为空时，默认所有异常
     * exclude：指定不处理的异常
     * maxAttempts：最大重试次数，默认3次;如果设置为2,那么方法在抛出异常之后,retry会执行一次
     * backoff：重试等待策略，
     * 默认使用@Backoff，@Backoff的value默认为1000L，我们设置为2000； 以毫秒为单位的延迟（默认 1000）
     * multiplier（指定延迟倍数）默认为0，表示固定暂停**秒后进行重试，如果把multiplier设置为2，则第一次重试间隔为1500=1.5秒，第二次间隔为1500*2=3秒，第三次为1500*2*2=6秒,重置延迟不超过10秒
     * @Retryable(value = BizException.class, maxAttempts = 3,backoff= @Backoff(value = 1500, maxDelay = 10000, multiplier = 2))
     * listeners是开发自定义的一个bean,用于处理方法运行时异常问题的单独处理
     */
    @Retryable(value = {Exception.class}, maxAttempts = 2,listeners = "retryListenerEvent",recover = "recover")
    public int testRetry(Integer a) {
        System.out.println("test被调用,count："+ count);
        count++;
        if (count < 3) {
            throw new ServiceException("出异常了");
        }
        return 200;
    }

	/**
     * Spring-Retry还提供了@Recover注解，用于@Retryable重试失败后处理方法。
     * 如果不需要回调方法，可以直接不写回调方法，那么实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常。
     * 可以看到传参里面写的是 Exception e，这个是作为回调的接头暗号（重试次数用完了，还是失败，我们抛出这个Exception e通知触发这个回调方法）。
     * 注意事项：
     * 方法的返回值必须与@Retryable方法一致
     * 方法的第一个参数，必须是Throwable类型的，建议是与@Retryable配置的异常一致，其他的参数，需要哪个参数，写进去就可以了（@Recover方法中有的）
     * 该回调方法与重试方法写在同一个实现类里面
     *
     * 由于是基于AOP实现，所以不支持类里自调用方法
     * 如果重试失败需要给@Recover注解的方法做后续处理，那这个重试的方法不能有返回值，只能是void
     * 方法内不能使用try catch，只能往外抛异常
     * @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中)，此注解注释的方法参数一定要是@Retryable抛出的异常，否则无法识别，可以在该方法中进行日志处理
    @Recover
    public int recover(Exception e,Object object){
        System.out.println("回调方法执行！！！！");
        //记日志到数据库 或者调用其余的方法
        System.out.println("参数....:{}"+ JSON.toJSONString(object));
        throw new ServiceException(e.getMessage());
    }

}

@Retryable(value = BizException.class, maxAttempts = 3,backoff= @Backoff(value = 1500, maxDelay = 10000, multiplier = 2))

在 `@Retryable` 注解中，backoff 参数用于配置重试之间的等待策略。以下是你提到的 @Backoff 参数的解释：

1. value (或 delay):
   - 初始等待时间，单位为毫秒。在这里设置为 `1500` 毫秒，即每次重试的初始延迟为 1.5 秒。

2. maxDelay:
   - 重试之间的最大等待时间，单位为毫秒。在这里设置为 `10000` 毫秒，即延迟不会超过 10 秒。

3. multiplier:
   - 用于指数增长的乘数。设置为 `2`，意味着每次重试的等待时间会翻倍（在不超过最大延迟的情况下）。

示例解释

- 第一次重试后等待 1500 毫秒。
- 第二次重试后等待 3000 毫秒（1500 * 2）。
- 第三次重试后等待 6000 毫秒（3000 * 2）。

重试机制最多尝试 3 次，并遵循上述退避策略

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

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

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

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

这里定义一个公共的recover方法

    @Recover
    public int recover(Exception e,Object object){
        System.out.println("回调方法执行！！！！");
        //记日志到数据库 或者调用其余的方法
        System.out.println("参数....:{}"+ JSON.toJSONString(object));
        throw new ServiceException(e.getMessage());
    }

4.listeners配置bean(可以重写父类中的所有方法,按照自己的需求自定义)

参考这个:Spring 接口重试机制之listeners参数

package com.kkd.web.admin.model.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.listener.RetryListenerSupport;
import org.springframework.stereotype.Component;

/**
 * @beLongProjecet: kkd-all
 * @beLongPackage: com.kkd.web.admin.service.impl
 * @author: XXY
 * @createTime: 2024/09/21 17:05
 * @description:
 * @version: v1.0
 */
@Slf4j
@Component
public class RetryListenerEvent extends RetryListenerSupport {

    @Override
    public <T, E extends Throwable> void onError(RetryContext context, RetryCallback<T, E> callback,
                                                 Throwable throwable) {
        log.error("retry error, errorCount:{}, throwable:{}, callback:{}", context.getRetryCount(), throwable.getMessage(), callback);
    }

}

Spring-Retry（重试机制）