spring aop實現(xiàn)接口超時處理組件的代碼詳解
更新時間：2024年02月05日 11:36:33 作者：用針戳左手中指指頭
這篇文章給大家介紹了spring aop實現(xiàn)接口超時處理組件,文中有詳細(xì)的實現(xiàn)思路,并通過代碼示例給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下
實現(xiàn)思路
- 這里使用
FutureTask，它通過get方法以阻塞的方式獲取執(zhí)行結(jié)果，并設(shè)定超時時間：
public V get() throws InterruptedException, ExecutionException ; public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException ;
- 利用spring aop解耦業(yè)務(wù)
- 定義業(yè)務(wù)異常信息
實現(xiàn)代碼
定義注解：
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD})
public @interface TimeoutCheck {
/**
* 超時時間，默認(rèn)5秒
*/
long timeout() default 5L;
/**
* 超時單位，默認(rèn)秒
*/
TimeUnit unit() default TimeUnit.SECONDS;
/**
* 超時后是否銷毀線程
*/
boolean destroy() default true;
}
這里有一個destroy()的方法，因為我們在執(zhí)行時開獨(dú)立線程處理，所以這個方法是為了在超時后，用來判斷是否銷毀還在執(zhí)行的線程；
定義異常：
注意：這里的父類應(yīng)該是項目中的基礎(chǔ)業(yè)務(wù)異常類；
public class TimeoutCheckException extends RuntimeException{
public TimeoutCheckException(String message) {
super(message);
}
public TimeoutCheckException(String message, Throwable throwable) {
super(message, throwable);
}
}
再順便定義一個屬性配置：
這個的作用是全局控制開關(guān)，當(dāng)不需要的時候可以直接通過配置關(guān)閉；
@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類：
@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("業(yè)務(wù)邏輯執(zhí)行時間不能小于等于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 = "執(zhí)行中斷";
error = e;
} catch (ExecutionException e) {
msg = "執(zhí)行異常";
error = e;
} catch (TimeoutException e) {
msg = "執(zhí)行超時";
error = e;
} finally {
futureTask.cancel(timeoutCheck.destroy());
}
logger.debug("執(zhí)行時間：{}", 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組件:
- 定義配置類
@Configuration
@ComponentScan("com.liry.aliweb.timeout")
public class TimeoutCheckAutoConfig {
}
- 定義配置掃描文件
spring.factories，路徑：
src/main/resources/META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.liry.aliweb.timeout.config.TimeoutCheckAutoConfig
- pom增加依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
</dependency>
如上，在主項目引入時就可以直接使用了
到此這篇關(guān)于spring aop實現(xiàn)接口超時處理組件的代碼詳解的文章就介紹到這了,更多相關(guān)spring aop接口超時處理組件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要為大家介紹了Flink狀態(tài)和容錯源碼示例解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-12-12
這篇文章主要介紹了Spring RestTemplate具體使用詳解，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-04-04
Maven是一個項目管理和自動構(gòu)建工具,clean命令用于刪除項目中由先前構(gòu)建生成的target目錄,install命令用于將打包好的jar包安裝到本地倉庫中,供其他項目依賴使用,下面就來詳細(xì)的介紹一下這兩個命令2024-09-09
這篇文章主要介紹了友盟 微信第三方登錄示例的相關(guān)資料,需要的朋友可以參考下2016-10-10
MyBatis-Flex實現(xiàn)多表聯(lián)查(自動映射)
我們可以輕松的使用 Mybaits-Flex 鏈接任何數(shù)據(jù)庫,本文主要介紹了MyBatis-Flex實現(xiàn)多表聯(lián)查(自動映射),具有一定的參考價值,感興趣的可以了解一下2024-06-06
這篇文章主要介紹了Maven 安裝目錄的詳細(xì)介紹的相關(guān)資料,這里對Maven進(jìn)行了解讀，希望通過本文可以幫助到大家，需要的朋友可以參考下2017-08-08
Java泛型(Generics)是JDK5開始引入的一個新特性，允許在定義類和接口的時候使用類型參數(shù)(Type Parameter)。下面是學(xué)習(xí)泛型的示例2014-04-04
SpringCloud使用Feign實現(xiàn)動態(tài)路由操作
這篇文章主要介紹了SpringCloud使用Feign實現(xiàn)動態(tài)路由操作，文章圍繞主題展開詳細(xì)的內(nèi)容介紹具有一定的參考價值，需要的小伙伴可以參考一下2022-06-06
ElasticSearch6.2.3+head插件安裝的方法步驟
這篇文章主要介紹了ElasticSearch6.2.3+head插件安裝的方法步驟，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-02-02
Java創(chuàng)建線程的七種方法總結(jié)(全網(wǎng)最全面)
線程是Java中的基本執(zhí)行單元,它允許程序在同一時間執(zhí)行多個任務(wù),下面這篇文章主要給大家總結(jié)介紹了關(guān)于Java創(chuàng)建線程的七種方法,文中通過實例代碼將這七種方法介紹的非常詳細(xì),需要的朋友可以參考下2023-05-05