ASM字节码插桩：打印方法名、入参、返回值、方法耗时

已于 2022-08-18 11:33:27 修改
阅读量1k 收藏
点赞数 1
分类专栏： 字节码编程 文章标签： java ASM 字节码
于 2022-08-17 11:02:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_40977118/article/details/126378220
版权

目录

1. 预期目标

  • 使用ASM在进入方法后和退出方法前，对方法名、入参、返回值和执行耗时进行打印
  • 比如有一个Hello类
package org.example.asm8.printArgs;

import java.util.Date;

public class Hello {

    private String name;

    private int age;

    private Date birthDate;

    public Hello(String name, int age, Date birthDate) {
        this.name = name;
        this.age = age;
        this.birthDate = birthDate;
    }

    public int hello() {
        if (age < 18) {
            throw new RuntimeException("too young");
        }
        return age;
    }

    public String testHello() {
        hello();
        return "success!";
    }

}

在这里插入图片描述

  • 进行字节码插桩后达到下面效果
package org.example.asm8.printArgs;

import java.util.Date;

public class Hello {
    private String name;
    private int age;
    private Date birthDate;

    public Hello(String name, int age, Date birthDate) {
        long var6 = System.currentTimeMillis();
        PrintUtils.printText("Enter: 方法名 <init>，方法描述符 (Ljava/lang/String;ILjava/util/Date;)V");
        PrintUtils.printObject("入参类型：", name);
        PrintUtils.printObject("入参类型：", new Integer(age));
        PrintUtils.printObject("入参类型：", birthDate);
        this.name = name;
        this.age = age;
        this.birthDate = birthDate;
        PrintUtils.printText("Exit: 方法名 <init>，方法描述符 (Ljava/lang/String;ILjava/util/Date;)V");
        PrintUtils.printObject("返回值类型：", "void方法，没有返回值");
        PrintUtils.printSpendTime("<init>", var6);
    }

    public int hello() {
        long var3 = System.currentTimeMillis();
        PrintUtils.printText("Enter: 方法名 hello，方法描述符 ()I");
        if (this.age < 18) {
            RuntimeException var5 = new RuntimeException("too young");
            PrintUtils.printText("Exit: 方法名 hello，方法描述符 ()I");
            PrintUtils.printObject("返回值类型：", "有异常抛出了");
            PrintUtils.printSpendTime("hello", var3);
            throw var5;
        } else {
            int var10000 = this.age;
            PrintUtils.printText("Exit: 方法名 hello，方法描述符 ()I");
            PrintUtils.printObject("返回值类型：", new Integer(var10000));
            PrintUtils.printSpendTime("hello", var3);
            return var10000;
        }
    }

    public String testHello() {
        long var3 = System.currentTimeMillis();
        PrintUtils.printText("Enter: 方法名 testHello，方法描述符 ()Ljava/lang/String;");
        this.hello();
        PrintUtils.printText("Exit: 方法名 testHello，方法描述符 ()Ljava/lang/String;");
        PrintUtils.printObject("返回值类型：", "success!");
        PrintUtils.printSpendTime("testHello", var3);
        return "success!";
    }
}

2. AdviceAdapter类

  • AdviceAdapter本身继承了MethodVisitor，提供了onMethodEnter()和onMethodExit()方法，分别表示方法进入和方法退出，方便添加我们自定义的处理逻辑。

在这里插入图片描述

  • 通过注释可以看出，这两个方法都能够使用和修改局部变量表，但是最好不要改变操作数栈的状态
  • onMethodEnter在方法开始或者父类执行完构造方法后被调用
  • onMethodExit在方法结束且在return和athrow指令前被调用，操作数栈顶包含返回值和异常对象
  • onMethodEnter是通过MethodVisitor的visitCode()方法实现，onMethodExit是通过MethodVisitor的visitInsn(int opcode)方法实现

3. 代码实现

3.1 打印方法类

package org.example.asm8.printArgs;

public class PrintUtils {

