spring-retry框架使用说明

一时失言乱红尘 2022-11-17 05:24 210阅读 0赞

spring-retry技术是spring框架中的调用重试技术实现，通过retry技术，可以对当前调用失败的请求重新发起重试机制，重试成功即返回，若继续失败，是否再次重试依代码配置决定。

## 示例工程 ##

示例中，使用三个工程

*  eureka注册中心
 *  retry-client 消费方，发起请求调用
 *  retry-server 服务方，提供服务

### retry-client工程 ###

代码结构

![20210408221554888.JPG][]

其中 RetryClientApplication.java 为工程启动类

Controller.java 请求入口类

@RestController
    public class Controller {
    
    	@Autowired
    	private HelloService helloService;
    	
    	@GetMapping("/hello")
    	public String hello() {
    		return helloService.hello();
    	}
    }

HelloService.java 服务实现类

@EnableFeignClients("com.retry.feign")
    @Service
    public class HelloService {
    
    	@Autowired
    	FeignService feignService;
    	
    	public String hello() { 
    		DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    		System.out.println("调用远程服务开始：" + df.format(new Date()));
    		return feignService.hello();
    	}
    	
    }

FeignService.java 外调feign接口类

@FeignClient("retry-server")
    public interface FeignService {
     
    	@GetMapping("/hi")
    	String hello();
    	
    }

其中调用关系，Controller -> HelloService -> FeignService

### retry-server工程 ###

### ![20210408222053169.JPG][] ###

其中 RetryServerApplication.java 为工程启动类

HiController.java 为请求入口，实现一个hello方法

@RestController
    public class HiController {
    
    	@GetMapping("/hi")
    	public String hello() {
    		return "I am feign-provider";
    	}
    }

依次启动注册中心，retry-client和retry-server，在浏览器输入 [http://localhost:5000/hello][http_localhost_5000_hello] 可以正常请求到retry-server提供的服务

![20210408224150184.JPG][]

## 改造注解说明 ##

retry重试改造时，对要发起重试的客户端工程进行改造，对应到上面的例子，就是retry-client工程，retry-server工程为服务提供方，不须要改造。

增加pom.xml依赖

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

改造主要有三点：

*  启动入口类增加重试注解@EnableRetry
 *  要重试的方法上增加@Retryable重试参数配置注解
 *  重试方法类中增加异常处理注解@Recover及其对应方法

### @EnableRetry注解 ###

@EnableRetry注解表示开启retry重试功能，通常该注解配置在工程启动类上面

/**
    	 * Indicate whether subclass-based (CGLIB) proxies are to be created as opposed to
    	 * standard Java interface-based proxies. The default is {@code false}.
    	 * @return whether to proxy or not to proxy the class
    	 */
    	boolean proxyTargetClass() default false;

EnableRetry注解中有一个属性proxyTargetClass，表示是否使用cglib进行动态代理，默认值为false，表示使用java默认的代理技术。

@EnableRetry
    @EnableEurekaClient
    @SpringBootApplication
    public class RetryClientApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(RetryClientApplication.class, args);
    	}
    
    }

### @Retryable注解 ###

@Retryable注解标注在须要重试的方法上面，配置重试的次数，

public @interface Retryable {
    
    	/**
    	 * 定义一个recover方法，用于进行调用异常时程序恢复. 
    	 * 该方法必须使用@Recover注解进行标记
    	 * @return the name of recover method
    	 */
    	String recover() default "";
    
    	/**
    	 * 要应用于可重试方法的重试侦听器bean名称。
         * 与其他属性互斥。 
    	 * @return the retry interceptor bean name
    	 */
    	String interceptor() default "";
    
    	/**
    	 * 可重试的异常类型。includes()方法的同义词。
    	 * 默认为空（如果excludes也为空，则重试所有异常）
    	 * @return exception types to retry
    	 */
    	Class<? extends Throwable>[] value() default {};
    
    	/**
    	 * 可重试的异常类型。
    	 * 默认为空（如果excludes也为空，重试所有异常）。 
    	 * @return exception types to retry
    	 */
    	Class<? extends Throwable>[] include() default {};
    
    	/**
    	 * 不可重试的异常类型。默认为空（如果include也为空，则重试所有异常）。 
    	 * 如果includes为空，但excludes不是，则重试所有未排除的异常
    	 * @return exception types not to retry
    	 */
    	Class<? extends Throwable>[] exclude() default {};
    
    	/**
    	 * 统计报告的独特标签。
    	 * 如果没有提供，调用者可以选择忽略它，或者提供默认值
    	 * @return the label for the statistics
    	 */
    	String label() default "";
    
    	/**
    	 * 表示重试是有状态的标志：即重新抛出异常，
         * 但使用相同的策略将重试策略应用于具有相同参数的后续调用。
         * 如果为false，则不会重新抛出可重试异常
    	 * @return true if retry is stateful, default false
    	 */
    	boolean stateful() default false;
    
