spring boot 插件,idea的springboot插件
目录
一背景二监控日志插件开发数字一(一)新建面向切面编程(面向方面的编程的缩写)切面执行类监控逻辑接收器三总结
一 背景
项目新增监控系统,对各个系统进行监控接口调用情况,初期的时候是在各个项目公共引用的依赖包里面新增面向切面编程(面向方面的编程的缩写)切面来完成对各个系统的接口调用进行监控,但是这样有缺点,一是不同项目的接口路径不同,导致面向切面编程(面向方面的编程的缩写)切面要写多个切面路径,二是一些不需要进行监控的系统,因为引入了公共包也被监控了,这样侵入性就太强了。为了解决这个问题,就可以通过跳羚的可插拔属性了。
二 监控日志插件开发
1 新建aop切面执行类MonitorLogInterceptor
@ SLF 4j公开课MonitorLogInterceptor扩展midexpandspringmethodinterceptormonitoraspectdaviceproperties { @ Override public Object invoke(方法调用方法调用)抛出throwable { Object result=null http servlet request request=((ServletRequestAttributes)requestcontextholder。getrequestattributes()).get request();//拿到请求的全球资源定位器(Uniform Resource Locator)字符串请求uri=请求。get request uri();if(字符串实用程序。isempty(请求uri)){返回结果;}尝试{ result=方法调用。proceed();} catch(Exception e){ buildRecordData(方法调用,结果,requestURI,e);扔e;} //参数数组buildRecordData(方法调用,结果,requestURI,null);返回结果;我们可以看到它实现了midexpandspringmethodinterreport
@Slf4jpublic抽象类midexpandspringmethodinterreport实现方法拦截器{ @ Setter @ Getter保护T属性;/** * 主动注册,生成面向切面编程工厂类定义对象*/protected String get expression(){返回null} @ suppress warnings({ unchecked })public abstract bean定义doinitiativregister(Properties Properties){ String expression=String utils。isnotblank(这个。get expression())?这个。获取expression():属性。getproperty( expression );if(字符串实用程序。为空(表达式)){ log。警告(中台解析插件this.getClass().getSimpleName()缺少对应的配置文件或者是配置的拦截路径为空导致初始化跳过);返回null} bean定义生成器定义=bean定义生成器。genericbean定义(aspectjexpressionpointcutadvisor。类);这个。设置属性((T)JSON实用程序。tobe an(JSON util。tojson(properties),getproxylast());定义
ion.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]; }}而最终是实现了MethodInterceptor,这个接口是 方法拦截器,用于Spring AOP编程中的动态代理.实现该接口可以对需要增强的方法进行增强.
我们注意到我的切面执行类并没有增加任何@Compont和@Service等将类注入到spring的bean中的方法,那他是怎么被注入到bean中的呢,因为使用了spi机制
SPI机制的实现在项目的资源文件目录中,增加spring.factories文件,内容为
com.dst.mid.common.expand.springaop.MidExpandSpringMethodInterceptor= com.dst.mid.monitor.intercept.MonitorLogInterceptor
这样就可以在启动过程直接被注册,并且被放到spring容器中了。还有一个问题就是,切面执行类有了,切面在哪里呢。
@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类的所有实现集合 List<MidExpandSpringMethodInterceptor> list = SpringFactoriesLoader.loadFactories(MidExpandSpringMethodInterceptor.class, null); if (!CollectionUtils.isEmpty(list)) { String expandPath; Properties properties; BeanDefinition beanDefinition; // 2 遍历类的所有实现集合 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是动态代理动态生成代理类所以不会报错 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)); } }}
这个就是切面注册类的处理,首先实现了ImportBeanDefinitionRegistrar
,实现他的registerBeanDefinitions
方法可以将想要注册的类放入spring容器中,看下他的实现
1 获取MidExpandSpringMethodInterceptor类的所有实现集合2 遍历类的所有实现集合3 获取资源文件名称 资源文件中存储需要加入配置的4 加载资源文件5 赋值beanDefinition为AspectJExpressionPointcutAdvisor6 向容器中注册类 注意这个beanname是不存在的,但是他赋值beanDefinition为AspectJExpressionPointcutAdvisor是动态代理动态生成代理类所以不会报错看到这里,还有一个问题ImportBeanDefinitionRegistrar
实际上是将类注册到容器中,但是还需要一个步骤就是他要被容器扫描才行,以往的方式是项目中通过路径扫描,但是我们是插件,不能依赖于项目,而是通过自己的方式处理,这时候就需要用@Import(MidExpandSpringAopAutoStarter.class)
来处理了。
通过以上处理就实现了监控插件的处理,然后再使用时,只需要将这个项目引入到不同需要监控的项目上就可以了。
三 总结
开发一个插件可以降低代码的侵入性,过程中我们不能用以前@Component等注解来扫描而是要通过一些spring暴露的其他来处理,所以开发一个插件对个人的提升还是蛮大的,希望对大家有所帮助。
到此这篇关于Springboot插件开发实战分享的文章就介绍到这了,更多相关Springboot插件 内容请搜索盛行IT以前的文章或继续浏览下面的相关文章希望大家以后多多支持盛行IT!
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。