    public static void printText(String str) {
        System.out.println(str);
    }

    public static void printObject(String name, Object value) {
        if (value == null) {
            System.out.println("null");
        } else {
            System.out.println(name + value.getClass().getSimpleName() + "，参数值：" + value);
        }
    }

    public static void printSpendTime(String methodName, long startTime) {
        System.out.println(methodName + " 耗时：" + (System.currentTimeMillis() - startTime) + " ms");
        System.out.println("*************************************************");
    }

}

在这里插入图片描述

3.2 字节码增强类

package org.example.asm8.printArgs;

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
import org.objectweb.asm.commons.AdviceAdapter;

import java.io.FileOutputStream;

public class PrintClassArgs implements Opcodes {

    public static void main(String[] args) throws Exception {
        ClassReader cr = new ClassReader(Hello.class.getName());
        ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_FRAMES);
        cr.accept(new MyClassVisitor(ASM9, cw), ClassReader.EXPAND_FRAMES);
        byte[] bytes = cw.toByteArray();
        // 生成class
        String path = PrintClassArgs.class.getResource("/").getPath() + "org/example/asm8/printArgs/Hello.class";
        System.out.println("输出路径：" + path);
        try (FileOutputStream fos = new FileOutputStream(path)) {
            fos.write(bytes);
        }

    }

    static class MyClassVisitor extends ClassVisitor {

        protected MyClassVisitor(int api, ClassVisitor classVisitor) {
            super(api, classVisitor);
        }

        @Override
        public MethodVisitor visitMethod(int access, String name, String descriptor, String signature,
            String[] exceptions) {
            MethodVisitor methodVisitor = super.visitMethod(access, name, descriptor, signature, exceptions);
            if (methodVisitor != null) {
                // 排除抽象方法和本地方法
                boolean isAbstractMethod = (access & ACC_ABSTRACT) != 0;
                boolean isNativeMethod = (access & ACC_NATIVE) != 0;
                if (!isAbstractMethod && !isNativeMethod) {
                    methodVisitor = new MyMethodVisitor(api, methodVisitor, access, name, descriptor);
                }
            }
            return methodVisitor;
        }
    }

    static class MyMethodVisitor extends AdviceAdapter {

        String str = "方法名 " + super.getName() + "，方法描述符 " + super.methodDesc;
        // 开始时间在局部变量表中的位置
        int start = 0;

        protected MyMethodVisitor(int api, MethodVisitor methodVisitor, int access, String name, String descriptor) {
            super(api, methodVisitor, access, name, descriptor);
        }

        @Override
        protected void onMethodEnter() {
            // 记录开始时间
            super.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
            // 在局部变量表中nextLocal位置存放long类型的数值，nextLocal表示当前已存数据的下一个位置的索引
            // 下面执行完visitVarInsn(LSTORE, start)后，nextLocal会根据存入的数据类型长度，后移一位或两位
            start = nextLocal;
            // 将栈顶的数值放入局部变量表中start位置
            super.visitVarInsn(LSTORE, start);
            // 进入方法时，先打印一句话 Enter: xxx
            printText("Enter: " + str);
            // 取出方法所有的入参类型
            Type[] argumentTypes = getArgumentTypes();
            for (int i = 0; i < argumentTypes.length; i++) {
                Type argumentType = argumentTypes[i];
                // 将方法的入参从局部变量表中取出，压入到操作数栈中
                loadArg(i);
                // 对操作数栈顶的数据按照argumentType类型进行包装，并用包装好的值替换原来栈顶的这个数值，而且数据类型也是一致的
                box(argumentType);
                // 打印操作数栈顶的这个值，就实现了对方法入参的循环打印
                printObject("入参类型：");
            }

        }

        @Override
        protected void onMethodExit(int opcode) {
            // 退出方法时，打印一句话 Exit: xxx
            printText("Exit: " + str);
            // throw 与 return 指令没有返回值，这里手动将希望打印到控制台的字符串压入到操作数栈顶
            if (opcode == ATHROW) {
                super.visitLdcInsn("有异常抛出了");
            } else if (opcode == RETURN) {
                super.visitLdcInsn("void方法，没有返回值");
            } else if (opcode == ARETURN) {
                // 复制操作数栈顶的1个数值，并将复制结果压入操作数栈顶，此时操作数栈上有2个连续相同的数值
                // 复制的目的是，多出来的这个数值用来打印到控制台，原来栈顶的数值不受影响
                dup();
            } else if (opcode == LRETURN || opcode == DRETURN) {
                // 因为double和long类型（64bit）占2个slot，所以要复制操作数栈顶的2个数值，并将其压入操作数栈顶
                dup2();
                // 对栈顶的数据按照返回值类型进行包装，并用包装好的值替换原来栈顶的这个数值
                // double类型会用Double.valueOf()进行包装，long类型会用Long.valueOf()进行包装
                box(getReturnType());
            } else {
                dup();
                // 这里排除上面几种返回值类型，这里的opcode应该是 FRETURN 和 IRETURN
                // 对相应类型的数据进行Float.valueOf()或者Integer.valueOf()包装
                box(getReturnType());
            }
            // 因为这里打印时，需要参数是Object类型，所以上面的2个box(getReturnType())必须有，目的是将基本数据类型转成包装类
            // 否则打印时，传的是基本数据类型，不是Object一定会报错
            // 前面2个if没有返回值，所以不需要按照返回值数据类型进行包装，直接传入String类型数据给printObject方法进行打印
            // 第3个if是Object类型返回值，复制一份压到栈顶即可，不需要再包装了
            printObject("返回值类型：");
            // 打印耗时
            printSpendTime();
        }

        private void printText(String str) {
            // 将str从常量池中取出，压入操作数栈顶
            super.visitLdcInsn(str);
            // 从操作数栈顶取出一个数据，作为入参调用PrintUtils的public static void printText(String str)方法
            super.visitMethodInsn(INVOKESTATIC, Type.getInternalName(PrintUtils.class), "printText",
                "(Ljava/lang/String;)V", false);
        }

        private void printObject(String name) {
            // 将name压入栈顶
            super.visitLdcInsn(name);
            // printObject方法入参是name和value，从栈顶取参数时，从后往前输入
            // 所以要先拿到Object类型的value再拿String类型的name，但此时栈顶是name，name下面是value的包装类
            // 所以要调用swap方法，将栈顶最顶端的两个数值互换(数值不能是long或double类型)
            swap();
            // 从操作数栈顶取出一个数据，作为入参调用PrintUtils的public static void printObject(String name, Object value)方法
            super.visitMethodInsn(INVOKESTATIC, Type.getInternalName(PrintUtils.class), "printObject",
                "(Ljava/lang/String;Ljava/lang/Object;)V", false);
        }

        private void printSpendTime() {
            // 方法名压入栈顶
            super.visitLdcInsn(super.getName());
            // 将开始时间从局部变量表start位置压入栈顶
            super.visitVarInsn(LLOAD, start);
            super.visitMethodInsn(INVOKESTATIC, Type.getInternalName(PrintUtils.class), "printSpendTime",
                "(Ljava/lang/String;J)V", false);
        }

    }

}