    	/**
    	 * 重试的最大次数 (包含第一次失败的尝试), 默认值为3
    	 */
    	int maxAttempts() default 3;
    
    	/**
    	 * @return 计算最大尝试次数的表达式 (包含第一次失败的场景),
    	 * 默认为 3 覆盖maxAttempts()
    	 * @since 1.2
    	 */
    	String maxAttemptsExpression() default "";
    
    	/**
    	 * 指定用于重试此操作的退避属性. 默认值是一个简单的没有属性规则@Backoff注解
    	 * 可以在文档查看默认信息
    	 * @return a backoff specification
    	 */
    	Backoff backoff() default @Backoff();
    
    	/**
    	 * 指定要在SimpleRetryPolicy.canRetry()返回true-可以有条件地用于取消重试。
    	 * 仅在引发异常后调用。根对象是Throwable 
    	 * 上下文的其它bean可以引用到
    	 * @return the expression.
    	 * @since 1.2
    	 */
    	String exceptionExpression() default "";
    
    	/**
    	 * 要使用的重试侦听器的Bean名称，而不是Spring中定义的默认侦听器上下文
    	 * @return retry listeners bean names
    	 */
    	String[] listeners() default {};
    
    }

@Retryable注解中一堆的属性方法，挑几个主要的来看

*  value：抛出指定异常才会重试，默认为空
 *  include：和value一样，默认为空，当exclude也为空时，默认所以异常
 *  exclude：指定不处理的异常
 *  maxAttempts：最大重试次数，默认3次
 *  backoff：@Backoff注解，重试等待策略

@Backoff注解内容信息

/**
     * 收集BackOffPolicy的元数据。属性信息：
     *
     * <ul>
     * <li>在没有显式设置的情况下，默认的延迟是固定的1000ms</li>
     * <li>只有设置delay属性后:延迟设置的这个固定值</li>
     * <li>当设置delay属性和maxDelay属性时，延迟在这两个值之间均匀分布</li>
     * <li>当设置delay属性,maxDelay属性和multiplier属性时，延迟会以指数形式增长到最大值</li>
     * <li>另外，如果设置了random属性，则选择乘数对于[1，乘数-1]中均匀分布的每个延迟</li>
     * </ul>
     *
     */
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Backoff {
    
    	/**
    	 * 与delay属性同一个意思。当delay属性设置非零时value属性的值忽略掉；
    	 * 否则 取value属性默认值1000，即1000毫秒
    	 * @return the delay in milliseconds (默认为1000)
    	 */
    	long value() default 1000;
    
    	/**
    	 * 一个典型的延迟周期. 指数情况下用作初始值, 在均匀的情况下用作最小值. 
         * 当delay值设置为0时，读取value值, 否则读取delay值并忽略value值
    	 * @return the initial or canonical backoff period in milliseconds (默认为0)
    	 */
    	long delay() default 0;
    
    	/**
    	 * 重试之间的最大等待(毫秒数). 如果该值小于delay值，则
    	 * 应用ExponentialBackOffPolicy.DEFAULT_MAX_INTERVAL属性值
    	 * DEFAULT_MAX_INTERVAL 值为30000L 
    	 * @return 数次颜值之间最大间隔 (该属性值默认为0 = 忽略该属性)
    	 */
    	long maxDelay() default 0;
    
    	/**
    	 * 如果值为正数, 则作为一个乘数来计算下一个延迟间隔.
    	 * @return 一个计算下一个延迟间隔的乘数 (默认为0 = 忽略该属性)
    	 */
    	double multiplier() default 0;
    
    	/**
    	 * 经典的延迟计算表达式. 指数场景下用作初始值，
    	 * 均匀情况下用作最小值. 该属性重写delay属性
    	 * @return the initial or canonical backoff period in milliseconds.
    	 * @since 1.2
    	 */
    	String delayExpression() default "";
    
    	/**
    	 * 经典的最大延迟间隔表达式，间隔单位为毫秒数.
    	 * 如果该值小于delay属性值，
         * 则取默认的ExponentialBackOffPolicy#DEFAULT_MAX_INTERVAL属性值，30000L
    	 * 该属性重写maxDelay属性
    	 * @return the maximum delay between retries (默认为0 = 忽略该属性)
    	 * @since 1.2
    	 */
    	String maxDelayExpression() default "";
    
    	/**
    	 * 计算为用作生成下一个重试间隔的乘数的值
    	 * 该属性重写multiplier
    	 * @return 乘数表达式，用作计算下一个延迟间隔 (默认为0 = 忽略该属性)
    	 * @since 1.2
    	 */
    	String multiplierExpression() default "";
    
    	/**
    	 * 在指数情况下（multiplier大于0）将其设置为true
    	 * 使延迟间隔随机化, 因此最大延迟是前一个延迟的倍数
    	 * 并且两个延迟值之间的分布是均匀的.
    	 * @return the flag to signal randomization is required (default false)
    	 */
    	boolean random() default false;
    
    }

