SpringBoot实战教程（3.1）——失败重试机制

约定不等于承诺〃 2024-04-19 13:32 32阅读 0赞

## 一、Guava-Retry ##

*  Guava retryer工具与spring-retry类似，都是通过定义重试者角色来包装正常逻辑重试，但是Guava retryer有更优的策略定义，在支持重试次数和重试频度控制基础上，能够兼容支持多个异常或者自定义实体对象的重试源定义，让重试功能有更多的灵活性。
 *  Guava Retryer也是线程安全的，入口调用逻辑采用的是Java.util.concurrent.Callable的call方法

### 1.1 maven依赖 ###

<dependency>
            <groupId>com.github.rholder</groupId>
            <artifactId>guava-retrying</artifactId>
            <version>2.0.0</version>
        </dependency>

### 1.2 示例代码 ###

import com.github.rholder.retry.*;
    import com.google.common.base.Predicates;
    import com.pingan.lcloud.ark.log.LoggerUtil;
    import lombok.extern.slf4j.Slf4j;
    
    import java.util.concurrent.TimeUnit;
    
    /**
     * <code>Details determine success.</code>
     * by Liang ZC., Phd@Stanford
     *
     * @author LIANGZHICHENG
     * @date 2019-9-17 14:42
     * @see http://www.stanford.edu
     */
    public class TestRetry {
        /*
         *           N777777777NO
         *         N7777777777777N
         *        M777777777777777N
         *        *N877777777D77777M
         *       N M77777777ONND777M
         *       MN777777777NN  D777
         *     N7ZN777777777NN ~M7778
         *    N777777777777MMNN88777N
         *    N777777777777MNZZZ7777O
         *    DZN7777O77777777777777
         *     N7OONND7777777D77777N
         *      8*M++++?N???$77777$
         *       M7++++N+M77777777N
         *        N77O777777777777$                              M
         *          DNNM$$$$777777N                              D
         *         N*N:=N$777N7777M                             NZ
         *        77Z::::N777777777                          ODZZZ
         *       77N::::::N77777777M                         NNZZZ$
         *     $777:::::::77777777MN                        ZM8ZZZZZ
         *     777M::::::Z7777777Z77                        N++ZZZZNN
         *    7777M:::::M7777777$777M                       $++IZZZZM
         *   M777$:::::N777777*M7777M                       +++++ZZZDN
         *     NN$::::::7777$*M777777N                      N+++ZZZZNZ
         *       N::::::N:7*O:77777777                      N++++ZZZZN
         *       M::::::::::::N77777777+                   +?+++++ZZZM
         *       8::::::::::::D77777777M                    O+++++ZZ
         *        ::::::::::::M777777777N                      O+?D
         *        M:::::::::::M77777777778                     77=
         *        D=::::::::::N7777777777N                    777
         *       INN===::::::=77777777777N                  I777N
         *      ?777N========N7777777777787M               N7777
         *      77777*D======N77777777777N777N?         N777777
         *     I77777$$*N7===M$$77777777$77777777*MMZ77777777N
         *      $$$$$$$$$$*NIZN$$$$$$$$*M$$7777777777777777ON
         *       M$$$$$$$*M    M$$$$$$$*N=N$$$$7777777$$*ND
         *      O77Z$$$$$$$     M$$$$$$$*MNI==*DNNNNM=~N
         *   7 :N MNN$$$*M$      $$$777$8      8D8I
         *     NMM.:7O           777777778
         *                       7777777MN
         *                       M NO .7:
         *                       M   :   M
         *                            8
         */
    
        // Constant matcher factory methods
    
        private static class MyRetryListener implements RetryListener {
    
            public <V> void onRetry(Attempt<V> attempt) {
                StringBuilder result = new StringBuilder();
                result.append("[retry]time=" + attempt.getAttemptNumber());
    
                // 距离第一次重试的延迟
                result.append(",delay=" + attempt.getDelaySinceFirstAttempt());
                // 重试结果: 是异常终止, 还是正常返回
                result.append(",hasException=" + attempt.hasException());
                result.append(",hasResult=" + attempt.hasResult());
    
                // 是什么原因导致异常
                if (attempt.hasException()) {
                    result.append(",causeBy=" + attempt.getExceptionCause().toString());
                } else {
                    // 正常返回时的结果
                    result.append(",result=" + attempt.getResult());
                }
    
                System.out.println(result.toString());
            }
    
        }
    
        public static final Retryer retryer = RetryerBuilder.newBuilder()
                // 设置抛出异常重试
                .retryIfException()
                // 设置重试等待时间为固定5秒重试一次
                .withWaitStrategy(WaitStrategies.fixedWait(5, TimeUnit.SECONDS))
                // 设置尝试次数为3次
                .withStopStrategy(StopStrategies.stopAfterAttempt(3))
                // 设置监听类
                .withRetryListener(new MyRetryListener())
                .build();
    
    
        public static boolean run() {
            int a = 1 / 0;
            return false;
        }
    
        public static void main(String[] args) {
            try {
                retryer.call(() -> TestRetry.run());
            } catch (Exception e) {
                LoggerUtil.error("retry three time still error.", e);
            }
        }
    
    }

