Spring Boot中一个注解优雅实现重试

绝地灬酷狼 2023-09-26 23:08 45阅读 0赞

重试，在项目需求中是非常常见的，例如遇到网络波动等，要求某个接口或者是方法可以最多/最少调用几次；实现重试机制，非得用Retry这个重试框架吗？那肯定不是，相信很多伙伴手写一下控制流程的逻辑也可以达到重试的目的。

**那么用Retry的好处是什么？简单来说，就是优雅。**

Retry重试框架，支持AOP切入的方式使用，而且能使用注解；想想，重试次数、重试延迟、重试触发条件、重试的回调方法等等我们都能很轻松结合注解以一种类似配置参数的方式去实现，优雅无疑。

那么，我们接下来就来一起使用Springboot整合这个Retry重试框架：

首先是pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.6.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.mail</groupId>
        <artifactId>elegant</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>elegant</name>
        <description>Demo project for Spring Boot</description>
     
        <properties>
            <java.version>1.8</java.version>
        </properties>
     
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
     
            <dependency>
                <groupId>org.springframework.retry</groupId>
                <artifactId>spring-retry</artifactId>
            </dependency>
     
            <dependency>
                <groupId>org.aspectj</groupId >
                <artifactId>aspectjweaver</artifactId >
                <version>1.6.11</version >
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
     
        </dependencies>
     
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
     
    </project>

然后创建一个测试重试的`TestRetryService.java`：

/**
     * @Author : JCccc
     * @Description :
     **/
    public interface TestRetryService {
     
     
        int dignifiedTest(int code) throws Exception;
    }

然后是`TestRetryServiceImpl.java`：

import com.mail.elegant.service.TestRetryService;
    import org.springframework.retry.annotation.Backoff;
    import org.springframework.retry.annotation.Recover;
    import org.springframework.retry.annotation.Retryable;
    import org.springframework.stereotype.Service;
    import java.time.LocalTime;
     
    /**
     * @Author : JCccc
     * @Description :
     **/
    @Service
    public class TestRetryServiceImpl implements TestRetryService {
     
     
        @Override
        @Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
        public int dignifiedTest(int code) throws Exception{
            System.out.println("dignifiedTest被调用,时间："+LocalTime.now());
              if (code==0){
                  throw new Exception("情况不对头！");
              }
            System.out.println("dignifiedTest被调用,情况对头了！");
     
            return 200;
        }
     
        @Recover
        public int recover(Exception e){
            System.out.println("回调方法执行！！！！");
            //记日志到数据库 或者调用其余的方法
            return 400;
        }
     
    }

到这里，已经整合完毕，最后剩下测试了，在测试前，我们先一起来看看代码里面的关键信息的意义：

可以看到代码里面，这个方法上面加上了注解 ，

@Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5,maxDelay=360000L))

*  **@Retryable**：注解方式标记当前方法会使用重试机制
 *  **里面的 value**：重试的触发机制，当遇到Exception异常的时候，触发；
 *  **maxAttempts**：重试的次数（包括第一次调用，也就是说如果设置3次，调用一次后，如果一直失败触发重试，那么还当前方法还会调用2次）；
 *  **delay**：重试的延迟时间，也就是距离上一次重试方法调用的间隔，单位毫秒
 *  **multiplier**：delay间隔时间的倍数，也就是说，第一次重试间隔如果是2000ms，那第二次重试的时候就是2000ms 乘以这个倍数1.5，就是3000ms；
 *  **maxDelay**:重试次数之间的最大时间间隔,默认为0,即忽略,如果小于delay的设置,则默认为30000L；

再来看下面的这个小方法：

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

这个方法用到了`@Recover`，也就是用注解方式标记当期方法为回调方法，可以看到传参里面写的是`Exception e`，这个是作为回调的接头暗号（重试次数用完了，还是失败，我们抛出这个`Exception e`通知触发这个回调方法）。

> PS：该回调方法与重试方法写在同一个实现类里面。

然后在启动类加上开启重试注解：

@EnableRetry

好了，基本简单讲解完毕，接下来测试看看什么效果，

创建一个`TestController.java`，写过简单的测试方法：

import com.mail.elegant.service.TestRetryService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
     
    /**
     * @Author : JCccc
     * @Description :
     **/
    @RestController
    public class TestController {
     
        @Autowired
        TestRetryService testRetryServiceImpl;
     
        @GetMapping("/testRetry")
        public String testRetry() throws Exception {
            int code=0;
     
            int result = testRetryServiceImpl.dignifiedTest(code);
            return "result："+result;
        }
     
    }

我们这个测试模拟的场景是，传值code，一直是0；然后业务方法判断如果是0，代表业务不通，失败（网络波动了或者是等等），然后就是触发重试，最后如果重试几次都不成功，然后调用回调方法（可以进行日志记录或者调用其他业务方法等等）。

我们调用接口看看效果：

![2a62080ab9ced0f839e823bcb9205d3c.png][]

接口返回了400，是回调方法返回的：

![820f9ffd964443702cb7669fc0dc2063.png][]

看看控制台输出情况：

![d8d81709fb530b840c866dffaed1a911.png][]

OK，到此，重试整合及测试已经完毕。

> ps：如果不需要回调方法，可以直接不写回调方法，那么实现的效果是，重试次数完了后，如果还是没成功没符合业务判断，就抛出异常

[2a62080ab9ced0f839e823bcb9205d3c.png]: https://img-blog.csdnimg.cn/img_convert/2a62080ab9ced0f839e823bcb9205d3c.png
[820f9ffd964443702cb7669fc0dc2063.png]: https://img-blog.csdnimg.cn/img_convert/820f9ffd964443702cb7669fc0dc2063.png
[d8d81709fb530b840c866dffaed1a911.png]: https://img-blog.csdnimg.cn/img_convert/d8d81709fb530b840c866dffaed1a911.png