Spring Retry 代码片段

应用场景

有些场景需要我们对一些异常情况下的操作进行重试，使请求有可能成功，如果重试多次后还是没有成功，可考虑记录下来，通过其他方式处理，可能涉及的应用场景

• 电商系统中用户下单成功后，需要推送订单信息到企业内部的物流管理系统，如果一次推送失败，可多次尝试推送，不成功再记录下来，人工处理。
• 下发操作指令到终点设备，可能由于网络原因没能发送成功，可考虑失败后可多次重试。

用法

添加依赖

<!-- 重试机制 -->
<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>1.2.4.RELEASE</version>
</dependency>

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.4</version>
</dependency>

配置类或者启动类添加注解 @EnableRetry 启用重试功能

@EnableRetry
@Configuration
public class RetryConfiguration {

}

@RunWith(SpringRunner.class)
@SpringBootTest
@EnableRetry
public class DatasourceDemoApplicationTests {
....
}

Service方法编写

@Service
@Slf4j
public class RetryService {

    @Retryable(value = Exception.class, maxAttempts = 3, backoff = @Backoff(delay = 2000L, multiplier = 2))
    public void devide(double a, double b){
        log.info("开始进行除法运算");
        if (b == 0) {
            throw new RuntimeException();
        }
        log.info("{} / {} = {}", a, b, a / b);
    }
    
    @Recover
    public void recover() {
        log.error("被除数不能为0");
    }
}

相关配置说明

• @EnableRetry能否重试。当proxyTargetClass属性为true时，使用CGLIB代理。默认使用标准JAVA注解。在spring Boot中此参数写在程序入口即可。

• @Retryable 标注此注解的方法在发生异常时会进行重试

  • value：指定处理的异常类
  • include：指定处理的异常类和value一样，默认为空，当exclude也为空时，默认所有异常
  • exclude：指定异常不处理，默认空，当include也为空时，默认所有异常
  • maxAttempts：最大重试次数。默认3次
  • backoff： 重试等待策略。默认使用@Backoff注解

• @Backoff 重试等待策略

  • 不设置参数时，默认使用FixedBackOffPolicy（指定等待时间），重试等待1000ms
  • 设置delay,使用FixedBackOffPolicy（指定等待时间），重试等待填写的时间
  • 设置delay和maxDelay时，重试等待在这两个值之间均态分布
  • 设置delay、maxDelay、multiplier，使用 ExponentialBackOffPolicy（指数级重试间隔的实现 ），multiplier即指定延迟倍数，比如delay=5000l,multiplier=2,则第一次重试为5秒，第二次为10秒，第三次为20秒……

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

参考

• github.com/spring-proj…