3.3 执行增强

  • 执行main方法，查看被修改后的Hello.class，可以看出已经在方法进入和退出前添加了，打印入参、返回值和耗时的方法

在这里插入图片描述

3.4 验证

  • 测试类
package org.example.asm8.printArgs;

import java.util.Date;

public class HelloRun {

    public static void main(String[] args) {
        Hello instance = new Hello("Fisher", 18, new Date());
        System.out.println(instance.testHello());
    }

}
  • 打印结果
Enter: 方法名 <init>，方法描述符 (Ljava/lang/String;ILjava/util/Date;)V
入参类型：String，参数值：Fisher
入参类型：Integer，参数值：18
入参类型：Date，参数值：Wed Aug 17 10:04:08 CST 2022
Exit: 方法名 <init>，方法描述符 (Ljava/lang/String;ILjava/util/Date;)V
返回值类型：String，参数值：void方法，没有返回值
<init> 耗时：26 ms
*************************************************
Enter: 方法名 testHello，方法描述符 ()Ljava/lang/String;
Enter: 方法名 hello，方法描述符 ()I
Exit: 方法名 hello，方法描述符 ()I
返回值类型：Integer，参数值：18
hello 耗时：0 ms
*************************************************
Exit: 方法名 testHello，方法描述符 ()Ljava/lang/String;
返回值类型：String，参数值：success!
testHello 耗时：0 ms
*************************************************
success!

