download:挪动互联网高级开发正式课 VIP 课程 - 码牛第二期
一个 Java 注解 @Recover 搞定俊俏的循环重试代码
使用背景
在实际我的项目中其中一部分逻辑可能会因为调用了内部服务或者等待锁等情况下出现不可预料的异样,在这个时候咱们可能需要对调用这部分逻辑进行重试,代码外面次要就是使用 for 循环写一大坨重试的逻辑,各种硬编码,各种辣眼睛的补丁。
特地是针对重试的逻辑,到处都有。所以我决定用一个重试组件 spring-retry 优化一波。它的出现,解决掉这部分俊俏的代码!
2 开始上代码
首先引入依赖:
org.springframework.retry
spring-retry
1.3.2
复制代码
因为该组件是依赖于 AOP 给你的,所以还需要引入这个依赖(如果你其余 jar 包中引用过了,当然也就不需要再次引用了):
org.springframework.boot
spring-boot-starter-aop
2.6.1
复制代码
开启重试:
@SpringBootApplication
@EnableRetry
public class ApplicationStarter {
public static void main(String[] args) {
SpringApplication.run(ApplicationStarter.class);
}
}
复制代码
Controller 层
@RestController
public class TestController {
@Autowired
private IRecursiveCallService recursiveCallService;
@GetMapping("test2")
public Object test2() {return recursiveCallService.testService();
}
}
复制代码
Service 层
public interface IRecursiveCallService {
/**
* 测试 service
*
* @return
*/
List testService();
}
复制代码
Service 层具体实现
@Service
public class RecursiveCallServiceImpl implements IRecursiveCallService {
@Override
@Retryable(recover = "testService3")
public List testService() {System.out.println("到此一游!");
System.out.println(1 / 0);
return null;
}
@Recover
public List testService1() {System.out.println("谬误的返回");
return Collections.singletonList("S");
}
@Recover
public List testService2(String i) {System.out.println("正确的返回");
return Collections.singletonList(1);
}
@Recover
public List testService3() {System.out.println("正确的返回 2");
return Collections.singletonList(2);
}
}
- `recover`: 此类中用于复原的方法的名称。方法必须用 {@link Recover} 正文标记。- `value`: 可重试的异样类型。包含()的同义词。默认为空(如果 excludes 也为空,则重试所有异样)。- `exclude`: 不可重试的异样类型。默认为空(如果蕴含也为空,则重试所有异样)。如果 include 为空但 excludes 不是,则重试所有未排除的异样
- `maxAttempts`: 方法重试调用次数,默认 3 次
- `backoff`: 指定用于重试此操作的其余属性
## 4@backoff 注解
- `value`:重试之间间隔工夫
- `delay`:重试之间的等待工夫(以毫秒为单位)
- `maxDelay`:重试之间的最大等待工夫(以毫秒为单位)
- `multiplier`:指定提早的倍数
- `delayExpression`:重试之间的等待工夫表达式
- `maxDelayExpression`:重试之间的最大等待工夫表达式
- `multiplierExpression`:指定提早的倍数表达式
- `random`:随机指定延迟时间
## 5@Recover 注解
次要作用是标记方法为一个重试方法的弥补方法!!!## 6 注意事项
- 方法重试依赖于 spring 注入,所以调用的方法的类必须是被 spring 治理的,而后通过 @Autowired 或 @Resource 引入使用,不然不会失效
- 方法重试的前提是方法抛出了异样,在方法执行出现了异样且没有被捕捉的情况下重试
- 方法重试需要在方法下面加上注解 @Retryable
- 方法重试的弥补方法下面必须携带 @Recover 注解
- @Recover 方法需要和 @Retryable 方法在同一个类中才能失效 @Recover 方法(@Recover 方法在父类中也可能失效)
- 使用 @Retryable 注解,如果类中没有被 @Recover 标示的方法,无论是否使用 recover 属性都抛出原有异样
- 使用 @Retryable 注解同时 recover 属性不是空,如果类中有 @Recover 标示的方法,然而标示的方法不是 recover 指定的方法,抛出 ExhaustedRetryException 异样
- 使用 @Retryable 注解同时 recover 属性不是空,同时方法有注解 @Recover,然而弥补方法的参数不是以后异样或者异样的父类,抛出 ExhaustedRetryException 异样
- 使用 @Retryable 注解不使用 recover 属性,如果类中被 @Recover 标示的方法有和原方法返回值一样的,使用以后被 @Recover 标示的方法