【进阶篇】四、字节码增强框架:ASM、ByteBuddy-程序员宅基地

技术标签: JVM  jvm  字节码  开发语言  


相比自己的代码里用Spring AOP添加某些功能,字节码增强更适配无侵入式的Java Agent场景。比如下面写个Java Agent打印 任意Java程序中方法执行的耗时:

在这里插入图片描述

1、ASM

  • ASM是Java字节码操作和分析框架
  • 直接以二进制形式修改现有类或动态生成类
  • ASM性能好(修改或生成类快)但代码书写复杂
  • 官网:https://asm.ow2.io/

2、ASM字节码增强

引入依赖:

<dependency>
    <groupId>org.ow2.asm</groupId>
    <artifactId>asm</artifactId>
    <version>9.6</version>
</dependency>

使用框架的固定写法代码,注意继承MethodVisitor

在这里插入图片描述

继承MethodVisitor的类描述如何去增强原来的类:

  • visitCode:被增强的方法执行开始前做的操作
  • visitInsn:被增强的方法产生特定的操作时,想增加的操作,比如出现return语句时
  • visitEnd:设置被增强的方法的最大栈深度和局部变量表的大小

在这里插入图片描述
最后,实现MethodVisitor类用于增强方法,修改属性等其他方法类似,写对应类的实现类即可。

3、ASM入门案例

用ASM框架,实现一下插入一行字节码

import org.apache.commons.io.FileUtils;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.MethodVisitor;

import java.io.File;
import java.io.IOException;

import static org.objectweb.asm.Opcodes.*;

//ASM入门案例,向每个方法添加一行字节码指令
public class ASMDemo {
    
    public static void main(String[] args) throws IOException {
    
        //1.从本地读取一个字节码文件,byte[]
        byte[] bytes = FileUtils.readFileToByteArray(new File("D:\\jmh2\\llg-agent\\target\\classes\\com\\llg\\AgentMain.class"));

        //2.通过ASM修改字节码文件
        //数据转换成可以解析内容
        ClassReader classReader = new ClassReader(bytes);

        //创建visitor对象,修改字节码信息
        ClassWriter classWriter = new ClassWriter(0);
        //参数一和JDK版本对应,详见官方文档
        ClassVisitor classVisitor = new ClassVisitor(ASM6,classWriter){
    
            //重写visitMethod,即说明怎么修改方法,重写visitField即说明怎么改属性,以此类推
            @Override
            public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
    

                MethodVisitor mv = super.visitMethod(access, name, descriptor, signature, exceptions);
                //返回自定义的MethodVisitor,this.api即上面的ASM6
                MethodVisitor methodVisitor = new MethodVisitor(this.api,mv){
    
                    //修改字节码指令

                    @Override
                    public void visitCode() {
    
                        //调用ASM的API,插入一行字节码指令 ICONST_0
                        visitInsn(ICONST_0);
                    }
                };

                return methodVisitor;
            }
        };

        classReader.accept(classVisitor,0);


        //3.将修改完的字节码信息写入文件中,进行替换
        FileUtils.writeByteArrayToFile(new File("D:\\jmh2\\llg-agent\\target\\classes\\com\\llg\\AgentMain.class"),classWriter.toByteArray());

    }
}

在这里插入图片描述

4、ASM + Java Agent实现增强类的方法

以下用ASM实现增强类的方法,执行开始前、return后,打印一句话:

import org.objectweb.asm.*;

import static org.objectweb.asm.Opcodes.*;

public class AsmEnhancer {
    

    public static byte[] enhanceClass(byte[] bytes){
    
        ClassWriter classWriter = new ClassWriter(0);
        ClassVisitor classVisitor = new ClassVisitor(ASM7, classWriter){
    
            @Override
            public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
    
                MethodVisitor methodVisitor = super.visitMethod(access, name, descriptor, signature, exceptions);
                return new MyMethodVisitor(this.api,methodVisitor);
            }
        };

        ClassReader classReader = new ClassReader(bytes);
        classReader.accept(classVisitor,0);

        //返回结果
        return classWriter.toByteArray();
    }
}

/**
 * 实现MethodVisitor类,描述怎么增强
 */
class MyMethodVisitor extends MethodVisitor {
    

    public MyMethodVisitor(int api, MethodVisitor methodVisitor) {
    
        super(api, methodVisitor);
    }

