5分钟学会！Spring-Retry 框架实战经典重试场景（客栈模拟）

前言

今天分享干货，控制了篇幅，5分钟内就能看完学会。

主题是Spring-retry框架的应用，做了一个很清晰的案例，代码可下载自测。

框架介绍

Spring-Retry框架是Spring自带的功能，具备间隔重试、包含异常、排除异常、控制重试频率等特点，是项目开发中很实用的一种框架。

本篇所用框架的版本如下：

技术	版本
java	17
SpringBoot	3.2
Spring-retry	2.0.4

正文1、引入依赖

坑点：需要引入AOP，否则会抛异常。

 <dependency> <groupId>org.springframework.retry</groupId> <artifactId>spring-retry</artifactId> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>2、启动类注解

坑点：很容易一时疏忽忘记启动类开启@EnableRetry，大家别忘了哦。

import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.retry.annotation.EnableRetry; @SpringBootApplication @EnableRetry public class SpringRetryDemoApplication { public static void main(String[] args) { SpringApplication.run(SpringRetryDemoApplication.class, args); } }3、模拟发短信

我们模拟一个发短信功能，根据随机数分别作为成功、失败、抛出各种异常的入口。
这里抛出几种异常的目的，是为了后面演示出重试注解参数产生的效果。

import cn.hutool.core.util.RandomUtil; import lombok.extern.slf4j.Slf4j; /** * <p> * 短信服务工具类 * </p> * * @author 程序员济癫 * @since 2023-12-21 09:40 */ @Slf4j public class SmsUtil { /** * 发送短信 */ public static boolean sendSms() { // 使用随机数模拟重试场景 int num = RandomUtil.randomInt(4); log.info("[SmsUtil][sendSms]>>>> random num = {}", num); return switch (num) { case 0 -> // 模拟发生参数异常 throw new IllegalArgumentException("参数有误！"); case 1 -> // 模拟发生数组越界异常 throw new ArrayIndexOutOfBoundsException("数组越界！"); case 2 -> // 模拟成功 true; case 3 -> // 模拟发生空指针界异常 throw new NullPointerException(); default -> // 未成功则返回false false; }; } }4、Retry应用

我们单独写一个用于重试调用的组件类，用于业务类调用。

import com.example.springretrydemo.util.SmsUtil; import lombok.extern.slf4j.Slf4j; import org.springframework.retry.annotation.Backoff; import org.springframework.retry.annotation.Recover; import org.springframework.retry.annotation.Retryable; import org.springframework.stereotype.Component; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; /** * <p> * 重试组件 * </p> * * @author 程序员济癫 * @since 2023-12-21 09:43 */ @Slf4j @Component public class RetryComponent { /** * 重试机制发送短信 */ @Retryable( retryFor = {IllegalArgumentException.class, ArrayIndexOutOfBoundsException.class}, noRetryFor = {NullPointerException.class}, maxAttempts = 4, backoff = @Backoff(delay = 2000L, multiplier = 2) ) public boolean sendSmsRetry() { log.info("[RetryComponent][sendSmsRetry]>>>> 当前时间：{}", getNowTime()); return SmsUtil.sendSms(); } /** * 兜底方法，规则： * 1、超出了最大重试次数； * 2、抛出了不进行重试的异常； */ @Recover public boolean recover() { log.info("[RetryComponent][recover]>>>> 短信发送次数过多，请稍后重试！"); return false; } /** * 获取当前时间 */ private String getNowTime() { return LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss")); } }

@Retryable注解参数说明：

retryFor：此参数包含的异常会触发重试机制，多个异常则以数组形式定义。
noRetryFor：此参数包含的异常不会触发重试机制，多个异常则以数组形式定义。
maxAttempts：重试最大次数，不定义则默认3次。
backoff：定义补偿机制，delay-延迟时间(s)，multiplier-重试时间的倍数(比如设置为2，重试4次的话，补偿机制就是分别间隔2s、4s、8s做重试)

@Recover注解说明：用于兜底，当超出了最大重试次数或抛出了不进行重试的异常时，直接执行该注解声明的兜底方法。

PS：顺便提一句，如果是 SpringBoot2.x 的版本，这里@Retryable注解的retryFor参数对应的是include，noRetryFor参数对应的是exclude，可以直接点进去看源码便一目了然。

5、junitTest测试

我们编写一个Junit测试类来测试重试的效果，并打印出结果信息。

import com.example.springretrydemo.retry.RetryComponent; import lombok.extern.slf4j.Slf4j; import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.test.context.SpringBootTest; @Slf4j @SpringBootTest class SpringRetryDemoApplicationTests { @Autowired private RetryComponent retryComponent; @Test void sendSmsTest() { boolean ret = retryComponent.sendSmsRetry(); log.info("sendSmsTest result = {}", ret); } }6、效果