在这里插入图片描述

4. 说明

  • 这里针对于box()方法进行说明

在这里插入图片描述

  • 对于操作数栈顶数据是对象、数组和没有返回值的情况就不说了
  • 说下是基本数据类型时是怎么进行包装的
      Type boxedType = getBoxedType(type);
      newInstance(boxedType);
      if (type.getSize() == 2) {
        // Pp -> Ppo -> oPpo -> ooPpo -> ooPp -> o
        dupX2();
        dupX2();
        pop();
      } else {
        // p -> po -> opo -> oop -> o
        dupX1();
        swap();
      }
      invokeConstructor(boxedType, new Method("<init>", Type.VOID_TYPE, new Type[] {type}));
  1. 第一行是通过基本数据类型拿到对应的包装类，比如long->Long，int->Integer等
  2. 第二行是通过new关键字申请这个包装类的内存空间，然后将内存地址压入操作数栈顶，从注释可以到，不管是if中，还是else中，都在原有的Pp（表示是long或者double，占用2个slot）或者p（表示除了long和double之外的基本数据类型，占用1个slot）后面，变成了Ppo和po，表示在原来的栈顶多了一个o，这个o就是刚申请到的内存空间地址，可以为最后那行（invokeConstructor(boxedType, new Method(“”, Type.VOID_TYPE, new Type[] {type}));）在执行包装类对应的构造方法时使用
  3. 第三行如果size==2表示占用2个slot，说明是long或者double类型
  4. 第四行是对newInstance(boxedType);dupX2();dupX2();pop();invokeConstructor(boxedType, new Method(“”, Type.VOID_TYPE, new Type[] {type}));整个过程的注释
  5. 第五行是执行dup_x2指令将操作数栈顶（此时是Ppo）的数据复制一份，然后插入到距离栈顶3个slot位置下面（即变成oPpo）
  6. 第六行继续执行dup_x2指令将操作数栈顶（此时是oPpo）的数据复制一份，然后插入到距离栈顶3个slot位置下面（即变成ooPpo）
  7. 第七行是执行pop指令将操作数栈顶（此时是ooPpo）的数据弹出丢弃（即变成ooPp）
  8. 第八行表示是除了long和double之外的基本数据类型
  9. 第九行是对newInstance(boxedType);dupX1();swap();invokeConstructor(boxedType, new Method(“”, Type.VOID_TYPE, new Type[] {type}));整个过程的注释
  10. 第十行是执行dup_x1指令将操作数栈顶（此时是po）的数据复制一份，然后插入到距离栈顶2个slot位置下面（即变成opo）
  11. 第十一行是执行swap指令将操作数栈顶的2个数据进行交换（即变成oop）
  12. 第十二行是执行基本数据类型对应包装类的构造方法，需要先取出栈顶的基本数据类型的数值（即Pp或者p）用于初始化，再取出创建的包装类对象内存地址（即o）用于执行构造方法，用代码表示就是new Long(18L)或者new Integer(18)，最后操作数栈顶的数值都会变为o，这个o就是对原来栈顶基本数据类型的数据进行包装后的包装类型数据，属于Object类型，就可以用于后面调用打印方法public static void printObject(String name, Object value) 时的这个value的输入