    //方法执行一开始,调用System.out.println("开始执行")方法
    @Override
    public void visitCode() {
    
        mv.visitFieldInsn(Opcodes.GETSTATIC,"java/lang/System","out","Ljava/io/PrintStream;");
        mv.visitLdcInsn("开始执行");
        mv.visitMethodInsn(INVOKEVIRTUAL,"java/io/PrintStream","println","(Ljava/lang/String;)V",false);
        super.visitCode();
    }

    //返回时,执行System.out.println("结束执行")
    @Override
    public void visitInsn(int opcode) {
    
        if(opcode == ARETURN || opcode == RETURN ) {
    
            mv.visitFieldInsn(Opcodes.GETSTATIC,"java/lang/System","out","Ljava/io/PrintStream;");
            mv.visitLdcInsn("结束执行");
            mv.visitMethodInsn(INVOKEVIRTUAL,"java/io/PrintStream","println","(Ljava/lang/String;)V",false);
        }
        super.visitInsn(opcode);
    }

    //指定最大栈深度20,最大局部变量表大小是50
    @Override
    public void visitEnd() {
    
        mv.visitMaxs(20,50);
        super.visitEnd();
    }

}

Java Agent中,根据用户输入的类名找到class进行增强:

public class ClassCommand {
    

    //对类进行增强
    public static void enhanceClass(Instrumentation inst){
    
        System.out.println("请输入类名:");
        //让用户输入类名
        Scanner scanner = new Scanner(System.in);
        String className = scanner.next();

        //根据类名找到class对象
        Class[] allLoadedClasses = inst.getAllLoadedClasses();
        for (Class allLoadedClass : allLoadedClasses) {
    
            if(allLoadedClass.getName().equals(className)){
    
                //找到了
                ClassFileTransformer transformer = new ClassFileTransformer() {
    
                    @Override
                    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
    
                        //通过ASM对类进行增强,返回字节码信息
                        byte[] bytes = AsmEnhancer.enhanceClass(classfileBuffer);
                        //返回增强后的字节码信息
                        return bytes;
                    }
                };

                //1.添加转换器
                inst.addTransformer(transformer,true);

                //2.手动触发转换
                try {
    
                    inst.retransformClasses(allLoadedClass);
                } catch (UnmodifiableClassException e) {
    
                    e.printStackTrace();
                }finally {
    
                    //3.删除转换器
                    inst.removeTransformer(transformer);
                }


            }
        }
    }
}

动态代理的agentmain中调用一下:

public class AgentMain {
    

    public static void agentmain(String agentArgs,Instrumentation inst){
    
        ClassCommand.enhanceClass(inst);
    }

}

Java Agent打成jar包,写客户端,连接用户输入的Java进程的PID并加载jar:

public class AttachMain {
    
    public static void main(String[] args) throws Exception {
    
        //获取进程列表,让用户自己选择连接哪个PID
        //执行jps指令
        Process process = Runtime.getRuntime().exec("jps");
        BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(process.getInputStream()));
        try (bufferedReader) {
    
            String line;
            while ((line = bufferedReader.readLine()) != null) {
    
                System.out.println(line);
            }
        }
        //用户输入进程ID
        Scanner scanner = new Scanner(System.in);
        String pid = scanner.next();
        //连接用户输入的进程
        VirtualMachine vm = VirtualMachine.attach(pid);
        //执行Java Agent的里的agentmain方法
        vm.loadAgent("D:\\jmh2\\llg-agent\\target\\llg-agent-1.0-SNAPSHOT-jar-with-dependencies.jar");

    }
}

效果:

在这里插入图片描述

输入要增强的类:

在这里插入图片描述
调用TestController类中的方法:

在这里插入图片描述
增强成功:

在这里插入图片描述

5、Byte Buddy

上面的ASM,写增强代码的逻辑很繁琐。Byte Buddy:

  • 底层基于ASM,提供了更简单的API供调用
  • 用于在Java程序运行时创建和修改Java类,而无需编译器的帮助
  • 和Java Agent整合的更好,提供了对应的依赖
  • 官网:https://bytebuddy.net/#/

同一增强,与ASM相比:
在这里插入图片描述

Byte Buddy的用法为引入依赖后:指定增强哪个类,以及怎么增强(类似AOP的一个通知类)

在这里插入图片描述
通知类中,用注解写方法进入和退出时要新增的逻辑:

在这里插入图片描述

注意上面用到的另外两个注解:@Advice.AllArguments拿到方法的所有参数,@Advice.Enter拿到上面enter方法返回的结果。

6、Byte Buddy案例

引入依赖:

