Spring-Retry的使用以及踩坑

Spring-Retry的使用以及踩坑

1.使用场景：

由于网络波动或者其他原因,邮件发送失败,需要重新发送，重试次数两次。

为了简化重试开发代码,使用Spring的Retry的@Retryable实现方法重试。

2.示例

2.1引入依赖

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

2.2配置类

启用@EnabelRetry。在启动类上添加注解或者自己手动写一个配置类都可以，我是倾向于配置类的。

方案1：

@EnableRetry
@SpringBootApplication
public class HelloApplication {

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

方案2：

package com.hermes.config.retry;

import org.springframework.context.annotation.Configuration;
import org.springframework.retry.annotation.EnableRetry;

@Configuration
@EnableRetry
public class RetryConfig {
}

2.3在需要重试方法上加上@Retryable

import com.mail.elegant.service.TestRetryService;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;
import java.time.LocalTime;

@Service
public class TestRetryServiceImpl implements TestRetryService {

    @Override
    @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
    public int test(int code) throws Exception{
        System.out.println("test被调用,时间："+LocalTime.now());
          if (code==0){
              throw new Exception("情况不对头！");
          }
        System.out.println("test被调用,情况对头了！");

        return 200;
    }
}

2.4重试异常的回调函数

@Recover
public int recover(Exception e, int code){
   System.out.println("回调方法执行！！！！");
   //记日志到数据库 或者调用其余的方法
    return 400;
}

2.5测试结果:

3.参数解释及踩坑记录

注解@Retryable属性说明：

    value：抛出指定异常才会重试。
    maxAttempts：最大重试次数，默认为3次。如果第一次执行该方法异常,该异常触发重试，则还会重试两次(如果第二次成功了则只重新执行了一次),如果每次都异常,则一共会执行该方法三次。
    include：和value一样，默认为空，当exclude也为空时，所有异常都需要重试。
    exclude：指定不处理的异常，默认为空，当include也为空时，所有异常都需要重试。
    backoff：重试等待策略，默认使用@Backoff，@Backoff的value默认为1000L。

注解@Backoff属性说明：

    value：隔多少毫秒后再次重试，默认为1000L。
    delay：同value一样，默认为0,即立即重新执行。
    multiplier：指定延迟倍数，默认为0，如果delay=2000L，multiplier=2，则第一次重试为2秒，第二次为4秒，第三次为8秒……
    
注解@Recover说明：

@Retryable重试还是失败后的回调处理。

pring-Retry 还提供了 @Recover 注解，用于 @Retryable 重试失败后处理方法。如果不需要回调方法，可以直接不写回调方法，那么实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常。

对于 @Recover 注解的方法，需要特别注意的是：
1.法的返回值必须与 @Retryable 方法一致。否则是没法调用回调方法的。

2.异常类与@Retryable 配置的异常一致，其他的参数，需要哪个参数，写进去就可以了。也可以不需要任何参数。

3.回调方法与重试方法写在同一个实现类里面。

4.同一个实现类里面多个方法使用了@Retryable注解进行重试，并回调，则会出现一些问题：

	4.1.如果同一个类里面有多个@Retryable注解的重试方法，如果发生异常进行重试，最后调用的回调方法只会是同一个,那就是被@Recover标柱的recover()方法。

	4.2.如果同一个类里面有多个回调方法,recover()、recover1()、recover2(),则所有的重试方法最后调用的都是recover()方法。这个需要注意了，所以开发时候遵循单一原则,一个实现类负责单一的逻辑是比较合理的。

今天就先记录到这吧,有出入的欢迎留言改正！