ASM学习笔记--ASM 4 user guide 第二章要点翻译总结

参考：ASM 4 user guide

第一部分 core API

第二章  类

2.1.1概观

编译后的类包括：

l  一个描述部分：包括修饰语（比如public或private）、名字、父类、接口或者注释区域。

l  类中每个域声明的部分。

l  类中每个方法以及构造函数声明的部分。也包含了方法编译后的代码，它是一系列Java字节码指令的形式。

编译后的类结构如下：

2.1.2内部名（internal name）

类或者接口使用内部名，内部名就是类的全限定名，即带斜杠的全称。

例如，String的internal name为 java/lang/String.

2.1.3类型描述符

内部名只被用在类或者接口名字。其他的使用类型描述符。

String is Ljava/lang/String；

类的描述符以L开头，以分号结尾。

数组类型以方括号开头。

2.1.4方法描述

方法描述符以圆括号开始，圆括号中是每个参数的类型（每个参数类型连着写，之间没有空格或者逗号之类），圆括号后面是方法的返回值类型。 方法描述符不包括方法的名字和参数名字。

2.2 接口和组件

2.2.1 描述

ASM API对于产生和转换编译后的类是基于ClassVistor抽象类的。visitField返回一个FieldVistor，这个规则在FieldVistor中也是递归的。

ClassVistor中方法调用的顺序：

visit visitSource? visitOuterClass? ( visitAnnotation | visitAttribute )*

( visitInnerClass | visitField | visitMethod )*

visitEnd

visit必须首先调用，接着最多一个visitSource,接着最多一个visitOuterClass, 接着任意数量个visitAnnotation和visitAttribute，接着任意数量个visitInnerClass、visitField和visitMethod，最后调用visitEnd。

ASM提供了三种基于ClassVisitor API的核心组件来产生和转换类，

l  ClassReader类解析一个给定的编译好的类的字节数组，调用ClassVisitor实例中的visitXXX方法，这个ClassVistor实例是作为accept的参数传入的。它可以被看做是事件的生产者。

l  ClassWriter类是ClassVistor的子类，它将编译后的类直接以二进制的形式构建。它输出一个包括编译好的类的字节数组（可以通过toByteArray方法获得）。它被看做是事件的消费者。

l  ClassVistor类代理了所有的来自其他ClassVistor实例的方法调用。它被看做是事件的过滤者。

2.2.2 解析类

解析一个现有的类需要的组件只是ClassReader。例子，我们需要打印一个类的内容，首先我们写一个ClassVistor的子类来打印它所访问的类的信息。

ClassPrinter cp = new ClassPrinter();
ClassReader cr = new ClassReader("java.lang.Runnable");
cr.accept(cp, 0);

由于ClassPrinter是ClassVistor的子类，前面提到了，ClassReader的accept方法需要传入一个ClassVistor,所以讲将cp作为accept的参数。

运行结果是：

java/lang/Runnable extends java/lang/Object {
run()V
}

注意，有许多方法构建ClassReader实例。可以被访问的类可以是用名字标注的（如上例），或者通过字节数组值或者作为一个InputStream。可以通过ClassLoader的getResourceAsStream方法来获得一个input stream。如：

cl.getResourceAsStream(classname.replace(’.’,
’/’) + ".class");

2.2.3 产生类

为了产生一个类，唯一需要的组件就是ClassWriter组件。

可以借助ClassLoader（说明中有两种方法）动态加载一个产生的类。

2.2.4 转换类

这里讲述将ClassReader和ClassWriter组件一起用，结果就是被Class reader解析的类会被class writer重建。

byte[] b1 = ...;
ClassWriter cw = new ClassWriter(0);
// cv forwards all events to cw
ClassVisitor cv = new ClassVisitor(ASM4, cw) { };
ClassReader cr = new ClassReader(b1);
cr.accept(cv, 0);
byte[] b2 = cw.toByteArray(); // b2 represents the same class as b1

优化：

使用上面的方法，仅仅修改了jdk版本，绝大多数没有改变。b2是通过抓取b1的方式的方式构建的。更高效的做法是直接拷贝不需要改变的部分，这样，这一部分就不需进行解析和产生响应的事件了。ASM可以自动进行这样的优化。

2.2.5 删除类成员

不将函数调用进行转发，相当于相应的类元素被移除了。

但是这样的策略对fields和methods是无法奏效的，因为visitField和visitMethod方法必须有一个返回值，所以此时返回一个null即可。

注意：想要指明一个方法需要同时支出函数名和描述符。因为可能会有很多方法具有相同的名字但是具有不同的参数。

2.2.6添加类成员

和不转发方法调用不同的是，转发的更多就相当于添加了一些类元素。

Note: in fact the
only truly correct solution is to add new members by making additional calls in
the visitEnd method. Indeed a class must not contain duplicate members, and the
only way to be sure that a new member is unique is to compare it with all the existing
members, which can only be done once they have all been visited, i.e. in the
visitEnd method. This is rather constraining. Using generated names that are
unlikely to be used by a programmer, such as _counter$ or _4B7F_ is sufficient in
practice to avoid duplicate members without having to add them in visitEnd.
Note that, as discussed in the first chapter, the tree API does not have this
limitation: it is possible to add new members at any time inside a
transformation with this API.

示例：添加一个变量的做法，在visitField中判断要添加的变量是否已经存在，若不存在，则在visitEnd方法中添加这个变量。