<dependency>
    <groupId>net.bytebuddy</groupId>
    <artifactId>byte-buddy</artifactId>
    <version>1.14.10</version>
</dependency>
<dependency>
    <groupId>net.bytebuddy</groupId>
    <artifactId>byte-buddy-agent</artifactId>
    <version>1.14.10</version>
</dependency>

在Java Agent中定义方法,接收用户输入的类名,JMX获取已加载的类,并找到用户要增强的类的class对象,用Byte Buddy的固定API调用进行增强:

public class ClassCommand {
    

   //Byte Buddy
    //对类进行增强
    public static void enhanceClassByByteBuddy(Instrumentation inst) {
    
        System.out.println("请输入类名:");
        //让用户输入类名
        Scanner scanner = new Scanner(System.in);
        String className = scanner.next();

        //根据类名找到class对象
        Class[] allLoadedClasses = inst.getAllLoadedClasses();
        for (Class allLoadedClass : allLoadedClasses) {
    
            if (allLoadedClass.getName().equals(className)) {
    
                //找到了
                //使用byte buddy增强类
                new AgentBuilder.Default()
                        //禁止byte buddy处理时修改类名
                        .disableClassFormatChanges()
                        //处理时使用retransform增强
                        .with(AgentBuilder.RedefinitionStrategy.RETRANSFORMATION)
                        //打印出增强过程中的错误日志(官网固定写法)
                        .with(new AgentBuilder.Listener.WithTransformationsOnly(AgentBuilder.Listener.StreamWriting
                                .toSystemOut()))
                        //匹配哪些类,这里只增强用户传入的类
                        .type(ElementMatchers.named(className))
                        //增强,使用MyAdvice通知,ElementMatchers.any()即对所有方法都进行增强
                        .transform((builder, classLoader, module, protectionDomain) ->
                                builder.visit(Advice.to(MyAdvice.class).on(ElementMatchers.any())))
                        .installOn(inst);


            }
        }
    }
}

MyAdvice的增强逻辑:

mport net.bytebuddy.asm.Advice;

public class MyAdvice {
    
    //方法进入时,打印所有参数,返回开始时间
    @Advice.OnMethodEnter
    static long enter(@Advice.AllArguments Object[] ary){
    
        if(null != ary){
    
            for (int i = 0; i < ary.length; i++) {
    
                System.out.println("参数:" + i + " 内容:" + ary[i]);
            }
        }
        //返回毫秒值
        return System.nanoTime();
    }

    //方法退出时候,统计方法执行耗时
    @Advice.OnMethodExit
    static void exit(@Advice.Enter long value){
    
        System.out.println("耗时为: " + (System.nanoTime() - value) + "纳秒");
    }
}

同ASM,加载Java Agent的Jar:
在这里插入图片描述

输入类名:

在这里插入图片描述

增强成功:

在这里插入图片描述

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/llg___/article/details/137694390

智能推荐

oracle 12c 集群安装后的检查_12c查看crs状态-程序员宅基地

文章浏览阅读1.6k次。安装配置gi、安装数据库软件、dbca建库见下:http://blog.csdn.net/kadwf123/article/details/784299611、检查集群节点及状态:[root@rac2 ~]# olsnodes -srac1 Activerac2 Activerac3 Activerac4 Active[root@rac2 ~]_12c查看crs状态

解决jupyter notebook无法找到虚拟环境的问题_jupyter没有pytorch环境-程序员宅基地

文章浏览阅读1.3w次,点赞45次,收藏99次。我个人用的是anaconda3的一个python集成环境,自带jupyter notebook,但在我打开jupyter notebook界面后,却找不到对应的虚拟环境,原来是jupyter notebook只是通用于下载anaconda时自带的环境,其他环境要想使用必须手动下载一些库:1.首先进入到自己创建的虚拟环境(pytorch是虚拟环境的名字)activate pytorch2.在该环境下下载这个库conda install ipykernelconda install nb__jupyter没有pytorch环境

国内安装scoop的保姆教程_scoop-cn-程序员宅基地

文章浏览阅读5.2k次,点赞19次,收藏28次。选择scoop纯属意外,也是无奈,因为电脑用户被锁了管理员权限,所有exe安装程序都无法安装,只可以用绿色软件,最后被我发现scoop,省去了到处下载XXX绿色版的烦恼,当然scoop里需要管理员权限的软件也跟我无缘了(譬如everything)。推荐添加dorado这个bucket镜像,里面很多中文软件,但是部分国外的软件下载地址在github,可能无法下载。以上两个是官方bucket的国内镜像,所有软件建议优先从这里下载。上面可以看到很多bucket以及软件数。如果官网登陆不了可以试一下以下方式。_scoop-cn

