SpringRetry重试机制（3秒上手）

淡淡的烟草味﹌ 2023-10-10 20:12 43阅读 0赞

#### 目录 ####

*  前言
 *  一、SpringRetry的使用
 *   *  1.1 引入依赖
     *  1.2 开启重新机制
     *  1.3 3 在方法上添加@Retryable
     *  1.3.4 编写重试失败后的执行的方法
     *  测试

## 前言 ##

SpringRetry重试机制在实际工作中的场景，比如:

*  发送消息失败，需要重新发送。
 *  调用远程服务失败，需要重新发送。

这些错误可能是因为网络波动造成的，等待过后重处理就能成功。spring-retry可以通过注解，在不入侵原有业务逻辑代码的方式下，优雅的实现重处理功能。

## 一、SpringRetry的使用 ##

### 1.1 引入依赖 ###

基于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>

### 1.2 开启重新机制 ###

springboot入口类添加注解 `@EnableRetry`  
![在这里插入图片描述][652ab75b84da437eaf87c6ba9c341239.png]

### 1.3 3 在方法上添加@Retryable ###

> @Retryable(value = Exception.class, maxAttempts = 3, backoff = @Backoff(delay = 1000, multiplier = 1))

参数的含义：

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

/**
         * value：抛出指定异常才会重试
         * include：和value一样，默认为空，当exclude也为空时，默认所有异常
         * exclude：指定不处理的异常
         * maxAttempts：最大重试次数，默认3次
         * backoff：重试等待策略，
         * 默认使用@Backoff，@Backoff的value默认为1000L，我们设置为2000； 以毫秒为单位的延迟（默认 1000）
         * multiplier（指定延迟倍数）默认为0，表示固定暂停1秒后进行重试，如果把multiplier设置为1.5，则第一次重试为2秒，第二次为3秒，第三次为4.5秒。
        
         */
    
    @Override
        @Retryable(value = Exception.class, maxAttempts = 3, backoff = @Backoff(delay = 1000, multiplier = 1))
        public String test(int n) {
        
            log.info("测试一下：{}",n);
            //模拟业务出错
            if(1==1 )throw  new RuntimeException("自定义异常");
            return "200";
        }

### 1.3.4 编写重试失败后的执行的方法 ###

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

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

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

### 测试 ###

![在这里插入图片描述][27bfaaf28d0d424faad269db2da12f32.png]

[652ab75b84da437eaf87c6ba9c341239.png]: https://img-blog.csdnimg.cn/652ab75b84da437eaf87c6ba9c341239.png
[27bfaaf28d0d424faad269db2da12f32.png]: https://img-blog.csdnimg.cn/27bfaaf28d0d424faad269db2da12f32.png