27 - ASM之Frame
ClassFile中的StackMapTable
在ClassFile结构中，有一个StackMapTable结构，它们关系如下。在ClassFile结构中，每一个方法都对应于method_info结构；在method_info结构中，方法体的代码存储在Code结构内；在Code结构中，frame的变化存储在StackMapTable结构中。
frame说明
假如有一个HelloWorld类，内容如下：
public class HelloWorld {
public void test(boolean flag) {
if (flag) {
System.out.println("value is true");
}
else {
System.out.println("value is false");
}
}
}
查看Instruction
在.class文件中，方法体的内容会被编译成一条一条的instruction。我们可以通过使用javap -c sample.HelloWorld来查看Instruction的内容。
public void test(boolean);
Code:
0: iload_1
1: ifeq 15
4: getstatic #2 // Field java/lang/System.out:Ljava/io/PrintStream;
7: ldc #3 // String value is true
9: invokevirtual #4 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
12: goto 23
15: getstatic #2 // Field java/lang/System.out:Ljava/io/PrintStream;
18: ldc #5 // String value is false
20: invokevirtual #4 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
23: return
查看Frame
在方法当中，每一条Instruction都有对应的Frame。我们可以通过运行HelloWorldFrameCore来查看Frame的具体情况。
test(Z)V
[sample/HelloWorld, int] []
[sample/HelloWorld, int] [int]
[sample/HelloWorld, int] []
[sample/HelloWorld, int] [java/io/PrintStream]
[sample/HelloWorld, int] [java/io/PrintStream, java/lang/String]
[sample/HelloWorld, int] []
[] []
[sample/HelloWorld, int] [java/io/PrintStream]
[sample/HelloWorld, int] [java/io/PrintStream, java/lang/String]
[sample/HelloWorld, int] []
[] []
严格的来说，每一条Instruction都对应两个frame，一个是instruction执行之前的frame，另一个是instruction执行之后的frame。但是，当多个instruction放到一起的时候来说，第n个instruction执行之后的frame，就成为第n+1个instruction执行之前的frame，所以也可以理解成：每一条instruction对应一个frame。
这些frames是要存储起来的。我们知道，每一个instruction对应一个frame，如果都要存储起来，那么在.class文件中就会占用非常多的空间；而.class文件设计的一个主要目标就是尽量占用较小的存储空间，那么就需要对这些frames进行压缩。
压缩frames
为了让.class文件占用的存储空间尽可能的小，因此要对frames进行压缩。对frames进行压缩，从本质上来说，就是忽略掉一些不重要的frames，而只留下一些重要的frames。
那么，怎样区分哪些frames重要，哪些frames不重要呢？我们从instruction执行顺序的角度来看待这个问题。
如果说，instruction是按照“一个挨一个向下顺序执行”的，那么它们对应的frames就不重要；相应的，instruction在执行过程时，它是从某个地方“跳转”过来的，那么对应的frames就重要。为什么说instruction是按照“一个挨一个向下顺序执行”的，那么它们对应的frames就不重要呢？因为这些instruction对应的frame可以很容易的推导出来。如果当前的instruction是从某个地方跳转过来的，就必须要记录它执行之前的frame的情况，否则就没有办法计算它执行之后的frame的情况。当然，我们这里讲的只是大体的思路，而不是具体的判断细节。
经过压缩之后的frames，就存放在ClassFile的StackMapTable结构中。
使用visitFrame()方法
预期目标
public class HelloWorld {
public void test(boolean flag) {
if (flag) {
System.out.println("value is true");
}
else {
System.out.println("value is false");
}
}
}
编码实现
import lsieun.utils.FileUtils;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.Label;
import org.objectweb.asm.MethodVisitor;
import static org.objectweb.asm.Opcodes.*;
public class HelloWorldGenerateCore {
public static void main(String[] args) throws Exception {
String relative_path = "sample/HelloWorld.class";
String filepath = FileUtils.getFilePath(relative_path);
// (1) 生成byte[]内容
byte[] bytes = dump();
// (2) 保存byte[]到文件
FileUtils.writeBytes(filepath, bytes);
}
public static byte[] dump() throws Exception {
// (1) 创建ClassWriter对象
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
// (2) 调用visitXxx()方法
cw.visit(V1_8, ACC_PUBLIC + ACC_SUPER, "sample/HelloWorld",
null, "java/lang/Object", null);
{
MethodVisitor mv1 = cw.visitMethod(ACC_PUBLIC, "<init>", "()V", null, null);
mv1.visitCode();
mv1.visitVarInsn(ALOAD, 0);
mv1.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "<init>", "()V", false);
mv1.visitInsn(RETURN);
mv1.visitMaxs(0, 0);
mv1.visitEnd();
}
{
MethodVisitor mv2 = cw.visitMethod(ACC_PUBLIC, "test", "(Z)V", null, null);
Label elseLabel = new Label();
Label returnLabel = new Label();
// 第1段
mv2.visitCode();
mv2.visitVarInsn(ILOAD, 1);
mv2.visitJumpInsn(IFEQ, elseLabel);
mv2.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv2.visitLdcInsn("value is true");
mv2.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
mv2.visitJumpInsn(GOTO, returnLabel);
// 第2段
mv2.visitLabel(elseLabel);
mv2.visitFrame(F_SAME, 0, null, 0, null); //调用visitFrame()方法
mv2.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv2.visitLdcInsn("value is false");
mv2.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
// 第3段
mv2.visitLabel(returnLabel);
mv2.visitFrame(F_SAME, 0, null, 0, null); //调用visitFrame()方法
mv2.visitInsn(RETURN);
mv2.visitMaxs(2, 2);
mv2.visitEnd();
}
cw.visitEnd();
// (3) 调用toByteArray()方法
return cw.toByteArray();
}
}
在上面的代码中，我们创建ClassWriter对象时，使用了ClassWriter.COMPUTE_MAXS参数，这样ASM就会只计算max locals和max stack的值；在实现test()方法的时候，就需要明确的调用MethodVisitor.visitFrame()方法来添加相应的frame信息。
同时，我们也要注意到：MethodVisitor.visitLabel()方法的调用在前，MethodVisitor.visitFrame()方法的调用在后。因为MethodVisitor.visitLabel()方法是放置了一个潜在的跳转label目标，程序在跳转之后，就需要使用MethodVisitor.visitFrame()方法给出跳转之后Frame的具体情况。
验证结果
import java.lang.reflect.Method;
public class HelloWorldRun {
public static void main(String[] args) throws Exception {
Class<?> clazz = Class.forName("sample.HelloWorld");
Object obj = clazz.newInstance();
Method method = clazz.getDeclaredMethod("test", boolean.class);
method.invoke(obj, true);
method.invoke(obj, false);
}
}
不推荐使用visitFrame()方法
为什么我们不推荐调用MethodVisitor.visitFrame()方法呢？原因是计算frame本身就很麻烦，还容易出错。
我们在创建ClassWriter对象的时候，使用了ClassWriter.COMPUTE_FRAMES参数：
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);
在使用了ClassWriter.COMPUTE_FRAMES参数之后，ASM会忽略代码当中对于MethodVisitor.visitFrame()方法的调用，并且自动帮助我们计算stack map frame的具体内容。
小结
本文主要对frame进行了介绍，内容总结如下：
- 在ClassFile结构中，StackMapTable结构是如何得到的。
- 不推荐使用MethodVisitor.visitFrame()方法，原因是frame的计算复杂，容易出错。我们可以在创建ClassWriter对象的时候，使用ClassWriter.COMPUTE_FRAMES参数，这样ASM就会帮助我们计算frame的值到底是多少。
