Springboot插件開發(fā)實戰(zhàn)分享
一 背景
項目新增監(jiān)控系統(tǒng),對各個系統(tǒng)進行監(jiān)控接口調(diào)用情況,初期的時候是在各個項目公共引用的依賴包里面新增aop切面來完成對各個系統(tǒng)的接口調(diào)用進行監(jiān)控,但是這樣有缺點,一是不同項目的接口路徑不同,導致aop切面要寫多個切面路徑,二是一些不需要進行監(jiān)控的系統(tǒng),因為引入了公共包也被監(jiān)控了,這樣侵入性就太強了。為了解決這個問題,就可以通過springboot的可插拔屬性了。
二 監(jiān)控日志插件開發(fā)
1 新建aop切面執(zhí)行類MonitorLogInterceptor
@Slf4j
public class MonitorLogInterceptor extends MidExpandSpringMethodInterceptor<MonitorAspectAdviceProperties> {
@Override
public Object invoke(MethodInvocation methodInvocation) throws Throwable {
Object result = null;
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
//拿到請求的url
String requestURI = request.getRequestURI();
if (StringUtils.isEmpty(requestURI)) {
return result;
}
try {
result = methodInvocation.proceed();
} catch (Exception e) {
buildRecordData(methodInvocation, result, requestURI, e);
throw e;
}
//參數(shù)數(shù)組
buildRecordData(methodInvocation, result, requestURI, null);
return result;我們可以看到它實現(xiàn)了MidExpandSpringMethodInterceptor<T>
@Slf4j
public abstract class MidExpandSpringMethodInterceptor<T> implements MethodInterceptor {
@Setter
@Getter
protected T properties;
/**
* 主動注冊,生成AOP工廠類定義對象
*/
protected String getExpression() {
return null;
}
@SuppressWarnings({"unchecked"})
public AbstractBeanDefinition doInitiativeRegister(Properties properties) {
String expression = StringUtils.isNotBlank(this.getExpression()) ? this.getExpression() : properties.getProperty("expression");
if (StringUtils.isBlank(expression)) {
log.warn("中臺SpringAop插件 " + this.getClass().getSimpleName() + " 缺少對應的配置文件 或者 是配置的攔截路徑為空 導致初始化跳過");
return null;
}
BeanDefinitionBuilder definition = BeanDefinitionBuilder.genericBeanDefinition(AspectJExpressionPointcutAdvisor.class);
this.setProperties((T) JsonUtil.toBean(JsonUtil.toJson(properties), getProxyClassT()));
definition.addPropertyValue("advice", this);
definition.addPropertyValue("expression", expression);
return definition.getBeanDefinition();
}
/**
* 獲取代理類上的泛型T
* 單泛型 不支持多泛型嵌套
*/
private Class<?> getProxyClassT() {
Type genericSuperclass = this.getClass().getGenericSuperclass();
ParameterizedType parameterizedType = (ParameterizedType) genericSuperclass;
return (Class<?>) parameterizedType.getActualTypeArguments()[0];
}
}而最終是實現(xiàn)了MethodInterceptor,這個接口是 方法攔截器,用于Spring AOP編程中的動態(tài)代理.實現(xiàn)該接口可以對需要增強的方法進行增強.
我們注意到我的切面執(zhí)行類并沒有增加任何@Compont和@Service等將類注入到spring的bean中的方法,那他是怎么被注入到bean中的呢,因為使用了spi機制
SPI機制的實現(xiàn)在項目的資源文件目錄中,增加spring.factories文件,內(nèi)容為
com.dst.mid.common.expand.springaop.MidExpandSpringMethodInterceptor=\
com.dst.mid.monitor.intercept.MonitorLogInterceptor
這樣就可以在啟動過程直接被注冊,并且被放到spring容器中了。還有一個問題就是,切面執(zhí)行類有了,切面在哪里呢。
@Configuration
@Slf4j
@Import(MidExpandSpringAopAutoStarter.class)
public class MidExpandSpringAopAutoStarter implements ImportBeanDefinitionRegistrar {
private static final String BEAN_NAME_FORMAT = "%s%sAdvisor";
private static final String OS = "os.name";
private static final String WINDOWS = "WINDOWS";
@SneakyThrows
@SuppressWarnings({"rawtypes"})
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
// 1 獲取MidExpandSpringMethodInterceptor類的所有實現(xiàn)集合
List<MidExpandSpringMethodInterceptor> list = SpringFactoriesLoader.loadFactories(MidExpandSpringMethodInterceptor.class, null);
if (!CollectionUtils.isEmpty(list)) {
String expandPath;
Properties properties;
BeanDefinition beanDefinition;
// 2 遍歷類的所有實現(xiàn)集合
for (MidExpandSpringMethodInterceptor item : list) {
// 3 獲取資源文件名稱 資源文件中存儲需要加入配置的
expandPath = getExpandPath(item.getClass());
// 4 加載資源文件
properties = PropertiesLoaderUtils.loadAllProperties(expandPath + ".properties");
// 5 賦值beanDefinition為AspectJExpressionPointcutAdvisor
if (Objects.nonNull(beanDefinition = item.doInitiativeRegister(properties))) {
// 6 向容器中注冊類 注意這個beanname是不存在的,但是他賦值beanDefinition為AspectJExpressionPointcutAdvisor是動態(tài)代理動態(tài)生成代理類所以不會報錯
registry.registerBeanDefinition(String.format(BEAN_NAME_FORMAT, expandPath, item.getClass().getSimpleName()), beanDefinition);
}
}
}
}
/**
* 獲取資源文件名稱
*/
private static String getExpandPath(Class<?> clazz) {
String[] split = clazz.getProtectionDomain().getCodeSource().getLocation().getPath().split("/");
if (System.getProperty(OS).toUpperCase().contains(WINDOWS)) {
return split[split.length - 3];
} else {
return String.join("-", Arrays.asList(split[split.length - 1].split("-")).subList(0, 4));
}
}
}這個就是切面注冊類的處理,首先實現(xiàn)了ImportBeanDefinitionRegistrar,實現(xiàn)他的registerBeanDefinitions方法可以將想要注冊的類放入spring容器中,看下他的實現(xiàn)
- 1 獲取MidExpandSpringMethodInterceptor類的所有實現(xiàn)集合
- 2 遍歷類的所有實現(xiàn)集合
- 3 獲取資源文件名稱 資源文件中存儲需要加入配置的
- 4 加載資源文件
- 5 賦值beanDefinition為AspectJExpressionPointcutAdvisor
- 6 向容器中注冊類 注意這個beanname是不存在的,但是他賦值beanDefinition為AspectJExpressionPointcutAdvisor是動態(tài)代理動態(tài)生成代理類所以不會報錯
看到這里,還有一個問題ImportBeanDefinitionRegistrar實際上是將類注冊到容器中,但是還需要一個步驟就是他要被容器掃描才行,以往的方式是項目中通過路徑掃描,但是我們是插件,不能依賴于項目,而是通過自己的方式處理,這時候就需要用@Import(MidExpandSpringAopAutoStarter.class)來處理了。
通過以上處理就實現(xiàn)了監(jiān)控插件的處理,然后再使用時,只需要將這個項目引入到不同需要監(jiān)控的項目上就可以了。
三 總結(jié)
開發(fā)一個插件可以降低代碼的侵入性,過程中我們不能用以前@Component等注解來掃描而是要通過一些spring暴露的其他來處理,所以開發(fā)一個插件對個人的提升還是蠻大的,希望對大家有所幫助。
到此這篇關于Springboot插件開發(fā)實戰(zhàn)分享的文章就介紹到這了,更多相關Springboot插件 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
java.net.ConnectException異常的正確解決方法(親測有效!)
java.net.ConnectException異常是與網(wǎng)絡相關的最常見的Java異常之一,建立從客戶端應用程序到服務器的TCP連接時,我們可能會遇到它,這篇文章主要給大家介紹了關于java.net.ConnectException異常的正確解決方法,需要的朋友可以參考下2024-01-01
Java并發(fā)編程創(chuàng)建并運行線程的方法對比
這篇文章主要為大家詳細介紹了Java并發(fā)編程創(chuàng)建并運行線程的方法,文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助2022-03-03
Java中數(shù)組array和列表list相互轉(zhuǎn)換
這篇文章主要介紹了Java中數(shù)組array和列表list相互轉(zhuǎn)換,在Java中,可以將數(shù)組(array)和列表(list)相互轉(zhuǎn)換,但需要注意一些細節(jié)和限制,本文通過實例代碼給大家介紹的非常詳細,需要的朋友可以參考下2023-09-09
SpringBoot整合Ehcache3的實現(xiàn)步驟
本文主要介紹了SpringBoot整合Ehcache3的實現(xiàn)步驟,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2022-01-01

