深入开源框架底层之ASM

什么是 ASM ？

ASM 是一个 Java 字节码操控框架。它能被用来动态生成类或者增强既有类的功能。ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。Java class 被存储在严格格式定义的 .class 文件里，这些类文件拥有足够的元数据来解析类中的所有元素：类名称、方法、属性以及 Java 字节码（指令）。ASM 从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。

为什么要动态生成 Java 类？

想象一下，如果开源框架要求你添加各种Java类来实现诸如log、cache、transaction等功能，我想这个开源框架你肯定不会用吧。动态生成类可以减少对你代码的侵入，提高使用者的效率。

为什么选择ASM？

最直接的改造 Java 类的方法莫过于直接改写 class 文件。Java 规范详细说明了 class 文件的格式，直接编辑字节码确实可以改变 Java 类的行为。直到今天，还有一些 Java 高手们使用最原始的工具，如 UltraEdit 这样的编辑器对 class 文件动手术。是的，这是最直接的方法，但是要求使用者对 Java class 文件的格式了熟于心：小心地推算出想改造的函数相对文件首部的偏移量，同时重新计算 class 文件的校验码以通过 Java 虚拟机的安全机制。

可以发现，直接操作class文件是比较麻烦的，就跟为什么我们都选择使用框架一样，框架屏蔽了底层的复杂性。ASM就是操作class的一把利器。

使用 ASM 编程

ASM提供了两种API：

1. CoreAPI（ClassVisitor 、MethodVisitor等）
2. TreeAPI（ClassNode，MethodNode等）

区别是CoreAPI基于事件模型，定义了Class中各个元素的Visitor，不需要加载整个Class到内存中。而TreeAPI以Tree结构将Class整个结构读取到内存中。从使用角度来说TreeAPI更为简单。

以下示例采用的是CoreAPI方式。

添加Maven：

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

使用的相对比较稳定，使用比较多的版本5.0.4。

首先说明一下，修改Class有多种方式，例如直接修改当前Class，或者生成Class的子类，从而达到增强的效果。

下面的示例就是通过生成指定Class的子类，从而达到增强的效果，好处是对原有Class无侵入，并且可以实现多态的效果。

首先定义一个我们要增强的类：

package com.zjz;

import java.util.Random;

/**
 * @author zhaojz created at 2019-08-22 10:49
 */
public class Student {
    public String name;

    public void studying() throws InterruptedException {
        System.out.println(this.name+"正在学习...");
        Thread.sleep(new Random().nextInt(5000));
    }
}

接下来首先定义一个ClassReader：

ClassReader classReader = new ClassReader("com.zjz.Student");

然后再定义一个ClassWriter:

ClassWriter classWriter = new ClassWriter(classReader, ClassWriter.COMPUTE_MAXS);

ClassWriter.COMPUTE_MAXS 表示自动计算局部变量和操作数栈大小。更多其它选项可参考：asm.ow2.io

接下来开始正式访问Class：

//通过ClassVisitor访问Class（匿名类的方式，可以自行定义为一个独立的类）
//ASM5为JVM字节码指令操作码
ClassVisitor classVisitor = new ClassVisitor(Opcodes.ASM5, classWriter) {
	//声明一个全局变量，表示增强后生成的子类的父类
   String enhancedSuperName;
   @Override
   public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
   //拼接需要生成的子类的类名：Student$EnhancedByASM
   String enhancedName = name+"$EnhancedByASM";
   //将Student设置为父类
   enhancedSuperName = name;
   super.visit(version, access, enhancedName, signature, enhancedSuperName, interfaces);
   }

    @Override
    public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) {
    //这里是演示字段访问
    System.out.println("Field:" + name);
    return super.visitField(access, name, desc, signature, value);
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
    System.out.println("Method:" + name);
    MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
    MethodVisitor wrappedMv = mv;
    //判断当前读取的方法
    if (name.equals("studying")) {
    //如果是studying方法，则包装一个方法的Visitor
    wrappedMv = new StudentStudyingMethodVisitor(Opcodes.ASM5, mv);
    }else if(name.equals("<init>")){
    //如果是构造方法，处理子类中父类的构造函数调用
    wrappedMv = new StudentEnhancedConstructorMethodVisitor(Opcodes.ASM5, mv,enhancedSuperName);
    }
    return wrappedMv;
    }
};

接下来重点看看MethodVisitor：

//Studying方法的Visitor
static class StudentStudyingMethodVisitor extends MethodVisitor{

