06 - ASM之ClassVisitor

作者: 舍是境界 | 来源:发表于2022-01-15 07:37 被阅读0次

06 - ASM之ClassVisitor
ASM框架学习(二)-ClassVisitor
ClassVisitor 解析
45 - ASM之TraceClassVisitor
32 - ASM之Class Transformation的原理
ASM files number 10 and 11
C代码中嵌入汇编代码
07 - ASM之ClassWriter
Java ASM 与Aop简单实现(Version:asm5.0
43 - ASM之asm-util和asm-commons

在ASM Core API中，最重要的三个类就是ClassReader、ClassVisitor和ClassWriter类。在进行Class Generation操作的时候，ClassVisitor和ClassWriter这两个类起着重要作用，而并不需要ClassReader类的参与。在本文当中，我们将对ClassVisitor类进行介绍。

ClassReader、ClassVistor、ClassWriter

ClassVisitor类

class info

ClassVisitor是一个抽象类。由于ClassVisitor类是一个abstract类，所以不能直接使用new关键字创建ClassVisitor对象。

public abstract class ClassVisitor {
}

同时，由于ClassVisitor类是一个abstract类，要想使用它，就必须有具体的子类来继承它。比较常见的ClassVisitor子类有ClassWriter类（Core API）和ClassNode类（Tree API）。

public class ClassWriter extends ClassVisitor {
}

public class ClassNode extends ClassVisitor {
}

fields

ClassVisitor类定义的字段有哪些。

public abstract class ClassVisitor {
    protected final int api;
    protected ClassVisitor cv;
}

api字段：它是一个int类型的数据，指出了当前使用的ASM API版本，其取值有Opcodes.ASM4、Opcodes.ASM5、Opcodes.ASM6、Opcodes.ASM7、Opcodes.ASM8和Opcodes.ASM9。我们使用的ASM版本是9.0，因此我们在给api字段赋值的时候，选择Opcodes.ASM9就可以了。
cv字段：它是一个ClassVisitor类型的数据，它的作用是将多个ClassVisitor串连起来。

ClassVistor链表结构示意图

constructors

ClassVisitor类定义的构造方法有哪些。

public abstract class ClassVisitor {
    public ClassVisitor(final int api) {
        this(api, null);
    }

    public ClassVisitor(final int api, final ClassVisitor classVisitor) {
        this.api = api;
        this.cv = classVisitor;
    }
}

methods

ClassVisitor类定义的方法有哪些。在ASM当中，使用到了Visitor Pattern（访问者模式），所以ClassVisitor当中许多的visitXxx()方法。

虽然，在ClassVisitor类当中，有许多visitXxx()方法，但是，我们只需要关注这4个方法：visit()、visitField()、visitMethod()和visitEnd()。因为这4个方法是ClassVisitor类的精髓或骨架，认识了这4个方法，其它的visitXxx()都容易扩展；

public abstract class ClassVisitor {
    public void visit(
        final int version,
        final int access,
        final String name,
        final String signature,
        final String superName,
        final String[] interfaces);
    public FieldVisitor visitField( // 访问字段
        final int access,
        final String name,
        final String descriptor,
        final String signature,
        final Object value);
    public MethodVisitor visitMethod( // 访问方法
        final int access,
        final String name,
        final String descriptor,
        final String signature,
        final String[] exceptions);
    public void visitEnd();
    // ......
}

在ClassVisitor的visit()方法、visitField()方法和visitMethod()方法中都带有signature参数。这个signature参数“泛型”密切相关；换句话说，如果处理的是一个带有泛型信息的类、字段或方法，那么就需要给signature参数提供一定的值；如果处理的类、字段或方法不带有“泛型”信息，那么将signature参数设置为null就可以了。

如果大家对signature参数感兴趣，我们可以使用之前介绍的ASMPrint类去打印一下某个泛型类的ASM代码。例如，java.lang.Comparable是一个泛型接口，我们就可以使用ASMPrint类来打印一下它的ASM代码，从来查看signature参数的值是什么。

方法的调用顺序

在ClassVisitor类当中，定义了多个visitXxx()方法。这些visitXxx()方法，遵循一定的调用顺序。这个调用顺序，是参考自ClassVisitor类的API文档。

visit
[visitSource][visitModule][visitNestHost][visitPermittedSubclass][visitOuterClass]
(
 visitAnnotation |
 visitTypeAnnotation |
 visitAttribute
)*
(
 visitNestMember |
 visitInnerClass |
 visitRecordComponent |
 visitField |
 visitMethod
)* 
visitEnd

其中，涉及到一些符号，它们的含义如下：

[]: 表示最多调用一次，可以不调用，但最多调用一次。
()和|: 表示在多个方法之间，可以选择任意一个，并且多个方法之间不分前后顺序。
*: 表示方法可以调用0次或多次。

根据我们关注的四个visit方法，模型我们可以简化如下：

visit
(
 visitField |
 visitMethod
)* 
visitEnd

也就是说，先调用visit()方法，接着调用visitField()方法或visitMethod()方法，最后调用visitEnd()方法。

visitXxx()方法与ClassFile

ClassVisitor的visitXxx()方法与ClassFile之间存在对应关系。在ClassVisitor中定义的visitXxx()方法，并不是凭空产生的，这些方法存在的目的就是为了生成一个合法的.class文件，而这个.class文件要符合ClassFile的结构，所以这些visitXxx()方法与ClassFile的结构密切相关。

visit()方法

public void visit(
    final int version,
    final int access,
    final String name,
    final String signature,
    final String superName,
    final String[] interfaces);

ClassFile {
    u4             magic;
    u2             minor_version;
    u2             major_version;
    u2             constant_pool_count;
    cp_info        constant_pool[constant_pool_count-1];
    u2             access_flags;
    u2             this_class;
    u2             super_class;
    u2             interfaces_count;
    u2             interfaces[interfaces_count];
    u2             fields_count;
    field_info     fields[fields_count];
    u2             methods_count;
    method_info    methods[methods_count];
    u2             attributes_count;
    attribute_info attributes[attributes_count];
}

ClassVistor与class信息对应关系图

visitField()方法

public FieldVisitor visitField( // 访问字段
    final int access,
    final String name,
    final String descriptor,
    final String signature,
    final Object value);

field_info {
    u2             access_flags;
    u2             name_index;
    u2             descriptor_index;
    u2             attributes_count;
    attribute_info attributes[attributes_count];
}

visitFileds与class对应图

visitMethod()方法

public MethodVisitor visitMethod( // 访问方法
    final int access,
    final String name,
    final String descriptor,
    final String signature,
    final String[] exceptions);

method_info {
    u2             access_flags;
    u2             name_index;
    u2             descriptor_index;
    u2             attributes_count;
    attribute_info attributes[attributes_count];
}

visitMethod与class对应关系图

visitEnd()方法

visitEnd()方法，它是这些visitXxx()方法当中最后一个调用的方法。

为什么visitEnd()方法是“最后一个调用的方法”呢？是因为在ClassVisitor当中，定义了多个visitXxx()方法，这些个visitXxx()方法之间要遵循一个先后调用的顺序，而visitEnd()方法是最后才去调用的。等到visitEnd()方法调用之后，就表示说再也不去调用其它的visitXxx()方法了，所有的“工作”已经做完了，到了要结束的时候了。

/*
 * Visits the end of the class.
 * This method, which is the last one to be called,
 * is used to inform the visitor that all the fields and methods of the class have been visited.
 */
public void visitEnd() {
    if (cv != null) {
        cv.visitEnd();
    }
}