java字节码框架ASM的深入学习

发布时间：2024/03/08

Java字节码框架ASM深入学习

简介

ASM是一个用Java编写的自由字节码处理库。它可以动态生成新的类，或者对现有类进行修改，最终生成对应的字节码文件。使用ASM可以实现很多高级的功能，比如动态AOP框架、基于注解的ORM框架等。

详细攻略

1. 安装ASM

使用Maven（或者Gradle）可以很方便地安装ASM：

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

2. 动态生成类

使用ASM可以动态生成一个类。首先，创建一个ClassWriter对象，并指定添加的类的类型：

ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);
cw.visit(Opcodes.V1_8, Opcodes.ACC_PUBLIC, className, null, "java/lang/Object", null);

这里我们指定类的版本是1.8，类的访问标志是public，并继承自Object。接下来，我们可以添加一个无参构造函数和一个main方法：

MethodVisitor mv = cw.visitMethod(Opcodes.ACC_PUBLIC, "<init>", "()V", null, null);
mv.visitVarInsn(Opcodes.ALOAD, 0);
mv.visitMethodInsn(Opcodes.INVOKESPECIAL, "java/lang/Object", "<init>", "()V", false);
mv.visitInsn(Opcodes.RETURN);
mv.visitMaxs(1, 1);
mv.visitEnd();

mv = cw.visitMethod(Opcodes.ACC_PUBLIC + Opcodes.ACC_STATIC, "main", "([Ljava/lang/String;)V", null, null);
mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv.visitLdcInsn("Hello, world!");
mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
mv.visitInsn(Opcodes.RETURN);
mv.visitMaxs(2, 1);
mv.visitEnd();

在main方法中，我们获得System.out对象并将字符串“Hello, world!”入栈，最后调用println方法打印出来。现在可以得到一个字节数组：

byte[] code = cw.toByteArray();

最后，我们可以使用自定义的ClassLoader将字节数组转换成Class对象并使用：

ClassLoader cl = new MyClassLoader();
Class<?> clazz = cl.defineClass(className, code);
Method method = clazz.getMethod("main", String[].class);
method.invoke(null, (Object) new String[]{});

3. 修改现有类

使用ASM同样可以修改现有类。在这个例子中，我们将替换一个类的方法来打印出方法名：

public class Test {
    public void foo() {
        System.out.println("foo");
    }
}

首先使用ASM读入这个类：

ClassReader cr = new ClassReader("Test");
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);
ClassVisitor cv = new MyClassVisitor(cw);
cr.accept(cv, 0);
byte[] code = cw.toByteArray();

然后实现自己的ClassVisitor：

public class MyClassVisitor extends ClassVisitor {
    public MyClassVisitor(ClassVisitor cv) {
        super(Opcodes.ASM9, cv);
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
        MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
        return new MyMethodVisitor(api, mv, name, desc);
    }
}

实现自己的MethodVisitor：

public class MyMethodVisitor extends MethodVisitor {
    private final String name;
    private final String desc;

    public MyMethodVisitor(int api, MethodVisitor mv, String name, String desc) {
        super(api, mv);
        this.name = name;
        this.desc = desc;
    }

    @Override
    public void visitCode() {
        super.visitCode();
        mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
        mv.visitLdcInsn(name + " " + desc);
        mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
    }
}

最终可以使用自定义的ClassLoader加载并使用修改后的类：

ClassLoader cl = new MyClassLoader();
Class<?> clazz = cl.defineClass("Test", code);
Object obj = clazz.newInstance();
clazz.getMethod("foo").invoke(obj);

示例说明

上面的两个示例演示了如何使用ASM动态生成类和修改现有类。

第一个示例中，我们使用ASM创建了一个名为Hello的类，其中包含一个静态的main方法。运行这个例子，可以看到控制台输出了一条消息“Hello, world!”。

第二个示例中，我们使用ASM修改现有的Test类，向每个方法的开头添加一行代码，以便打印出方法名和参数。具体来说，我们实现了一个新的ClassVisitor和MethodVisitor，用于在字节码中添加代码，而使用ASM的核心功能是在将代码写回到字节数组中。之后，我们自定义ClassLoader加载修改后的字节码，并通过反射API调用其中的方法。

结论

ASM是一个非常强大的字节码处理框架。使用它，我们可以轻松地创建或修改Java类的字节码。在此过程中，ASM提供了很多具体的API，允许我们操作函数和类的相关信息。ASM的用途不仅局限于动态生成类或修改现有的类。在各种框架的实现中，如Spring、Hibernate等，ASM都有广泛的应用。