    public StudentStudyingMethodVisitor(int i, MethodVisitor methodVisitor) {
    	super(i, methodVisitor);
    }

	//MethodVisitor 中定义了不同的visitXXX()方法，代表的不同的访问阶段。
	//visitCode表示刚刚进入方法。
    @Override
    public void visitCode() {
    	//添加一行System.currentTimeMillis()调用
        visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
        //并且将其存储在局部变量表内位置为1的地方
        visitVarInsn(Opcodes.LSTORE, 1);
        //上面两个的作用就是在Studying方法的第一行添加 long start = System.currentTimeMillis()
    }

	//visitInsn 表示访问进入了方法内部
    @Override
    public void visitInsn(int opcode) {
    	//通过opcode可以得知当前访问到了哪一步，如果是>=Opcodes.IRETURN && opcode <= Opcodes.RETURN 表明方法即将退出
        if ((opcode >= Opcodes.IRETURN && opcode <= Opcodes.RETURN)){
        	//加载局部变量表中位置为1的数据，也就是start的数据，并传入给下面的方法
            visitVarInsn(Opcodes.LLOAD, 1);
            //然后调用自定义的一个工具方法，用来输出耗时
            visitMethodInsn(Opcodes.INVOKESTATIC, "com/zjz/Before", "end", "(J)V", false);
        }
        super.visitInsn(opcode);
    }


}

static class StudentEnhancedConstructorMethodVisitor extends MethodVisitor{
	//定义一个全局变量记录父类名称
    private String superClassName;
    public StudentEnhancedConstructorMethodVisitor(int i, MethodVisitor methodVisitor,String superClassName) {
        super(i, methodVisitor);
        this.superClassName = superClassName;
    }

    @Override
    public void visitMethodInsn(int opcode, String owner, String name, String desc, boolean b) {
    	//当开始初始化构造函数时，先访问父类构造函数,类似源码中的super()
        if (opcode==Opcodes.INVOKESPECIAL && name.equals("<init>")){
        	owner = superClassName;
        }
        super.visitMethodInsn(opcode, owner, name, desc, b);
    }
}

此时ClassVisitor还没有数据的输入，只定义了数据的输出 new ClassVisitor(Opcodes.ASM5, classWriter)，所以还需要：

classReader.accept(classVisitor, ClassReader.SKIP_DEBUG);

到此就完成了Class的读取，访问修改，输出的过程。

细心的观众就会发现了，输出到哪里了？怎么样访问新生成的类呢？所以我们需要定义一个ClassLoader来加载我们生成的Class：

static class StudentClassLoader extends ClassLoader{
       public Class defineClassFromClassFile(String className,byte[] classFile) throws ClassFormatError{
           return defineClass(className, classFile, 0, classFile.length);
       }
   }

然后通过ClassWriter获取新生成的类的字节数组，并加载到JVM中：

byte[] data = classWriter.toByteArray();
Class subStudent = classLoader.defineClassFromClassFile("com.zjz.Student$EnhancedByASM", data);

到此就完成了一个class的生成，上面的代码完成的是一个很简单的事情：记录学习时间。

总结一下：

ASM CoreAPI 核心的三个东西就是ClassReader、Visitor、ClassWriter，通过责任链模式将其链接起来。

Visitor通过访问者模式进行方法、字段等等属性的访问，如果需要修改一个方法和字段，只需要将其原本的Visitor给Wrap一下即可。

关于如何进行代码的hook需要理解JVM相关字节码指令，以及ASM的相关OpCode。

ASM Bytecode Outline 2017

但是那么多指令、OpCode、符号怎么记得住呢？比如上面代码中的：

visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
visitVarInsn(Opcodes.LSTORE, 1);

Opcodes.INVOKESTATIC 、Opcodes.LSTORE、()J，是不是看着就晕？其实除了熟能生巧外，还可以使用工具。

如果你使用的是IDEA，那么可以安装上ASM Bytecode Outline 2017插件。然后在源文件上右键选择Show Bytecode Outline，你将会看到如下视图：

切换的ASMified视图，你会看到跟我们上面写的一样的代码，直接Copy过来使用即可。

查看示例完整源代码：asm_demo

参考资料：

https://asm.ow2.io/

https://www.ibm.com/developerworks/cn/java/j-lo-asm30/index.html

https://juejin.im/post/5b549bcbe51d45169c1c8b66