文章目录
实现思路
- 这里使用
FutureTask
,它通过get
方法以阻塞的方式获取执行结果,并设定超时时间:
java
public V get() throws InterruptedException, ExecutionException ;
public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException ;
- 利用spring aop解耦业务
- 定义业务异常信息
实现代码
定义注解:
java
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD})
public @interface TimeoutCheck {
/**
* 超时时间,默认5秒
*/
long timeout() default 5L;
/**
* 超时单位,默认秒
*/
TimeUnit unit() default TimeUnit.SECONDS;
/**
* 超时后是否销毁线程
*/
boolean destroy() default true;
}
这里有一个destroy()
的方法,因为我们在执行时开独立线程处理,所以这个方法是为了在超时后,用来判断是否销毁还在执行的线程;
定义异常:
注意:这里的父类应该是项目中的基础业务异常类;
java
public class TimeoutCheckException extends RuntimeException{
public TimeoutCheckException(String message) {
super(message);
}
public TimeoutCheckException(String message, Throwable throwable) {
super(message, throwable);
}
}
再顺便定义一个属性配置:
这个的作用是全局控制开关,当不需要的时候可以直接通过配置关闭;
java
@Component
@ConfigurationProperties(prefix = "aliweb.timeout")
public class TimeoutCheckProperties {
private boolean enable = true;
public boolean isEnable() {
return enable;
}
public void setEnable(boolean enable) {
this.enable = enable;
}
}
最后就是我们的aop类:
java
@Aspect
@Component
public class TimeoutAop {
private static final Logger logger = LoggerFactory.getLogger(TimeoutAop.class);
@Autowired
private TimeoutCheckProperties timeoutCheckProperties;
@Pointcut("@annotation(timeoutCheck)")
public void pointCut(TimeoutCheck timeoutCheck) {
}
@Around(value = "pointCut(timeoutCheck)", argNames = "joinPoint, timeoutCheck")
public Object around(ProceedingJoinPoint joinPoint, TimeoutCheck timeoutCheck) throws Throwable {
if (!timeoutCheckProperties.isEnable()) {
return joinPoint.proceed();
}
long timeout = timeoutCheck.timeout();
if (timeout <= 0) {
throw new TimeoutCheckException("业务逻辑执行时间不能小于等于0");
}
long start = System.currentTimeMillis();
String msg = null;
Exception error = null;
Object data = null;
FutureTask<Object> futureTask = createTask(joinPoint);
try {
Thread thread = new Thread(futureTask);
thread.start();
data = futureTask.get(timeout, timeoutCheck.unit());
} catch (InterruptedException e) {
msg = "执行中断";
error = e;
} catch (ExecutionException e) {
msg = "执行异常";
error = e;
} catch (TimeoutException e) {
msg = "执行超时";
error = e;
} finally {
futureTask.cancel(timeoutCheck.destroy());
}
logger.debug("执行时间:{}", System.currentTimeMillis() - start);
if (error != null) {
String suf = error.getMessage() == null ? "" : ":" + error.getMessage();
logger.error(msg + suf, error);
throw new TimeoutCheckException(msg + suf, error);
}
return data;
}
private static FutureTask<Object> createTask(ProceedingJoinPoint joinPoint) {
return new FutureTask<>(() -> {
try {
return joinPoint.proceed();
} catch (Throwable e) {
throw new RuntimeException(e);
}
});
}
}
starter组件
将功能提取成starter
组件:
- 定义配置类
java
@Configuration
@ComponentScan("com.liry.aliweb.timeout")
public class TimeoutCheckAutoConfig {
}
-
定义配置扫描文件
spring.factories
,路径:src/main/resources/META-INF/spring.factories
propertiesorg.springframework.boot.autoconfigure.EnableAutoConfiguration=com.liry.aliweb.timeout.config.TimeoutCheckAutoConfig
-
pom增加依赖:
xml<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> </dependency>
如上,在主项目引入时就可以直接使用了