一起来学ASM字节码插桩：从分析class文件结构开始
文章目录
-
-
- Class字节码
-
- class字节码构成
- 类型描述符
-
- 基本类型描述符
- 非数组的引用类型
- 数组引用类型
- 方法描述符
- OpCode 操作码
-
- 类操作码
- 字段操作码
- 方法操作码
- 加载、存储等操作
- 计算相关操作码
- 其他
- 示例
-
Class字节码
Java 能做到 一次编译，到处运行，主要就是靠 class字节码 文件，也就是 java 文件经过编译之后 .java -> .class，然后再被 JVM 虚拟机加载。其实，不仅是 java 语言，只要是符合规则的 class 字节码文件，都可以被 JVM 加载，如 Grooy、Kolin 语言：
有了 class 字节码，也就解除了 VM虚拟机 与编程语言之间的耦合性。不管什么语言，只要是能编译成符合规则的字节码文件，就可以被 VM虚拟机 识别并加载到内存中。
class字节码构成
class字节码 中由无符号数和表两种数据结构组成。
- 无符号数：基本数据类型，
u1、u2、u4、u8分别表示1、2、4、8个字节的无符号数，无符号数可以用来表示数字、索引引用、数量只或者字符串（UTF-8编码）。 - 表：由多个
无符号数或者其他表作为数据项构成的复合数据类型，class文件中所有的表都以“_info”结尾。所以，整个Class文件可以认为就是一张表。
package org.ninetripods.lib_bytecode.asm.coreApi;
public class Test {
private int num = 0;
public void addNum() {
num++;
System.out.println("num:" + num);
}
public static int staticAdd(int a, int b) {
return a + b;
}
}
经过javac编译之后，会生成Test.class字节码文件，用010 Editor打开这个文件：
使用 javap -c xxx.class命令可以 输出分解后的 java字节码：
public class org.ninetripods.lib_bytecode.asm.coreApi.Test {
public org.ninetripods.lib_bytecode.asm.coreApi.Test();
Code:
0: aload_0
1: invokespecial #1 // Method java/lang/Object."":()V
4: aload_0
5: iconst_0
6: putfield #2 // Field num:I
9: return
public void addNum();
Code:
0: aload_0
1: dup
2: getfield #2 // Field num:I
5: iconst_1
6: iadd
7: putfield #2 // Field num:I
10: getstatic #3 // Field java/lang/System.out:Ljava/io/PrintStream;
13: aload_0
14: getfield #2 // Field num:I
17: invokedynamic #4, 0 // InvokeDynamic #0:makeConcatWithConstants:(I)Ljava/lang/String;
22: invokevirtual #5 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
25: return
public static int staticAdd(int, int);
Code:
0: iload_0
1: iload_1
2: iadd
3: ireturn
}
上述文件中描述了Test.class加载到内存时的执行顺序，包括各种描述符及操作码，接下面就来看一下。
类型描述符
基本类型描述符
每个基本类型都对应一个字母，如下：
| 基本类型 | 描述符 |
|---|---|
| byte | B |
| short | S |
| int | I |
| long | J |
| float | F |
| double | D |
| char | C |
| boolean | Z |
| void | V |
非数组的引用类型
L + 全限定名，示例：
注：全限定名用于描述class类的名称，实际上就是把平时Java类名称中的"."换成了"/"，如Java的祖先类java.lang.Object全限定名是：java/lang/Object。
数组引用类型
[ + 数组内类型的描述符，示例：
int[] -> [I
String[][] -> [[Ljava/lang/String;
方法描述符
方法描述符用于class字节码文件中保存参数类型列表和返回值的方式。
方法描述符规则：
- （参数列表）+ 返回值
- 参数类型都为类型描述符
- 参数列表中如果有多个参数，直接排列即可，不需要用逗号隔开
示例：
void test() -> ()V
void test(int i) -> (I)V
void test(String s, int i) -> (Ljava/lang/StringI)V
int[] test(double[], boolean) -> ([DZ)[I
OpCode 操作码
OpCode用于VM虚拟机解释运行Java程序，每个操作码都可以用来表示一个指令。如0x62是一个十六进制数，表示两个float类型的数相加。在ASM的org.objectweb.asm.OpCodes类中可以找到： int FADD = 98，ASM中是用十进制表示的，除此之外，其他操作码指令都可以在这个类中找到。
类操作码
- new 创建对象时使用，如
new String()对应mv.visitTypeInsn(NEW, "java/lang/String")，返回一个指定类型的对象。 - instanceof 表示是否为指定类的对象，如
obj instanceof String对应mv.visitTypeInsn(INSTANCEOF, "java/lang/String")，返回一个布尔值结果。 - checkcast ，用于检查对象的类型，如
(String) obji对应mv.visitTypeInsn(CHECKCAST, "java/lang/String")，返回类型检查后的对象。
注：上述的mv指的是MethodVisitor（ASM Core Api中的类，后面的文章会详细介绍），主要用于操作遍历、修改方法时使用。
字段操作码
- getfield 用于获取非静态字段的值，对应
ASM中的GETFIELD，如mv.visitFieldInsn(GETFIELD, xxxx)。 - putfield 用于修改非静态字段的值，对应
ASM中的PUTFIELD，如mv.visitFieldInsn(PUTFIELD, xxxx)。 - getstatic 用于获取静态字段的值，对应
ASM中的GETSTATIC，如mv.visitFieldInsn(GETSTATIC, xxxx)。 - putstatic 用于修改静态字段的值，对应
ASM中的PUTSTATIC，如mv.visitFieldInsn(PUTSTATIC, xxxx)。
方法操作码
- invokevirtual 用于调用非静态方法，它是一种动态分派的调用指令，即引用类型并不能决定方法属于哪个类型。一般可以被重写的方法就用invokevirtual。
- invokespecial 用于调用非静态方法，主要用于
方法、私有方法、super.method() mv.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "equals", "(Ljava/lang/Object;)Z", false); - invokestatic 用于调用
static静态方法。 - invokeinterface 用于调用接口实例方法，如
mv.visitMethodInsn(INVOKEINTERFACE, "java/util/List", "size", "()I", true); - invokedynamic
加载、存储等操作
虚拟机栈：
虚拟机栈描述的是Java方法执行的内存模型：每个方法在执行时都会创建一个栈帧用于存储局部变量表、操作数栈、动态链接、方法出口等信息。每一个方法从调用直至执行完成的过程，就对应着一个栈帧在虚拟机栈中入栈到出栈的过程。
每一个栈帧中又包含了以下信息：
- 局部变量表：表长度在编译阶段确定。调用方法时传递的参数，以及在方法内部创建的局部变量都保存在局部变量表中。
- 操作数栈：也称为操作栈，是一个后入先出栈(
LIFO)，操作数栈的深度也是在编译阶段确定。当一个方法刚开始执行时，这个方法的操作数栈是空的，在方法执行过程中，会有各种字节码指令被压入和弹出操作数栈。 - 动态链接：主要是为了支持方法调用过程中的动态连接。比如在一个方法中去调用其他方法。
- 返回地址：用来帮助当前方法恢复它的上层方法执行状态。
更详细的流程参见：Java内存模型、GC Roots可达性分析、垃圾回收机制
下面的加载、存储相关操作都与操作数栈、本地变量表有关。
- xload & xload_n (x = a/i/l/f/d， n表示加载对象的位置)
a 表示对象，I表示int， l表示long， f表示float， d表示double， b表示byte， c表示char， s表示short。
加载字节码，如aload_0，对应ASM中的mv.visitVarInsn(ALOAD, 0);
- xstore & xstore_n (x = a/i/l/f/d，n表示加载对象的位置)
a 表示对象，I表示int， l表示long， f表示float， d表示double， b表示byte， c表示char， s表示short。
存储对象，如astore_1，对应ASM中的mv.visitVarInsn(ISTORE, 1);
- xreturn (x = a/i/l/f/d) 返回操作码
返回操作码会将栈顶元素返回（返回某一对象或基本数据类型），并清空操作数栈。如：
mv.visitInsn(ARETURN); //对应某一对象（非基本类型）
mv.visitInsn(RETURN); //无返回，对应void方法
- dup 复制栈顶数据的操作码
用于复制栈顶元素并插入到栈中的操作码，可以节省xload和xstore的使用量。对应ASM中的DUP，mv.visitInsn(DUP);，DUP后紧接着的数字代表了复制数量，Xn代表插入到栈顶下第几层。如：
1、 DUP
输入： d3 d2 d1
输出：到d3 d2 d1 d1
2、DUP2_X1
输入：d3 d2 d1
输出：d3 d2 d2 d1 d1
- pop pop2 弹出栈顶操作码
用于栈操作的，比如调用了一个有返回值的方法，但是该返回值并不需要，可以使用POP。如：mv.visitInsn(POP) - swap 交换操作码
可以操作交换栈顶的两个操作数。 - ldc & ldc_w & ldc2_w 读取常量池常量的操作码
- bipush & sipush 整数常量操作码
bipush，属于byte范围（-128~127）
sipush，属于short范围（-32768~32767）
对应ASM中：
mv.visitIntInsn(BIPUSH, 100);
mv.visitIntInsn(SIPUSH, 1000);
计算相关操作码
- xneg、xadd、xsub、xmul 、xdiv、xrem、iinc(iinc_w)
分别为取反、加法、减法、乘法、除法、取余、自增操作法。 - xand、xor、xxor、xshl、xshr、xushr
按位且、按位或、按位异或、按位左移、按位右移、按位无符号右移操作符。 - x2f(x=i/l/d)、x2d(x=i/l/f)、x2i(x=d/l/f)、x2l (x=i/d/f)、i2x（x=b/c/s）
分别为转化为float、转换为double、转换为int、转换为long、int转换为(b/c/s)的操作码。其中b/c/s的取值范围：byte（-128 ~ 127）、short（-32768 ~ 32767）和char（0 ~ 65535）
其他
- monitorenter/monitorexit 尝试加锁的操作码，两个必须成对使用，作用与引用类型对象上。如
mv.visitInsn(MONITORENTER); mv.visitInsn(MONITOREXIT);
注：如果使用的是ACC_SYNCHRONIZED尝试加锁，则不再需要手动对自身对象或类加锁，会自动加锁及释放锁。 - athrow 用于将一个Throwable异常对象抛出，如
mv.visitInsn(ATHROW);
示例
- new String(“Hello”)
methodVisitor.visitTypeInsn(NEW, "java/lang/String");
methodVisitor.visitInsn(DUP);
methodVisitor.visitLdcInsn("Hello"); //将入参Hello放到操作数栈中，下面调用构造方法时传入
methodVisitor.visitMethodInsn(INVOKESPECIAL, "java/lang/String", "", "(Ljava/lang/String;)V", false);
注意，NEW操作码指令只会创建对象，不会调用构造函数；如果想调用构造函数进行初始化，须用上面INVOKESPECIAL指令。