异常重试框架Spring Retry实践

1. 前期准备

在Maven项目中添加Spring Retry和切面的依赖

POM：

        

        

            org.springframework.retry

            spring-retry

        

        

            org.aspectj

            aspectjweaver

        

1. 注解方式实践

Service类：@Retryable创建了一个最大重试次数为3，最初重试等待时间为5秒，重试等待时间倍率为1的接口；@Recover当@Retryable接口重试3次后依然不成功则会运行。

package com.jsoft.springboottest.springboottest1;
import java.time.LocalTime;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.remoting.RemoteAccessException;
import org.springframework.retry.annotation.Backoff;
import org.springframework.retry.annotation.Recover;
import org.springframework.retry.annotation.Retryable;
import org.springframework.stereotype.Service;

@Service
public class RemoteService {
    
    private final static Logger logger = LoggerFactory.getLogger(RemoteService.class);
    
    @Retryable(value = { RemoteAccessException.class }, maxAttempts = 3, backoff = @Backoff(delay = 5000l, multiplier = 1))
    public void call() throws Exception {
        logger.info(LocalTime.now()+" do something...");
        throw new RemoteAccessException("RPC调用异常");
    }

    @Recover
    public void recover(RemoteAccessException e) {
        logger.info(e.getMessage());
    }
}

Controller：创建一个调用重试接口的接口

package com.jsoft.springboottest.springboottest1.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.jsoft.springboottest.springboottest1.RemoteService;

@RestController
public class TestController {
    
    @Autowired
    private RemoteService remoteService;
    
    @RequestMapping("/show")
    public String show(){
        try {
            remoteService.call();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return "Hello World";        
    }
}

运行结果如下：

2018-11-07 17:01:55.463  INFO 8136 --- [nio-8080-exec-1] c.e.demo.service.impl.RetryServiceImpl   : 17:01:55.463 do something...

2018-11-07 17:02:00.463  INFO 8136 --- [nio-8080-exec-1] c.e.demo.service.impl.RetryServiceImpl   : 17:02:00.463 do something...

2018-11-07 17:02:05.463  INFO 8136 --- [nio-8080-exec-1] c.e.demo.service.impl.RetryServiceImpl   : 17:02:05.463 do something...

2018-11-07 17:02:05.464  INFO 8136 --- [nio-8080-exec-1] c.e.demo.service.impl.RetryServiceImpl   : RPC调用异常

注意：

1、使用了@Retryable的方法里面不能使用try...catch包裹，要在方法上抛出异常，不然不会触发。

2、在重试期间这个方法是同步的，如果使用类似Spring Cloud这种框架的熔断机制时，可以结合重试机制来重试后返回结果。

3、@Recover 用于@Retryable重试失败后处理方法，此注解注释的方法参数一定要是@Retryable抛出的异常，否则无法识别，可以在该方法中进行日志处理。

1. 注解简介

3.1  @Retryable注解

被注解的方法发生异常时会重试 

• value：指定发生的异常进行重试 
• include：和value一样，默认空，当exclude也为空时，所有异常都重试 
• exclude：指定异常不重试，默认空，当include也为空时，所有异常都重试 
• maxAttemps：重试次数，默认3 
• backoff：重试补偿机制，默认没有

3.2  @Backoff注解

• delay:指定延迟后重试 
• multiplier:指定延迟的倍数，默认为1。比如delay=5000l,multiplier=2时，第一次重试为5秒后，第二次为5*2=10秒，第三次为5*2*2=20秒

3.3  @Recover 

当重试到达指定次数时，被注解的方法将被回调，可以在该方法中进行日志处理。需要注意的是发生的异常和入参类型一致时才会回调。

 

3.4 @EnableRetry

开启重试。

1. 非注解方式实践

Spring Retry不只能注入方式去实现，还可以通过API的方式实现，类似熔断处理的机制就基于API方式实现会比较宽松。

代码如上面所示，只需要修改Service中的API。

public void test() {

    final RetryTemplate retryTemplate = new RetryTemplate();

    final SimpleRetryPolicy policy = new SimpleRetryPolicy(3, Collections., Boolean>  singletonMap(Exception.class, true));

    ExponentialBackOffPolicy ePolicy = new ExponentialBackOffPolicy();

    ePolicy.setMultiplier(2);//等待时间倍率

    ePolicy.setInitialInterval(2000l);//重试间隔时间，2秒

    ePolicy.setMaxInterval(30 * 60 * 1000l);//最大重试间隔时间为30分钟

    retryTemplate.setRetryPolicy(policy);

    retryTemplate.setBackOffPolicy(ePolicy);

    final RetryCallback retryCallback = new RetryCallback() {

        public Object doWithRetry(RetryContext context) throws Exception {

            logger.info(LocalTime.now() + "do some thing,第" + context.getRetryCount() + "次重试");
                //设置context一些属性,给RecoveryCallback传递一些属性
                context.setAttribute("key1", "value1");
                throw new Exception("RPC调用异常");        }

    };



    // 如果RetryCallback执行出现指定异常, 并且超过最大重试次数依旧出现指定异常的话,就执行RecoveryCallback动作

    final RecoveryCallback