SpringBoot自定义maven-plugin插件整合asm代码插桩

 更新时间:2022年02月22日 16:24:24   作者:code2roc  
本文主要介绍了SpringBoot自定义maven-plugin插件整合asm代码插桩,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

背景

公司开发框架增加了web系统license授权证书校验模块,实行一台机器一个授权证书,初步方案是增加拦截器针对全局请求进行拦截校验,评估后认为校验方式单一,应该增加重要工具类,业务service实现中每个方法的进行校验,因为涉及代码量较大硬编码工作困难,故选择通过自定义maven插件在编译期间进行动态代码插桩操作

项目配置

新建maven项目设置打包方式

<packaging>maven-plugin</packaging>

增加依赖项

         <!--使用doc的方式-->
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-plugin-api</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!--使用注解的方式-->
        <dependency>
            <groupId>org.apache.maven.plugin-tools</groupId>
            <artifactId>maven-plugin-annotations</artifactId>
            <version>3.5.2</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.maven</groupId>
            <artifactId>maven-project</artifactId>
            <version>2.2.1</version>
        </dependency>
        <dependency>
            <groupId>org.ow2.asm</groupId>
            <artifactId>asm</artifactId>
            <version>9.0</version>
        </dependency>
 

build内容配置

     <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-plugin-plugin</artifactId>
                <version>3.5</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.6.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>

编译拦截

创建编译操作类FramePlugin,继承AbstractMojo并使用Mojo注解标注,output参数是class文件编译后路径

@Mojo(name = "deepcompile", defaultPhase = LifecyclePhase.COMPILE)
public class FramePlugin extends AbstractMojo {
    @Parameter(name = "output", defaultValue = "${project.build.directory}")
    private File output;
    public void execute() throws MojoExecutionException {
        File f = ;
        if (!f.exists()) {
            f.mkdirs();
        }
        try {
             insertPile(f);
        } catch (Exception e) {
            exceptioncount++;
            e.printStackTrace();
        }
    }

 ASM插桩

新建ClassVisitor重写visitMethod方法来过滤访问需要插桩的方法,需要排除自带的init方法

public class MethodCoverageClassVisitor extends ClassVisitor {
    public MethodCoverageClassVisitor(ClassVisitor classVisitor) {
        super(Opcodes.ASM9, classVisitor);
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String descriptor, String signature,
                                     String[] exceptions) {
        final MethodVisitor methodVisitor = super.visitMethod(access, name, descriptor, signature, exceptions);
        if (name.equals("<init>")) {
            return methodVisitor;
        }
        return new MethodCoverageMethodVisitor(Opcodes.ASM9, methodVisitor);
    }
}

新建MethodVisitor重写visitCode方法针对方法内部字节码进行自定义操作,这里是使用框架内部封装好的一个静态方法来校验license证书

public class MethodCoverageMethodVisitor extends MethodVisitor {
    public MethodCoverageMethodVisitor(int api, MethodVisitor methodVisitor) {
        super(api, methodVisitor);
    }

    @Override
    public void visitCode() {
        mv.visitFieldInsn(Opcodes.INVOKESTATIC, "com/xxxx/frame/common/utils/ComplieSDK", "checkLicense", "()V");
    }
}

最后在execute中进行文件递归查找调用,就是将已经编译的class文件读取/自定义操作后保存

 private void insertPile(File root) throws IOException {
        if (root.isDirectory()) {
            for (File file : root.listFiles()) {
                insertPile(file);
            }
        }
        String className = root.getName().replace(".class", "");
        if (root.getName().endsWith(".class")) {
            //class筛选
            boolean flag = false;
             //自定义的class文件筛选条件代码
            if (flag) {
                System.out.println("【insertPile】:" + className);
                FileOutputStream fos = null;
                try {
                    final byte[] instrumentBytes = doInsertPile(root);
                    fos = new FileOutputStream(root);
                    fos.write(instrumentBytes);
                    fos.flush();
                } catch (MojoExecutionException e) {
                    System.out.println("【insertPile-exception】:" + className);
                    e.printStackTrace();
                } finally {
                    if (fos != null) {
                        fos.close();
                    }
                }
            }
        }
    }

项目使用

maven-plugin项目执行mvn install安装到本地仓库

框架项目配置自定义maven插件进行打包,配置执行的声明周期为complie(编译),这里goal自定义命令名称需要和mojo注解标注类中指定的name名称一致

          <plugin>
                <groupId>com.xxxxx</groupId>
                <artifactId>frame-maven-plugin</artifactId>
                <version>1.2.5</version>
                <executions>
                    <execution>
                        <goals>
                            <!-- 执行目标 -->
                            <goal>deepcompile</goal>
                        </goals>
                        <!-- 执行这个目标所在的生命周期 -->
                        <phase>compile</phase>
                    </execution>
                </executions>
            </plugin>

到此这篇关于SpringBoot自定义maven-plugin插件整合asm代码插桩的文章就介绍到这了,更多相关maven-plugin asm代码插桩内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • JavaWeb中的组件Filter过滤器解析

    JavaWeb中的组件Filter过滤器解析

    这篇文章主要介绍了JavaWeb中的组件Filter过滤器解析,Filter过滤器是一种用于处理和转换数据的工具,常用于Web开发中,它可以在请求到达服务器之前或响应返回给客户端之前对数据进行预处理或后处理,需要的朋友可以参考下
    2023-10-10
  • 教你springboot+dubbo快速启动的方法

    教你springboot+dubbo快速启动的方法

    这篇文章主要介绍了springboot+dubbo快速启动的方法,dubbo的角色广泛的分为三类provider,comsumer,注册中心,本文通过实例代码给大家介绍的非常详细,需要的朋友参考下
    2022-04-04
  • Java中的拦截器、过滤器、监听器用法详解

    Java中的拦截器、过滤器、监听器用法详解

    这篇文章主要介绍了Java中的拦截器、过滤器、监听器用法,详细分析了Java拦截器、过滤器、监听器的功能、使用方法及相关注意事项,需要的朋友可以参考下
    2017-05-05
  • 使用spring通过aop获取方法参数和参数值

    使用spring通过aop获取方法参数和参数值

    这篇文章主要介绍了使用spring通过aop获取方法参数和参数值,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • spring cloud 之 客户端负载均衡Ribbon深入理解

    spring cloud 之 客户端负载均衡Ribbon深入理解

    下面小编就为大家带来一篇spring cloud 之 客户端负载均衡Ribbon深入理解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • java:程序包com.xxx.xxx不存在报错万能解决办法

    java:程序包com.xxx.xxx不存在报错万能解决办法

    这篇文章主要给大家介绍了关于java:程序包com.xxx.xxx不存在报错万能解决办法,这个问题曾逼疯初学者的我,不过弄清楚原理后就很简单了,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • 如何使用Sentry 监控你的Spring Boot应用

    如何使用Sentry 监控你的Spring Boot应用

    这篇文章主要介绍了如何使用Sentry 监控你的Spring Boot应用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • java中Serializable接口作用详解

    java中Serializable接口作用详解

    这篇文章主要为大家详细介绍了java中Serializable接口作用,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-05-05
  • 详解Java中List的正确的删除方法

    详解Java中List的正确的删除方法

    这篇文章主要为大家详细介绍了Java中List的正确的删除方法,文中的示例代码讲解详细,对我们学习有一定帮助,需要的可以参考一下
    2022-05-05
  • java编程之xpath介绍

    java编程之xpath介绍

    这篇文章主要介绍了java编程之xpath介绍,具有一定借鉴价值,需要的朋友可以参考下
    2017-12-12

最新评论