广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Springboot插件开发实战分享
  • 157
分享到

Springboot插件开发实战分享

2024-04-02 19:04:59 157人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

目录一 背景二 监控日志插件开发1 新建aop切面执行类MonitorLogInterceptor三 总结一 背景 项目新增监控系统,对各个系统进行监控接口调用情况,初期的时候是在各

一 背景

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

二 监控日志插件开发

1 新建aop切面执行类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;
       }
       //参数数组
       buildRecordData(methodInvocation, result, requestURI, null);
       return result;

我们可以看到它实现了MidExpandSpringMethodInterceptor<T>

@Slf4j
public abstract class MidExpandSpringMethodInterceptor<T> implements MethodInterceptor {
    @Setter
    @Getter
    protected T properties;
    
    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();
    }
    
    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为AspectJExpressionPointcutAdvisor
  • 6 向容器中注册类 注意这个beanname是不存在的,但是他赋值beanDefinition为AspectJExpressionPointcutAdvisor是动态代理动态生成代理类所以不会报错

看到这里,还有一个问题ImportBeanDefinitionRegistrar实际上是将类注册到容器中,但是还需要一个步骤就是他要被容器扫描才行,以往的方式是项目中通过路径扫描,但是我们是插件,不能依赖于项目,而是通过自己的方式处理,这时候就需要用@Import(MidExpandSpringAopAutoStarter.class)来处理了。

通过以上处理就实现了监控插件的处理,然后再使用时,只需要将这个项目引入到不同需要监控的项目上就可以了。

三 总结

开发一个插件可以降低代码的侵入性,过程中我们不能用以前@Component等注解来扫描而是要通过一些spring暴露的其他来处理,所以开发一个插件对个人的提升还是蛮大的,希望对大家有所帮助。

到此这篇关于Springboot插件开发实战分享的文章就介绍到这了,更多相关Springboot插件 内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: Springboot插件开发实战分享

