spring retry 配置及使用
接口或功能因外界异常导致失败后进行重推机制
依赖
<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.3.1.RELEASE</version></parent><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>
开始使用
@EnableRetry 启用注解
代码示例
@SpringBootApplication
@EnableRetry
public class SpringTestApp {public static void main(String[] args) {SpringApplication.run(SpringTestApp.class,args);}
}
业务注解
@Retryable 业务方法注解 @Recover 回调方法注解
代码示例
@Slf4j
@Service
public class IndexService {@Retryable(value = NullPointerException.class)public String request(){log.info("开始测试 {}",System.currentTimeMillis());String str = null;str.indexOf("a");return "null";}@Recover()public String callback(NullPointerException e){log.info("重试3次失败");throw e;}
}
注意
两个方法的返回值要一样,否则是不起作用的
NullPointerException 必须要将异常类型当作参数传入
如果不这样的话无法进行回调,当然不配置 @Recever 也可以,那就不会有回调处理了
写一个action 调用一下方法
@RestController
public class IndexAction {@Resourceprivate IndexService indexService;@GetMapping("test1")public String test1(){try {indexService.request();return "ok";}catch (Exception e){return e.getClass().getName() + e.getMessage();}}
}
输出结果
: 开始测试 1704852025819: 开始测试 1704852026824: 开始测试 1704852027833: 重试3次失败
以上最简单的使用方式就结束了,
如果不加任何配置默认会调用三次,每次间隔1s
注解源码
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Retryable {String interceptor() default "";Class<? extends Throwable>[] value() default {};指定异常类型Class<? extends Throwable>[] include() default {};多个异常类型Class<? extends Throwable>[] exclude() default {};多个异常类型String label() default "";boolean stateful() default false;int maxAttempts() default 3;最大重试次数String maxAttemptsExpression() default "";最大尝试次数 赋值后会覆盖 maxAttempts 可以使用SpEL表达式Backoff backoff() default @Backoff; 延迟时间String exceptionExpression() default "";String[] listeners() default {};
}
通过以上的方式就能简单的使用 retry了,只能对网络失败,或者对方接口异常进行重推,如果是参数问题,或者对方系统问题一直没有修复则不起作用
retry的介绍就到这里了,还有一些其他用法,可以自行查阅api或者找一些别的帖子,如果有需要可以留言,我再继续把其他示例补充上