## 二、Spring-Retry ##

### 2.1 maven依赖 ###

<dependency>
        <groupId>org.springframework.retry</groupId>
        <artifactId>spring-retry</artifactId>
        <version>1.2.2.RELEASE</version>
     </dependency>
    
     <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.1</version>
     </dependency>

### 2.2 示例代码 ###

*  Application启动类上加上@EnableRetry的注解

@EnableRetry
    public class Application {
    	...
    }

import com.zgd.demo.thread.Application;
    import lombok.extern.slf4j.Slf4j;
    import org.junit.After;
    import org.junit.Before;
    import org.junit.runner.RunWith;
    import org.springframework.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(classes = Application.class)
    @Slf4j
    public class MyBaseTest {
        /*
         *           N777777777NO
         *         N7777777777777N
         *        M777777777777777N
         *        *N877777777D77777M
         *       N M77777777ONND777M
         *       MN777777777NN  D777
         *     N7ZN777777777NN ~M7778
         *    N777777777777MMNN88777N
         *    N777777777777MNZZZ7777O
         *    DZN7777O77777777777777
         *     N7OONND7777777D77777N
         *      8*M++++?N???$77777$
         *       M7++++N+M77777777N
         *        N77O777777777777$                              M
         *          DNNM$$$$777777N                              D
         *         N*N:=N$777N7777M                             NZ
         *        77Z::::N777777777                          ODZZZ
         *       77N::::::N77777777M                         NNZZZ$
         *     $777:::::::77777777MN                        ZM8ZZZZZ
         *     777M::::::Z7777777Z77                        N++ZZZZNN
         *    7777M:::::M7777777$777M                       $++IZZZZM
         *   M777$:::::N777777*M7777M                       +++++ZZZDN
         *     NN$::::::7777$*M777777N                      N+++ZZZZNZ
         *       N::::::N:7*O:77777777                      N++++ZZZZN
         *       M::::::::::::N77777777+                   +?+++++ZZZM
         *       8::::::::::::D77777777M                    O+++++ZZ
         *        ::::::::::::M777777777N                      O+?D
         *        M:::::::::::M77777777778                     77=
         *        D=::::::::::N7777777777N                    777
         *       INN===::::::=77777777777N                  I777N
         *      ?777N========N7777777777787M               N7777
         *      77777*D======N77777777777N777N?         N777777
         *     I77777$$*N7===M$$77777777$77777777*MMZ77777777N
         *      $$$$$$$$$$*NIZN$$$$$$$$*M$$7777777777777777ON
         *       M$$$$$$$*M    M$$$$$$$*N=N$$$$7777777$$*ND
         *      O77Z$$$$$$$     M$$$$$$$*MNI==*DNNNNM=~N
         *   7 :N MNN$$$*M$      $$$777$8      8D8I
         *     NMM.:7O           777777778
         *                       7777777MN
         *                       M NO .7:
         *                       M   :   M
         *                            8
         */
    
        // Constant matcher factory methods
    
      @Before
      public void init() {
        log.info("----------------测试开始---------------");
      }
    
      @After
      public void after() {
        log.info("----------------测试结束---------------");
      }
    
    }

