Springboot插件开发实战分享

目录一 背景二 监控日志插件开发1 新建aop切面执行类MonitorLogInterceptor三 总结

一 背景

项目新增监控系统，对各个系统进行监控接口调用情况，初期的时候是在各个项目公共引用的依赖包里面新增aop切面来完成对各个系统的接口调用进行监控，但是这样有缺点，一是不同项目的接口路径不同，导致aop切面要写多个切面路径，二是一些不需要进行监控的系统，因为引入了公共包也被监控了，这样侵入性就太强了。为了解决这个问题，就可以通过springboot的可插拔属性了。

二 监控日志插件开http://发

1 新建aop切面执行类MonitorLogInterceptor

@Slf4j

public class MonitorLogInterceptor extends MidExpandSpringMethodInterceptor {

@Override

public Object invoke(MethodInvocation methodInvocation) throws Throwable {

Object result = null;

HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();

//拿到请求的url

http://String requestURI = request.getRequestURI();

if (StringUtils.isEmpty(requestURI)) {

return result;

}

try {

result = methodInvocation.proceed();

} catch (Exception e) {

buildRecordData(methodInvocation, result, requestURI, e);

throw e;

}

//参数数组

buildRecordData(methodInvocation, result, requestURI, null);

return result;

我们可以看到它实现了MidExpandSpringMethodInterceptor

@Slf4j

public abstract class MidExpandSpringMethodInterceptor implements MethodInterceptor {

@Setter

@Getter

protected T properties;

/**

* 主动注册，生成AOP工厂类定义对象

*/

protected String getExpression() {

return null;

}

@SuppressWarnings({"unchecked"})

public AbstractBeanDefinition doInitiativeRegister(Properties prLirbaDKWNoperties) {

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.addPropertyValuLirbaDKWNe("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 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暴露的其他来处理，所以开发一个插件对个人的提升还是蛮大的，希望对大家有所帮助。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。