本文链接: https://www.lsjlt.com/news/149628.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Springboot插件开发实战分享
    目录一 背景二 监控日志插件开发1 新建aop切面执行类MonitorLogInterceptor三 总结一 背景 项目新增监控系统,对各个系统进行监控接口调用情况,初期的时候是在各...
    99+
    2022-11-13
  • Springboot插件如何开发
    本篇内容主要讲解“Springboot插件如何开发”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Springboot插件如何开发”吧!一 背景项目新增监控系统,对各个系统进行监控接口调用情况,初...
    99+
    2023-06-30
  • Springboot插件怎么开发
    本篇内容主要讲解“Springboot插件怎么开发”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Springboot插件怎么开发”吧!一 背景项目新增监控系统,对各个系统进行监控接口调用情况,初...
    99+
    2023-07-06
  • 【由浅入深】vue组件库实战开发总结分享
    很庆幸标题能够赶上2022结束的脚步。本文由浅入深层层递进,对组件库的开发过程做个了小结。由于篇幅有限,阴影部分的内容将在中/下篇介绍。话不多说,直入主题。yarn workspace + lerna: 管理组件库及其生态项目考虑到组件库整...
    99+
    2023-05-14
    Vue.js Vite 前端
  • Git多人协作开发实战经验分享
    在当今互联网时代,软件开发已经成为了一个非常重要的行业。而在软件开发过程中,多人协作是非常常见的一种工作方式。为了更好地协作开发,维护代码的版本,很多开发者选择使用Git作为版本控制工具。本文将分享一些Git多人协作开发的实战经验,希望对读...
    99+
    2023-11-03
    实战经验分享 Git协作 多人开发
  • Git开发实战:项目经验分享与总结
    Git是一款分布式版本控制系统,广泛应用于软件开发领域。在实际的项目开发中,合理利用Git进行团队协作和版本管理,能够极大地提高开发效率和项目质量。本文将分享我在Git开发中的实战经验,并总结一些注意事项和技巧,希望对读者有所启发和帮助。一...
    99+
    2023-11-04
    开发 git 实战
  • 为Stable Diffusion web UI开发自己的插件实战
    最近,Stable Diffusion AI绘画受到了广泛的关注和热捧。它的Web UI提供了了一系列强大的功能,其中特别值得一提的是对插件的支持,尤其是Controlnet插件的加持,让它的受欢迎程度不断攀升。那么,如果你有出色的创意,如...
    99+
    2023-09-16
    stable diffusion
  • C#MSN插件开发实例分析
    这篇文章主要介绍“C#MSN插件开发实例分析”,在日常操作中,相信很多人在C#MSN插件开发实例分析问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”C#MSN插件开发实例分析”的疑惑有所帮助!接下来,请跟着小编...
    99+
    2023-06-17
  • Git多人协作开发技巧实战经验分享
    Git多人协作开发技巧实战经验分享在软件开发领域中,多人协作开发是一项非常重要的工作。而Git作为目前最流行的版本控制系统,成为了多人协作开发的首选工具。在使用Git进行多人协作开发时,合理的分支管理、团队配合和冲突解决都是关键。在本文中,...
    99+
    2023-11-02
    经验分享 Git协作 多人开发
  • 实战经验分享:高效开发Go语言项目
    在当今软件开发领域,Go语言逐渐成为了许多开发者的首选语言。它以其简洁、高效和强大的特性受到了广泛的赞誉。在实际的项目开发过程中,如何高效地开发Go语言项目成为了每个开发者都需要面对的问题。本文将分享一些实战经验,帮助读者更好地开发Go语言...
    99+
    2023-11-02
    Go语言 实战经验 高效开发
  • SpringBoot开发实战之自动配置
    在介绍SpringBoot的自动配置之前,先了解下注解@Import的使用,SpringBoot的@Enable*开头的注解底层依赖于@Import注解导入一些类,使用@Import...
    99+
    2022-11-12
  • SpringBoot实现邮件发送功能的姿势分享
    目录前言I. 项目环境1. 项目依赖2. 配置II. 邮件发送1. 简单文本邮件发送2. html发送3. 添加附件4. Freemaker模板5. 测试与小结III. 不能错过的源...
    99+
    2022-11-12
  • SpringBoot开发实战系列之定时器
    前言 定时器功能在项目里面往往会用到,比如定时发送邮件、定时释放数据库资源;这里记录一下springboot对定时器的支持的简单实例 cron表达式 开始之前要先介绍一下cron表...
    99+
    2022-11-12
  • Python开发之迭代器&生成器的实战案例分享
    目录迭代器&生成器实战案例迭代器&生成器 在 Python 中,迭代器和生成器都是用来遍历数据集合的工具,可以按需逐个生成或返回数据,从而避免一次性加载整个数据集合所...
    99+
    2023-05-16
    Python迭代器 生成器开发 Python迭代器 生成器 Python迭代器 Python生成器
  • 使用JQuery实现的分页插件分享
    JQuery分页插件是一种非常常用的工具,可以帮助开发人员快速实现网页中的分页功能。以下是一个使用JQuery实现的分页插件的示例代...
    99+
    2023-08-14
    JQuery
  • jQuery插件开发的示例分析
    这篇文章将为大家详细讲解有关jQuery插件开发的示例分析,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。进行jQuery插件开发前,首先要知道两个问题:什么是jQuery...
    99+
    2022-10-19
  • Chrome插件开发的示例分析
    这篇文章给大家分享的是有关Chrome插件开发的示例分析的内容。小编觉得挺实用的,因此分享给大家做个参考,一起跟随小编过来看看吧。本文目录:demo部分截图:前言什么是Chrome插件严格来讲,我们正在说的东西应该叫Chrome扩展(Chr...
    99+
    2023-06-15
  • SpringBoot+Mybatis分页插件PageHelper实现分页效果
    目录一、项目结构二、插件引入三、代码四、测试:        最近刚入职新公司,项目是从零开始搭建的项目。我觉得是时候考验是驴还是千里马的时候...
    99+
    2022-11-12
  • 从入门到实战,GO语言实时开发技术学习笔记分享
    GO语言是由Google公司开发的一种高效、简洁、快速的编程语言,同时也是一门静态类型的语言。它的语法简洁易懂,拥有自动垃圾回收机制,同时支持并发编程,因此非常适合用于实时开发领域。本文将分享我在学习GO语言实时开发技术时的笔记和心得,希...
    99+
    2023-11-12
    实时 开发技术 学习笔记
  • Android UI开发 View自绘控件 分享
     很多时候想要设计漂亮的Android UI,使用Android自带的控件无法满足我们的需要就要考虑自绘控件,在Android界面显示类View,可以通过继承扩展重写相关方法来...
    99+
    2022-06-06
    view Android
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作