import com.zgd.demo.thread.retry.RetryDemoTask;
    import com.zgd.demo.thread.test.MyBaseTest;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.remoting.RemoteAccessException;
    import org.springframework.retry.ExhaustedRetryException;
    import org.springframework.retry.annotation.Backoff;
    import org.springframework.retry.annotation.Recover;
    import org.springframework.retry.annotation.Retryable;
    import org.springframework.stereotype.Component;
    
    @Service
    @Slf4j
    public class SpringRetryDemo   {
        /*
         *           N777777777NO
         *         N7777777777777N
         *        M777777777777777N
         *        *N877777777D77777M
         *       N M77777777ONND777M
         *       MN777777777NN  D777
         *     N7ZN777777777NN ~M7778
         *    N777777777777MMNN88777N
         *    N777777777777MNZZZ7777O
         *    DZN7777O77777777777777
         *     N7OONND7777777D77777N
         *      8*M++++?N???$77777$
         *       M7++++N+M77777777N
         *        N77O777777777777$                              M
         *          DNNM$$$$777777N                              D
         *         N*N:=N$777N7777M                             NZ
         *        77Z::::N777777777                          ODZZZ
         *       77N::::::N77777777M                         NNZZZ$
         *     $777:::::::77777777MN                        ZM8ZZZZZ
         *     777M::::::Z7777777Z77                        N++ZZZZNN
         *    7777M:::::M7777777$777M                       $++IZZZZM
         *   M777$:::::N777777*M7777M                       +++++ZZZDN
         *     NN$::::::7777$*M777777N                      N+++ZZZZNZ
         *       N::::::N:7*O:77777777                      N++++ZZZZN
         *       M::::::::::::N77777777+                   +?+++++ZZZM
         *       8::::::::::::D77777777M                    O+++++ZZ
         *        ::::::::::::M777777777N                      O+?D
         *        M:::::::::::M77777777778                     77=
         *        D=::::::::::N7777777777N                    777
         *       INN===::::::=77777777777N                  I777N
         *      ?777N========N7777777777787M               N7777
         *      77777*D======N77777777777N777N?         N777777
         *     I77777$$*N7===M$$77777777$77777777*MMZ77777777N
         *      $$$$$$$$$$*NIZN$$$$$$$$*M$$7777777777777777ON
         *       M$$$$$$$*M    M$$$$$$$*N=N$$$$7777777$$*ND
         *      O77Z$$$$$$$     M$$$$$$$*MNI==*DNNNNM=~N
         *   7 :N MNN$$$*M$      $$$777$8      8D8I
         *     NMM.:7O           777777778
         *                       7777777MN
         *                       M NO .7:
         *                       M   :   M
         *                            8
         */
    
        // Constant matcher factory methods
        
     /**
       * 重试所调用方法
       * @param param
       * @return
       */
      @Retryable(value = {RemoteAccessException.class},maxAttempts = 3,backoff = @Backoff(delay = 2000L,multiplier = 2))
      public boolean call(String param){
          return RetryDemoTask.retryTask(param);
      }
    
      /**
       * 达到最大重试次数,或抛出了一个没有指定进行重试的异常
       * recover 机制
       * @param e 异常
       */
      @Recover
      public boolean recover(Exception e,String param) {
        log.error("达到最大重试次数,或抛出了一个没有指定进行重试的异常:",e);
        return false;
      }
    
    }

