Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Deipss' blog

1. 常见框架 

---
title: ASM tools
---
stateDiagram-v2
    direction RL
    Spring --> CGLib
    jvm_sandbox_repeater --> JavaSandbox
    arthas --> bytekit
    bytekit --> asm
    JavaSandbox --> asm
    btrace --> asm
    CGLib --> asm
    ByteBuddy --> asm
    asm --> JavaAgent
    jdk(lambda) --> asm

2. ASM

  • https://asm.ow2.io/
ASM is an all purpose Java bytecode manipulation and analysis framework. 
It can be used to modify existing classes or to dynamically generate classes, 
directly in binary form. ASM provides some common bytecode transformations 
and analysis algorithms from which custom complex transformations 
and code analysis tools can be built. 
ASM offers similar functionality as other Java bytecode frameworks, 
but is focused on performance. 
Because it was designed and implemented to be as small and as fast as possible, 
it is well suited for use in dynamic systems 
(but can of course be used in a static way too, e.g. in compilers).

ASM是一个通用的Java字节码操作和分析框架。它可用于修改现有类或直接以二进制形式动态生成类。
ASM提供了一些通用的字节码转换和分析算法，
可以从这些算法中构建定制的复杂转换和代码分析工具。
ASM提供了与其他Java字节码框架类似的功能，但更注重性能。
因为它的设计和实现是尽可能的小和快，
所以它非常适合在动态系统中使用(当然也可以在静态方式中使用，例如在编译器中)。

「ASM」，是一个 Java 字节码操控框架。它能被用来动态生成类或者增强既有类的功能。 ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。 Java class 被存储在严格格式定义的 .class 文件里，这些类文件拥有足够的元数据来解析类中的所有元素：类名称、方法、属性以及 Java 字节码（指令）。 ASM 从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。说白了asm是直接通过字节码来修改class文件。 另外除了 ASM 可以操作字节码，还有javassist和Byte-code等，他们比 asm 要简单，但是执行效率还是 asm 高。因为 asm 是直接使用指令来控制字节码。

2.1. Asm两类API

ASM API基于访问者模式，为我们提供了ClassVisitor，MethodVisitor，FieldVisitor API接口，每当ASM扫描到类字段是会回调visitField方法，扫描到类方法是会回调MethodVisitor，下面我们看一下API接口

  • Core Api
    • asm.jar
    • asm-util.jar 通用工具类
    • asm-commons.jar 具体场景的工具类
  • Tree Api
    • asm-tree.jar
    • asm-analysis.jar

2.2. 使用Asm技术

如图所示，业界有许多的技术都使用ASM技术来实现一些提交的插件，主要目的不乏：

  • 面向切面编程 Spring CGlib
  • Jdk lambda 表达式，JDK使用 jdk.internal.org.objectweb.asm.ClassWriter 来生成一个类，将 lambda 表达式的代码包装起来。

2.3. ASM 使用方式

  • generate 从0到1写一个Class文件
  • transformer 从1到1 修改一个Class文件
  • analysis 代码扫描、分析

2.4. Asm辅助命令 

javac -g Test.java
javap -verbose Test.class

3. Java Agent 技术

「JavaAgent」，是一种探针技术可以通过 premain 方法，在类加载的过程中给指定的方法进行字节码增强。 其实你的每一个类最终都是字节码指令的执行， 而这种增强后的方法就可以输出我们想要的信息。 这就相当于你硬编码时候输出了一些方法的耗时，日志等信息。

3.1. 静态Agent

  • 在jvm调用main方法前，使用premain方法启动的
  • 需要使用java -jar –javaagent /opt/runtime/aaa.jar 的方式来指定agent包，以启动静态代理
-agentlib:<libname>[=<选项>] 加载本机代理库 <libname>, 例如 -agentlib:hprof
	另请参阅 -agentlib:jdwp=help 和 -agentlib:hprof=help
-agentpath:<pathname>[=<选项>]
	按完整路径名加载本机代理库
-javaagent:<jarpath>[=<选项>]
	加载 Java 编程语言代理, 请参阅 java.lang.instrument

3.2. 动态Agent

  • 1.6之后，使用agentmain方法启动，在目标程序被加载后执行
  • 使用attach的api来

3.3. 使用java agent技术时需要注意的问题

  • 能解决jar包依赖冲突
  • 处理类加载隔离问题
  • 尽量保持agent轻量级
  • 保证后续场景可扩展
  • 保证业务方最低的接入集成成本

4. 代码编写

4.1. ClassVisitor

  • int api 指出了当前使用的 ASM 版本，其可取值为Opcodes.ASM4~Opcodes.ASM9。

classDiagram
    direction BT
    class ClassVisitor {
        + ClassVisitor(int, ClassVisitor)
        + ClassVisitor(int)
        # ClassVisitor cv
        # int api
        + visitAttribute(Attribute) void
        + visitInnerClass(String, String, String, int) void
        + visitRecordComponent(String, String, String) RecordComponentVisitor
        + visitModule(String, int, String) ModuleVisitor
        + visitSource(String, String) void
        + visitTypeAnnotation(int, TypePath, String, boolean) AnnotationVisitor
        + visitMethod(int, String, String, String, String[]) MethodVisitor
        + visitOuterClass(String, String, String) void
        + visitAnnotation(String, boolean) AnnotationVisitor
        + visitNestMember(String) void
        + visit(int, int, String, String, String, String[]) void
        + visitNestHost(String) void
        + visitPermittedSubclass(String) void
        + visitField(int, String, String, String, Object) FieldVisitor
        + visitEnd() void
    }