Fisher3652
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
16 - MethodVisitor生成构造方法 - 简书1
08-03
ASM简介（四）函数 我们在使ASM相关API对函数进操作之前，我们需要了解函数在字节码的存储格式及其执模型。执模型 我...千南阅读 ,评论赞深度解析插桩技术
Java ASM 框架：字节码操作的常见用法（生成类，修改类,方法插桩，方法注入）
BASK2312的博客
12-26 2327
ASM 是一款读写Java字节码的工具，可以达到跳过源码编写，编译，直接以字节码的形式创建类，修改已经存在类(或者jar中的class)的属性，方法等。 通常用来开发一些Java开发的辅助框架,其做法是在你编写的Java代码中注入一些特定代码（俗称字节码插装）达到特定目的，以Android开发为例最常用的方法通过字节码插装实现热修复，事件监听，埋点，开源框架等非常规操作,当然在Android开发中通常辅以Gradle插件一起使用，这个改天在写。早就听说过ASM和字节码插桩技术，但是工作中很少直接使用,因为近
ASM之打印方法入参和返回值
最新发布
Dream It Possible
06-05 50
本文主要介绍了如何实现打印方法的参数和返回值，我们提供了三个版本：第一个版本，它的特点是代码固定、不够灵活。第二个版本，它的特点是结合Type来使用，为方法参数的“类型”和“数量”赋予“灵魂”，让方法灵活起来。第三个版本，它的特点是将“打印工作”移交给“专业人员”来处理。本文内容总结如下：第一点，从实现思路的角度来说，打印方法的参数和返回值，是在“方法进入”和“方法退出”的基础上实现的。在“方法进入”的时候，先将方法的参数打印出来；在“方法退出”的时候，再将方法的返回值打印出来。
AOP+ASM+插件化总结--实现基于注解的埋点和统计-- 代码篇之：AMS
zhiChao的博客
11-21 1626
import org.objectweb.asm.AnnotationVisitor; import org.objectweb.asm.ClassVisitor; import org.objectweb.asm.MethodVisitor; import org.objectweb.asm.Opcodes; import org.objectweb.asm.commons.AdviceAdap...
java字节码文件的属性表
cz2423415723的博客
06-01 989
属性表（attribute_info）在前面的讲解之中已经出现过数次，Class文件、字段表、方法表都可以携带自己的属性表集合，以描述某些场景专有的信息。属性表集合的限制稍微宽松一些，不再要求各个属性表具有严格顺序，并且《Java虚拟机规范》允许只要不与已有属性名重复，任何人实现的编译器都可以向属性表中写入自己定义的属性信息，Java虚拟机运行时会忽略掉它不认识的属性。为了能正确解析Class文件，《Java虚拟机规范》最初只预定义了9项所有Java虚拟机实现都应当能识别的属性，而在最新的《Java虚拟机规
返回值_ASM检测方法返回值
weixin_39714383的博客
12-24 931
众所周知ASM是一个修改字节码的利器,此为前文. 我们游戏中有一个很重要的接口大致如下所示(因为历史原因返回值无法修改)publicObjectload(){BaseClassbaseClass=newImplClass();returnbaseClass;}方法的返回值是一个Object,但是期望返回的是基于某个基类的值.如果返回值写错了会在...
演示Asm字节码插桩asmd-demo-master.zip
05-19
Asm字节码插桩是一种在Java字节码层面对程序进行动态修改的技术，它允许开发者在不修改源代码的情况下，向已有的类或方法中插入额外的代码。这种技术在性能监控、日志记录、行为追踪、代码优化等领域有广泛应用。在...
LargeImageMonitor:一个使用ASM进行字节码插桩的大图监控框架
04-01
LargeImageMonitor是一个使用ASM进行字节码插桩的大图监控框架，可以对我们要加载的图片进行监控，如果出现图片超过阈值的情况会进行报警。 功能与特点 1.支持Glide，Fresco，Picasso，Universal Image Loader。 2....
java字节码框架ASM操作字节码的方法浅析
08-31
Java字节码框架ASM是一个强大的库，它允许程序员在运行时动态生成和修改Java类和接口的字节码。ASM提供了对JVM字节码的底层访问，这使得开发者能够实现诸如AOP（面向切面编程）或者元编程等高级功能。 首先，我们...
ASM插桩在Android项目中的应用
07-16
ASM是一个Java字节码操控和分析框架，它允许动态生成类或修改已有的类，尤其适用于运行时代码增强和静态代码插桩。本文将深入探讨ASM如何在Android项目中发挥作用，以及如何通过ASMInjectTest进行实践。 首先，了解...
Android字节码插桩
12-21
ASM是Java字节码操控和分析框架，它在Android字节码插桩中扮演着核心角色。本文将深入探讨ASM在Android字节码插桩中的应用及其相关知识点。 **ASM框架** ASM是一个轻量级的Java字节码库，它可以生成和解析.class...
javaagent+ASM获取方法执行时间和打印参数
于琦海
09-13 627
ASM打印方法的执行时间，ASM获取并打印参数
java asm工具类_使用ASM实现简单的AOP
weixin_39779004的博客
02-23 337
前言之前一直使用greys及其内部升级二次开发版来排查问题。最近周末刚好事情不多，作为一名程序员本能地想要弄懂这么神奇的greys到底是怎么实现的？周末从github上拉了代码仔细读了读，其基本技术框架是JVM attach + Instrumentation + asm实现的。关于JVM attach和Instrumentation的功能，下次再写文章介绍，本文着重于greys中非常神奇的一个类...
【ASM】字节码操作 转换已有的类 打印方法参数和返回值
九师兄
10-22 302
不灵活。如果方法的参数的数量和类型发生改变,这种方法就会失效。那么,有没有办法来自动适应方法的数量和类型变化呢?答案是“有”。这个时候,就是Type类( org . objectweb. asm. Type ) 来发挥作用的地方。这种方式的特点就是,结合着Type类来使用,为方法参数的“类型”和“数量"赋予“灵魂”,让方法灵活起来。这种方式的特点就是将"打印工作"放到- -个单独的类里面。在这个单独的类里面,我们可以把内容打印出来,也可以输出到文件中,可以根据自己的需要进行修改。
【ASM】字节码操作 工具类与常用类 AdviceAdapter 介绍 打印方法进入 和 方法退出 的参数
九师兄
11-18 693
【ASM】字节码操作 工具类与常用类 Printer、ASMifier、Textifier 介绍我们简单的介绍了 Printer、ASMifier、Textifier 三个类的使用方法。以及部分原理。下面我们将要学习的简介以及使用方法。対于AdviceAdapter类来説,能多很容易的实現在方法迸入”和"方法退出”肘添加代码。AdviceAdapter 类的特点:引入了onMethodEnter() 方法和onMethodExit()方法。
从jvm字节码指令 看待java值传递与是否存在引用传递的问题
xmind果果
02-26 445
ps 最近在看java究竟是只有值传递还是值传递和引用传递都有这个问题的博客时，各有各的说法，有一篇博客的评论使我动了很大的好奇心 博客地址：http://www.cnblogs.com/binyue/p/3862276.html 大概内容 如下的一行代码，调用test2方法时，传递过来的对象是属于值传递还是引用传递 public class Test { public static vo...
Android编译时技术（三）ASM 基础使用之代码修改
写好每一篇文章
05-29 1773
如何使用ASM加载一个Class文件，并对其文件内容进行增加修改。以及一些ClassReader、ClassVisitor、MethodVisitor、AdviceAdapter、FieldVisitor的用法介绍。
Android Gradle 中的字节码插桩之ASM（八）
nihaomabmt的专栏
08-20 2743
JVM平台上，处理字节码的框架最常见的就三个，ASM，Javasist，AspectJ。我尝试过Javasist，而AspectJ也稍有了解，最终选择ASM，因为使用它可以更底层地处理字节码的每条命令，处理速度、内存占用，也优于其他两个框架。 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值