spring 通过注解实现重试的解决方法
通常来说,我们会用try/catch
,while
循环之类的语法来进行重处理,但是这样的做法缺乏统一性,并且不是很方便,要多写很多代码。
而spring-retry
可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。spring-retry
是spring系列的另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。在spring-retry
中,所有配置都是基于简单注释的。
1. 使用方法
1. POM依赖
<dependency>
<groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId>
</dependency>
2. 在代码中启动@Retryable
@EnableRetry
@SpringBootApplication
public class HelloApplication {
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}
}
3. 在方法上添加@Retryable
和 @Recover
package com.example.demo.retry;
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;
/**
*`spring-retry`可以通过注解,在不入侵原有业务逻辑代码的方式下,优雅的实现重处理功能。
* `spring-retry`是spring系列的另一个实用程序模块,可以帮助我们以标准方式处理任何特定操作的重试。
* 在`spring-retry`中,所有配置都是基于简单注释的。
*/
@Service
public class TestRetryServiceImlp implements TestRetryService{
/**
* - value:抛出指定异常才会重试
* - include:和value一样,默认为空,当exclude也为空时,默认所有异常
* - exclude:指定不处理的异常
* - maxAttempts:最大重试次数,默认3次
* - backoff:重试等待策略,默认使用@Backoff,@Backoff的value默认为1000L,我们设置为2000L;
* multiplier(指定延迟倍数)默认为0,表示固定暂停1秒后进行重试,如果把multiplier设置为1.5,则第一次重试为2秒,第二次为3秒,第三次为4.5秒。
* @param code
* @return
* @throws Exception
*/
@Override
@Retryable(value = Exception.class,maxAttempts = 3,backoff = @Backoff(delay = 2000,multiplier = 1.5))
public int test(int code) throws Exception{
System.out.println("test被调用,时间:"+ LocalTime.now());
if (code==0){
throw new Exception("情况不对头!");
}
System.out.println("test被调用,情况对头了!");
return 200;
}
/**
* 当重试耗尽时,RetryOperations可以将控制传递给另一个回调,即RecoveryCallback。
* Spring-Retry还提供了@Recover注解,用于@Retryable重试失败后处理方法。
* 如果不需要回调方法,可以直接不写回调方法,那么实现的效果是,重试次数完了后,如果还是没成功没符合业务判断,就抛出异常。
* - 方法的返回值必须与@Retryable方法一致
* - 方法的第一个参数,必须是Throwable类型的,建议是与@Retryable配置的异常一致,其他的参数,需要哪个参数,写进去就可以了(@Recover方法中有的)
* - 该回调方法与重试方法写在同一个实现类里面
* @param e
* @param code
* @return
*/
@Recover
public int recover(Exception e, int code){
System.out.println("回调方法执行!!!!");
//记日志到数据库 或者调用其余的方法
return 400;
}
}
2.注意事项
- 由于是基于AOP实现,所以不支持类里自调用方法
- 如果重试失败需要给@Recover注解的方法做后续处理,那这个重试的方法不能有返回值,只能是void
- 方法内不能使用try catch,只能往外抛异常
- @Recover注解来开启重试失败后调用的方法(注意,需跟重处理方法在同一个类中),此注解注释的方法参数一定要是@Retryable抛出的异常,否则无法识别,可以在该方法中进行日志处理。
参考资料:
一个注解优雅的实现循环重试功能
版权声明:本文为qq_34182808原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。