上面的方法，在调用时，需要注意的是先后顺序，一般就是：先调用 visit() 方法， 接着调用 visitField() 方法或 visitMethod() 方法，最后调用 visitEnd() 方法。

import org.objectweb.asm.*;

public class DynamicClassGenerator {
    public static void main(String[] args) throws Exception {
        // 创建ClassWriter对象，生成类的字节码  
        ClassWriter cw = new ClassWriter(0);
        cw.visit(Opcodes.V1_8, Opcodes.ACC_PUBLIC, "Dynamic/MyClass", null, "java/lang/Object", null);

        // 创建MethodVisitor对象，生成构造方法  
        MethodVisitor constructor = cw.visitMethod(Opcodes.ACC_PUBLIC, "<init>", "()V", null, null);
        constructor.visitVarInsn(Opcodes.ALOAD, 0);
        constructor.visitMethodInsn(Opcodes.INVOKESPECIAL, "java/lang/Object", "<init>", "()V", false);
        constructor.visitInsn(Opcodes.RETURN);
        constructor.visitMaxs(1, 1);
        constructor.visitEnd();

        // 创建MethodVisitor对象，生成一个方法  
        MethodVisitor method = cw.visitMethod(Opcodes.ACC_PUBLIC, "myMethod", "()V", null, null);
        method.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
        method.visitLdcInsn("Hello from MyClass!");
        method.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
        method.visitInsn(Opcodes.RETURN);
        method.visitMaxs(2, 1);
        method.visitEnd();

        // 创建FieldVisitor对象，生成一个静态字段  
        FieldVisitor field = cw.visitField(Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC, "myField", "I", null, null);
        field.visitEnd();

        // 完成类的生成  
        cw.visitEnd();

        // 获取生成的类的字节码，并加载到类加载器中  
        byte[] bytes = cw.toByteArray();
        URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{new File("").toURI().toURL()});
        Class<?> myClass = ClassLoader.defineClass("Dynamic/MyClass", bytes);
        myClass.getMethods()[0].invoke(null);  // 调用生成的myMethod方法，因为它是静态的，所以可以直接调用  
    }
}

4.2. ClassWriter

  • 继承自ClassVisitor类，
  • 构造函数中，有一个int型数据，COMPUTE_MAXS=1，COMPUTE_FRAMES=2，推荐使用2。
    • COMPUTE_MAXS: 计算 max stack 和 max local 信息。
    • COMPUTE_MAXS: 计算 max stack 和 max local 信息。
  • toByteArray() 方法：将所有visitXXX方法，转换为遵循ClassFile结构的byte[]数据

4.3. ClassReader

  • 继承自Object类，
  • .class 文件 –> ClassReader –> byte[] –> 经过各种转换 –> ClassWriter –> byte[] –> .class 文件
  • accept()：这个方法接收一个 ClassVisitor 类型的参数，因此 accept() 方法是将 ClassReader 和 ClassVisitor 进行连接的“桥梁”。accept() 方法的代码逻辑就是按照一定的顺序来调用 ClassVisitor 当中的 visitXxx() 方法。

4.3.1. 代码示例

  • .class –> ClassReader –> ClassVisitor1 … –> ClassVisitorN –> ClassWriter –> .class 文件
public class HelloWorldTransformCore {
    public static void main(String[] args) {
        String relative_path = "sample/HelloWorld.class";
        String filepath = FileUtils.getFilePath(relative_path);
        byte[] bytes1 = FileUtils.readBytes(filepath);

        //（1）构建 ClassReader
        ClassReader cr = new ClassReader(bytes1);

        //（2）构建 ClassWriter
        ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);

        //（3）串连 ClassVisitor
        int api = Opcodes.ASM9;
        ClassVisitor cv = new ClassVisitor(api, cw) { /**/
        };

        //（4）结合 ClassReader 和 ClassVisitor
        int parsingOptions = ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES;
        cr.accept(cv, parsingOptions);

        //（5）生成 byte[]
        byte[] bytes2 = cw.toByteArray();

        FileUtils.writeBytes(filepath, bytes2);
    }
}

4.4. FiledVisitor

4.5. MethodVisitor

  • https://lsieun.github.io/java-asm-01/method-visitor-intro.html

4.6. Frame

线程在执行时，会有自己的独有的栈空间，这个栈中，存放的就是Stock Frame。

4.7. Opcodes

定义了一系列的枚举字段，来标识版本、访问标识、类型

4.8. Label

面向对象等高级语言中，有以下三种逻辑结构：顺序、循环、分支。 在字节码层面，只有顺序和跳转两类

5. 参考文献

  1. https://www.baeldung.com/java-classloaders 类加载器
  2. https://tech.hipac.cn/archives/aeb6e3616cf74e1984b908fc1cd98913#jacoco 多agent治理在海拍客的应用与实践
  3. https://arthas.aliyun.com/doc/agent.html 通常 Arthas 是以动态 attach 的方式来诊断应用，但从3.2.0版本起，Arthas 支持直接以 java agent 的方式启动。
  4. https://www.cnblogs.com/rickiyang/p/11368932.html agent代码精解
  5. https://juejin.cn/post/7018237356532563999 代码示例
  6. https://developer.aliyun.com/article/854428 代码示例
  7. https://zhuanlan.zhihu.com/p/448871215