package com.zgd.demo.thread.retry;
    
    import lombok.extern.slf4j.Slf4j;
    import org.apache.commons.lang3.RandomUtils;
    import org.springframework.remoting.RemoteAccessException;
    
    @Slf4j
    public class RetryDemoTask {
      /**
       * 重试方法
       * @return
       */
      public static boolean retryTask(String param)  {
        log.info("收到请求参数:{}",param);
    
        int i = RandomUtils.nextInt(0,11);
        log.info("随机生成的数:{}",i);
        if (i == 0) {
          log.info("为0,抛出参数异常.");
          throw new IllegalArgumentException("参数异常");
        }else if (i  == 1){
          log.info("为1,返回true.");
          return true;
        }else if (i == 2){
          log.info("为2,返回false.");
          return false;
        }else{
          //为其他
            log.info("大于2,抛出自定义异常.");
            throw new RemoteAccessException("大于2,抛出远程访问异常");
          }
        }
    
    }

import com.zgd.demo.thread.test.MyBaseTest;
    import lombok.extern.slf4j.Slf4j;
    import org.junit.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Component;
    
    @Component
    @Slf4j
    public class SpringRetryDemoTest extends MyBaseTest {
        /*
         *           N777777777NO
         *         N7777777777777N
         *        M777777777777777N
         *        *N877777777D77777M
         *       N M77777777ONND777M
         *       MN777777777NN  D777
         *     N7ZN777777777NN ~M7778
         *    N777777777777MMNN88777N
         *    N777777777777MNZZZ7777O
         *    DZN7777O77777777777777
         *     N7OONND7777777D77777N
         *      8*M++++?N???$77777$
         *       M7++++N+M77777777N
         *        N77O777777777777$                              M
         *          DNNM$$$$777777N                              D
         *         N*N:=N$777N7777M                             NZ
         *        77Z::::N777777777                          ODZZZ
         *       77N::::::N77777777M                         NNZZZ$
         *     $777:::::::77777777MN                        ZM8ZZZZZ
         *     777M::::::Z7777777Z77                        N++ZZZZNN
         *    7777M:::::M7777777$777M                       $++IZZZZM
         *   M777$:::::N777777*M7777M                       +++++ZZZDN
         *     NN$::::::7777$*M777777N                      N+++ZZZZNZ
         *       N::::::N:7*O:77777777                      N++++ZZZZN
         *       M::::::::::::N77777777+                   +?+++++ZZZM
         *       8::::::::::::D77777777M                    O+++++ZZ
         *        ::::::::::::M777777777N                      O+?D
         *        M:::::::::::M77777777778                     77=
         *        D=::::::::::N7777777777N                    777
         *       INN===::::::=77777777777N                  I777N
         *      ?777N========N7777777777787M               N7777
         *      77777*D======N77777777777N777N?         N777777
         *     I77777$$*N7===M$$77777777$77777777*MMZ77777777N
         *      $$$$$$$$$$*NIZN$$$$$$$$*M$$7777777777777777ON
         *       M$$$$$$$*M    M$$$$$$$*N=N$$$$7777777$$*ND
         *      O77Z$$$$$$$     M$$$$$$$*MNI==*DNNNNM=~N
         *   7 :N MNN$$$*M$      $$$777$8      8D8I
         *     NMM.:7O           777777778
         *                       7777777MN
         *                       M NO .7:
         *                       M   :   M
         *                            8
         */
    
        // Constant matcher factory methods
        
      @Autowired
      private SpringRetryDemo springRetryDemo;
    
      @Test
      public void retry(){
        boolean abc = springRetryDemo.call("abc");
        log.info("--结果是:{}--",abc);
      }
    
    }

## 三、总结 ##

*  spring-retry 和 guava-retry 工具都是线程安全的重试，能够支持并发业务场景的重试逻辑正确性
 *  两者都很好的将正常方法和重试方法进行了解耦,可以设置超时时间,重试次数,间隔时间,监听结果,都是不错的框架
 *  guava-retry在使用上更便捷,更灵活,能根据方法返回值来判断是否重试,而Spring-retry只能根据抛出的异常来进行重试

> 关注我的技术公众号《漫谈人工智能》，每天推送优质文章
> 
> ![20190930002642724.jpg][]

[20190930002642724.jpg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/e21576bec1c24c91839c7f0a07374be8.jpg