Backoff注解中属性大致总结如下

*  value为默认的延迟属性 1000毫秒
 *  delay、maxDelay、multiplier 设置延迟间隔，默认情况下都为0忽略该属性
 *  delayExpression、maxDelayExpression、multiplierExpression 设置延迟间隔表达式，默认为空，指在重写对应的delay、maxDelay、multiplier属性值
 *  random 随机的延迟间隔，默认为false

### @Recover ###

@Recover  
   当重试次数耗尽依然出现异常时，执行此异常对应的@Recover方法。  
   异常类型需要与Recover方法参数类型保持一致，  
   recover方法返回值需要与重试方法返回值保证一致

## 工程改造测试 ##

### 工程代码改造 ###

对应上面改造注解说明

改造点一，启动类增加@EnableRetry注解，我们增加到retry-client启动类RetryClientApplication.java 上

改造点二，给重试方法增加@Retryable注解属性信息，我们增加到调用外部接口的方法HelloService.hello( ）方法上

@Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000, multiplier = 1.5))
    	public String hello() { 
    		DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    		System.out.println("调用远程服务开始：" + df.format(new Date()));
    		return feignService.hello();
    	}

value = Exception.class 捕获所有的异常信息

maxAttempts = 3，设置重试次数为3，这里的3次包含原本的第一次调用，即第一次若失败后，最多重试两次

backoff 设置@Backoff注解，delay属性设置2000，延迟2000毫秒，multiplier 以1.5倍时间间隔增加

改造点三，增加@Recover注解的异常处理方法

@Recover
    	public String recover(Exception e){
    	    System.out.println("远程调用失败 " + e.getStackTrace());
    	    //记日志到数据库
    	    return "服务暂时修复中，请稍后再试";
    	}

我们测试工程，打印一个调用失败的日志，同时，给前端一个返回，因为hello()方法返回值为String，所以对应recover方法返回值须要为String。

### 启动测试 ###

**第一次测试**

为了测试重试，在启动服务的时候，先不启动retry-server服务，先启动注册中心和retry-client服务，浏览器测试调用 [http://localhost:5000/hello][http_localhost_5000_hello]

查看retry-client日志信息

调用远程服务开始：2021-04-09 11:11:42
    调用远程服务开始：2021-04-09 11:11:56
    调用远程服务开始：2021-04-09 11:11:59
    远程调用失败 [Ljava.lang.StackTraceElement;@52b6ee76

第一次调用在11分42秒，第一次调用失败后

第二次调用在11分56秒，第二次调用失败后

第三次调用在11分59秒，这里的59和56间隔3秒为2000毫秒 \* 1.5 = 3秒

三次调用失败后，输出打印日志，“远程调用失败”。同时，页面返回recover方法return信息

![20210409111729872.JPG][]

**第二次测试**

将@Retryable中maxAttempts 修改为4，继续沿用上面测试方法测试

调用远程服务开始：2021-04-09 11:21:29
    调用远程服务开始：2021-04-09 11:21:42
    调用远程服务开始：2021-04-09 11:21:45
    调用远程服务开始：2021-04-09 11:21:50
    远程调用失败 [Ljava.lang.StackTraceElement;@1cba9ee8

上面间隔时间如下

第二次调用和第三次调用之间 延迟间隔时间42到45间隔3秒 = 2000 \* 1.5

第三次调用和第四次调用之间 延迟间隔时间45到50间隔5秒 = 2000 \* 1.5 \* 1.5

**第三次测试**

继续沿用前面配置，在重试过程中启动retry-server服务

查看retry-client日志，调用三次远程服务，即第一次失败后重试了两次，没有进行第三次重试，说明两次调用成功了

调用远程服务开始：2021-04-09 11:25:59
    调用远程服务开始：2021-04-09 11:26:13
    调用远程服务开始：2021-04-09 11:26:16

查看浏览器端

![20210409112827614.JPG][]

重试间隔的配置策略比较多，这里就做如上简单配置示例，更多的配置策略说明欢迎交流学习。完整工程代码示例，链接 [retry-demo.rar][]

[20210408221554888.JPG]: /images/20221022/50fa022d567c423fb7c377f9679bcd26.png
[20210408222053169.JPG]: /images/20221022/1b541183295a46e089e7a88cb26d6e9d.png
[http_localhost_5000_hello]: http://localhost:5000/hello
[20210408224150184.JPG]: /images/20221022/2b707e2337bd41b08f4d85e47f40bfdd.png
[20210409111729872.JPG]: /images/20221022/2cb7d1b1010b42efac912b7585f33d4e.png
[20210409112827614.JPG]: /images/20221022/4900e89aa66e4f65a9c3c2dc7a2d962b.png
[retry-demo.rar]: https://download.csdn.net/download/magi1201/16589756