Element ui colorpicker在Vue中的使用_vue el-color-picker-程序员宅基地

文章浏览阅读4.5k次,点赞2次,收藏3次。首先要有一个color-picker组件 <el-color-picker v-model="headcolor"></el-color-picker>在data里面data() { return {headcolor: ’ #278add ’ //这里可以选择一个默认的颜色} }然后在你想要改变颜色的地方用v-bind绑定就好了,例如:这里的:sty..._vue el-color-picker

迅为iTOP-4412精英版之烧写内核移植后的镜像_exynos 4412 刷机-程序员宅基地

文章浏览阅读640次。基于芯片日益增长的问题,所以内核开发者们引入了新的方法,就是在内核中只保留函数,而数据则不包含,由用户(应用程序员)自己把数据按照规定的格式编写,并放在约定的地方,为了不占用过多的内存,还要求数据以根精简的方式编写。boot启动时,传参给内核,告诉内核设备树文件和kernel的位置,内核启动时根据地址去找到设备树文件,再利用专用的编译器去反编译dtb文件,将dtb还原成数据结构,以供驱动的函数去调用。firmware是三星的一个固件的设备信息,因为找不到固件,所以内核启动不成功。_exynos 4412 刷机

Linux系统配置jdk_linux配置jdk-程序员宅基地

文章浏览阅读2w次,点赞24次,收藏42次。Linux系统配置jdkLinux学习教程,Linux入门教程(超详细)_linux配置jdk

随便推点

matlab(4):特殊符号的输入_matlab微米怎么输入-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏19次。xlabel('\delta');ylabel('AUC');具体符号的对照表参照下图:_matlab微米怎么输入

C语言程序设计-文件(打开与关闭、顺序、二进制读写)-程序员宅基地

文章浏览阅读119次。顺序读写指的是按照文件中数据的顺序进行读取或写入。对于文本文件,可以使用fgets、fputs、fscanf、fprintf等函数进行顺序读写。在C语言中,对文件的操作通常涉及文件的打开、读写以及关闭。文件的打开使用fopen函数,而关闭则使用fclose函数。在C语言中,可以使用fread和fwrite函数进行二进制读写。‍ Biaoge 于2024-03-09 23:51发布 阅读量:7 ️文章类型:【 C语言程序设计 】在C语言中,用于打开文件的函数是____,用于关闭文件的函数是____。

Touchdesigner自学笔记之三_touchdesigner怎么让一个模型跟着鼠标移动-程序员宅基地

文章浏览阅读3.4k次,点赞2次,收藏13次。跟随鼠标移动的粒子以grid(SOP)为partical(SOP)的资源模板,调整后连接【Geo组合+point spirit(MAT)】,在连接【feedback组合】适当调整。影响粒子动态的节点【metaball(SOP)+force(SOP)】添加mouse in(CHOP)鼠标位置到metaball的坐标,实现鼠标影响。..._touchdesigner怎么让一个模型跟着鼠标移动

【附源码】基于java的校园停车场管理系统的设计与实现61m0e9计算机毕设SSM_基于java技术的停车场管理系统实现与设计-程序员宅基地

文章浏览阅读178次。项目运行环境配置:Jdk1.8 + Tomcat7.0 + Mysql + HBuilderX(Webstorm也行)+ Eclispe(IntelliJ IDEA,Eclispe,MyEclispe,Sts都支持)。项目技术:Springboot + mybatis + Maven +mysql5.7或8.0+html+css+js等等组成,B/S模式 + Maven管理等等。环境需要1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。_基于java技术的停车场管理系统实现与设计

Android系统播放器MediaPlayer源码分析_android多媒体播放源码分析 时序图-程序员宅基地

文章浏览阅读3.5k次。前言对于MediaPlayer播放器的源码分析内容相对来说比较多,会从Java-&amp;amp;gt;Jni-&amp;amp;gt;C/C++慢慢分析,后面会慢慢更新。另外,博客只作为自己学习记录的一种方式,对于其他的不过多的评论。MediaPlayerDemopublic class MainActivity extends AppCompatActivity implements SurfaceHolder.Cal..._android多媒体播放源码分析 时序图

java 数据结构与算法 ——快速排序法-程序员宅基地

文章浏览阅读2.4k次,点赞41次,收藏13次。java 数据结构与算法 ——快速排序法_快速排序法