【转】AOP 的利器：ASM 3.0 介绍(二)

所谓 Java 类文件，就是通常用 javac 编译器产生的 .class 文件。这些文件具有严格定义的格式。为了更好的理解 ASM，首先对 Java 类文件格式作一点简单的介绍。Java 源文件经过 javac 编译器编译之后，将会生成对应的二进制文件（如下图所示）。每个合法的 Java 类文件都具备精确的定义，而正是这种精确的定义，才使得 Java 虚拟机得以正确读取和解释所有的 Java 类文件。

图 2. ASM – Javac 流程

Java 类文件是 8 位字节的二进制流。数据项按顺序存储在 class 文件中，相邻的项之间没有间隔，这使得 class 文件变得紧凑，减少存储空间。在 Java 类文件中包含了许多大小不同的项，由于每一项的结构都有严格规定，这使得 class 文件能够从头到尾被顺利地解析。下面让我们来看一下 Java 类文件的内部结构，以便对此有个大致的认识。

例如，一个最简单的 Hello World 程序：

 public class HelloWorld { 
 public static void main(String[] args) { 
 System.out.println("Hello world"); 
 } 
 }

经过 javac 编译后，得到的类文件大致是：

图 3. ASM – Java 类文件

从上图中可以看到，一个 Java 类文件大致可以归为 10 个项：

Magic：该项存放了一个 Java 类文件的魔数（magic number）和版本信息。一个 Java 类文件的前 4 个字节被称为它的魔数。每个正确的 Java 类文件都是以 0xCAFEBABE 开头的，这样保证了 Java 虚拟机能很轻松的分辨出 Java 文件和非 Java 文件。
Version：该项存放了 Java 类文件的版本信息，它对于一个 Java 文件具有重要的意义。因为 Java 技术一直在发展，所以类文件的格式也处在不断变化之中。类文件的版本信息让虚拟机知道如何去读取并处理该类文件。
Constant Pool：该项存放了类中各种文字字符串、类名、方法名和接口名称、final 变量以及对外部类的引用信息等常量。虚拟机必须为每一个被装载的类维护一个常量池，常量池中存储了相应类型所用到的所有类型、字段和方法的符号引用，因此它在 Java 的动态链接中起到了核心的作用。常量池的大小平均占到了整个类大小的 60% 左右。
Access_flag：该项指明了该文件中定义的是类还是接口（一个 class 文件中只能有一个类或接口），同时还指名了类或接口的访问标志，如 public，private, abstract 等信息。
This Class：指向表示该类全限定名称的字符串常量的指针。
Super Class：指向表示父类全限定名称的字符串常量的指针。
Interfaces：一个指针数组，存放了该类或父类实现的所有接口名称的字符串常量的指针。以上三项所指向的常量，特别是前两项，在我们用 ASM 从已有类派生新类时一般需要修改：将类名称改为子类名称；将父类改为派生前的类名称；如果有必要，增加新的实现接口。
Fields：该项对类或接口中声明的字段进行了细致的描述。需要注意的是，fields 列表中仅列出了本类或接口中的字段，并不包括从超类和父接口继承而来的字段。
Methods：该项对类或接口中声明的方法进行了细致的描述。例如方法的名称、参数和返回值类型等。需要注意的是，methods 列表里仅存放了本类或本接口中的方法，并不包括从超类和父接口继承而来的方法。使用 ASM 进行 AOP 编程，通常是通过调整 Method 中的指令来实现的。
Class attributes：该项存放了在该文件中类或接口所定义的属性的基本信息。

事实上，使用 ASM 动态生成类，不需要像早年的 class hacker 一样，熟知 class 文件的每一段，以及它们的功能、长度、偏移量以及编码方式。ASM 会给我们照顾好这一切的，我们只要告诉 ASM 要改动什么就可以了 —— 当然，我们首先得知道要改什么：对类文件格式了解的越多，我们就能更好地使用 ASM 这个利器。

ASM 3.0 编程框架

ASM 通过树这种数据结构来表示复杂的字节码结构，并利用 Push 模型来对树进行遍历，在遍历过程中对字节码进行修改。所谓的 Push 模型类似于简单的 Visitor 设计模式，因为需要处理字节码结构是固定的，所以不需要专门抽象出一种 Vistable 接口，而只需要提供 Visitor 接口。所谓 Visitor 模式和 Iterator 模式有点类似，它们都被用来遍历一些复杂的数据结构。Visitor 相当于用户派出的代表，深入到算法内部，由算法安排访问行程。Visitor 代表可以更换，但对算法流程无法干涉，因此是被动的，这也是它和 Iterator 模式由用户主动调遣算法方式的最大的区别。

在 ASM 中，提供了一个 ClassReader类，这个类可以直接由字节数组或由 class 文件间接的获得字节码数据，它能正确的分析字节码，构建出抽象的树在内存中表示字节码。它会调用 accept方法，这个方法接受一个实现了 ClassVisitor接口的对象实例作为参数，然后依次调用 ClassVisitor接口的各个方法。字节码空间上的偏移被转换成 visit 事件时间上调用的先后，所谓 visit 事件是指对各种不同 visit 函数的调用，ClassReader知道如何调用各种 visit 函数。在这个过程中用户无法对操作进行干涉，所以遍历的算法是确定的，用户可以做的是提供不同的 Visitor 来对字节码树进行不同的修改。ClassVisitor会产生一些子过程，比如visitMethod会返回一个实现 MethordVisitor接口的实例，visitField会返回一个实现 FieldVisitor接口的实例，完成子过程后控制返回到父过程，继续访问下一节点。因此对于 ClassReader来说，其内部顺序访问是有一定要求的。实际上用户还可以不通过 ClassReader类，自行手工控制这个流程，只要按照一定的顺序，各个 visit 事件被先后正确的调用，最后就能生成可以被正确加载的字节码。当然获得更大灵活性的同时也加大了调整字节码的复杂度。

各个 ClassVisitor通过职责链（Chain-of-responsibility）模式，可以非常简单的封装对字节码的各种修改，而无须关注字节码的字节偏移，因为这些实现细节对于用户都被隐藏了，用户要做的只是覆写相应的 visit 函数。

ClassAdaptor类实现了 ClassVisitor接口所定义的所有函数，当新建一个 ClassAdaptor对象的时候，需要传入一个实现了ClassVisitor接口的对象，作为职责链中的下一个访问者（Visitor），这些函数的默认实现就是简单的把调用委派给这个对象，然后依次传递下去形成职责链。当用户需要对字节码进行调整时，只需从 ClassAdaptor类派生出一个子类，覆写需要修改的方法，完成相应功能后再把调用传递下去。这样，用户无需考虑字节偏移，就可以很方便的控制字节码。

每个 ClassAdaptor类的派生类可以仅封装单一功能，比如删除某函数、修改字段可见性等等，然后再加入到职责链中，这样耦合更小，重用的概率也更大，但代价是产生很多小对象，而且职责链的层次太长的话也会加大系统调用的开销，用户需要在低耦合和高效率之间作出权衡。用户可以通过控制职责链中 visit 事件的过程，对类文件进行如下操作：

删除类的字段、方法、指令：只需在职责链传递过程中中断委派，不访问相应的 visit 方法即可，比如删除方法时只需直接返回 null，而不是返回由 visitMethod方法返回的 MethodVisitor对象。

 class DelLoginClassAdapter extends ClassAdapter { 
 public DelLoginClassAdapter(ClassVisitor cv) { 
 super(cv); 
 } 

 public MethodVisitor visitMethod(final int access, final String name, 
 final String desc, final String signature, final String[] exceptions) { 
 if (name.equals("login")) { 
 return null; 
 } 
 return cv.visitMethod(access, name, desc, signature, exceptions); 
 } 
 }

修改类、字段、方法的名字或修饰符：在职责链传递过程中替换调用参数。

 class AccessClassAdapter extends ClassAdapter { 
 public AccessClassAdapter(ClassVisitor cv) { 
 super(cv); 
 } 

 public FieldVisitor visitField(final int access, final String name, 
        final String desc, final String signature, final Object value) { 
        int privateAccess = Opcodes.ACC_PRIVATE; 
        return cv.visitField(privateAccess, name, desc, signature, value); 
    } 
 }

增加新的类、方法、字段

ASM 的最终的目的是生成可以被正常装载的 class 文件，因此其框架结构为客户提供了一个生成字节码的工具类 ——ClassWriter。它实现了 ClassVisitor接口，而且含有一个 toByteArray()函数，返回生成的字节码的字节流，将字节流写回文件即可生产调整后的 class 文件。一般它都作为职责链的终点，把所有 visit 事件的先后调用（时间上的先后），最终转换成字节码的位置的调整（空间上的前后），如下例：

 ClassWriter  classWriter = new ClassWriter(ClassWriter.COMPUTE_MAXS); 
 ClassAdaptor delLoginClassAdaptor = new DelLoginClassAdapter(classWriter); 
 ClassAdaptor accessClassAdaptor = new AccessClassAdaptor(delLoginClassAdaptor); 

 ClassReader classReader = new ClassReader(strFileName); 
 classReader.accept(classAdapter, ClassReader.SKIP_DEBUG);

综上所述，ASM 的时序图如下：

图 4. ASM – 时序图

使用 ASM3.0 进行 AOP 编程

我们还是用上面的例子，给 Account类加上 security check 的功能。与 proxy 编程不同，ASM 不需要将 Account声明成接口，Account可以仍旧是一个实现类。ASM 将直接在 Account类上动手术，给 Account类的 operation方法首部加上对SecurityChecker.checkSecurity的调用。

首先，我们将从 ClassAdapter继承一个类。ClassAdapter是 ASM 框架提供的一个默认类，负责沟通 ClassReader和ClassWriter。如果想要改变 ClassReader处读入的类，然后从 ClassWriter处输出，可以重写相应的 ClassAdapter函数。这里，为了改变 Account类的 operation 方法，我们将重写 visitMethdod方法。

class AddSecurityCheckClassAdapter extends ClassAdapter {

    public AddSecurityCheckClassAdapter(ClassVisitor cv) {
        //Responsechain 的下一个 ClassVisitor，这里我们将传入 ClassWriter，
        // 负责改写后代码的输出
        super(cv); 
    } 
    
    // 重写 visitMethod，访问到 "operation" 方法时，
    // 给出自定义 MethodVisitor，实际改写方法内容
    public MethodVisitor visitMethod(final int access, final String name, 
        final String desc, final String signature, final String[] exceptions) { 
        MethodVisitor mv = cv.visitMethod(access, name, desc, signature,exceptions);
        MethodVisitor wrappedMv = mv; 
        if (mv != null) { 
            // 对于 "operation" 方法
            if (name.equals("operation")) { 
                // 使用自定义 MethodVisitor，实际改写方法内容
                wrappedMv = new AddSecurityCheckMethodAdapter(mv); 
            } 
        } 
        return wrappedMv; 
    } 
}

下一步就是定义一个继承自 MethodAdapter的 AddSecurityCheckMethodAdapter，在“operation”方法首部插入对SecurityChecker.checkSecurity()的调用。

 class AddSecurityCheckMethodAdapter extends MethodAdapter { 
 public AddSecurityCheckMethodAdapter(MethodVisitor mv) { 
 super(mv); 
 } 

 public void visitCode() { 
 visitMethodInsn(Opcodes.INVOKESTATIC, "SecurityChecker", 
"checkSecurity", "()V"); 
 } 
 }

其中，ClassReader读到每个方法的首部时调用 visitCode()，在这个重写方法里，我们用visitMethodInsn(Opcodes.INVOKESTATIC, "SecurityChecker","checkSecurity", "()V");插入了安全检查功能。

最后，我们将集成上面定义的 ClassAdapter，ClassReader和 ClassWriter产生修改后的 Account类文件 :

 import java.io.File; 
 import java.io.FileOutputStream; 
 import org.objectweb.asm.*; 
    
 public class Generator{ 
 public static void main() throws Exception { 
 ClassReader cr = new ClassReader("Account"); 
 ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS); 
 ClassAdapter classAdapter = new AddSecurityCheckClassAdapter(cw); 
 cr.accept(classAdapter, ClassReader.SKIP_DEBUG); 
 byte[] data = cw.toByteArray(); 
 File file = new File("Account.class"); 
 FileOutputStream fout = new FileOutputStream(file); 
 fout.write(data); 
 fout.close(); 
 } 
 }

执行完这段程序后，我们会得到一个新的 Account.class 文件，如果我们使用下面代码：

 public class Main { 
 public static void main(String[] args) { 
 Account account = new Account(); 
 account.operation(); 
 } 
 }

使用这个 Account，我们会得到下面的输出：

 SecurityChecker.checkSecurity ... 
 operation...

也就是说，在 Account原来的 operation内容执行之前，进行了 SecurityChecker.checkSecurity()检查。

将动态生成类改造成原始类 Account 的子类

上面给出的例子是直接改造 Account类本身的，从此 Account类的 operation方法必须进行 checkSecurity 检查。但事实上，我们有时仍希望保留原来的 Account类，因此把生成类定义为原始类的子类是更符合 AOP 原则的做法。下面介绍如何将改造后的类定义为 Account的子类 Account$EnhancedByASM。其中主要有两项工作 :

改变 Class Description, 将其命名为 Account$EnhancedByASM，将其父类指定为 Account。
改变构造函数，将其中对父类构造函数的调用转换为对 Account构造函数的调用。

在 AddSecurityCheckClassAdapter类中，将重写 visit方法：

 public void visit(final int version, final int access, final String name, 
 final String signature, final String superName, 
 final String[] interfaces) { 
 String enhancedName = name + "$EnhancedByASM";  // 改变类命名
 enhancedSuperName = name; // 改变父类，这里是”Account”
 super.visit(version, access, enhancedName, signature, 
 enhancedSuperName, interfaces); 
 }

改进 visitMethod方法，增加对构造函数的处理：

 public MethodVisitor visitMethod(final int access, final String name, 
 final String desc, final String signature, final String[] exceptions) { 
 MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions); 
 MethodVisitor wrappedMv = mv; 
 if (mv != null) { 
 if (name.equals("operation")) { 
 wrappedMv = new AddSecurityCheckMethodAdapter(mv); 
 } else if (name.equals("<init>")) { 
 wrappedMv = new ChangeToChildConstructorMethodAdapter(mv, 
 enhancedSuperName); 
 } 
 } 
 return wrappedMv; 
 }

这里 ChangeToChildConstructorMethodAdapter将负责把 Account的构造函数改造成其子类 Account$EnhancedByASM的构造函数：

 class ChangeToChildConstructorMethodAdapter extends MethodAdapter { 
 private String superClassName; 

 public ChangeToChildConstructorMethodAdapter(MethodVisitor mv, 
 String superClassName) { 
 super(mv); 
 this.superClassName = superClassName; 
 } 

 public void visitMethodInsn(int opcode, String owner, String name, 
 String desc) { 
 // 调用父类的构造函数时
 if (opcode == Opcodes.INVOKESPECIAL && name.equals("<init>")) { 
 owner = superClassName; 
 } 
 super.visitMethodInsn(opcode, owner, name, desc);// 改写父类为 superClassName 
 } 
 }

最后演示一下如何在运行时产生并装入产生的 Account$EnhancedByASM。我们定义一个 Util 类，作为一个类工厂负责产生有安全检查的 Account类：

public class SecureAccountGenerator { 

    private static AccountGeneratorClassLoader classLoader = 
        new AccountGeneratorClassLoade(); 
    
    private static Class secureAccountClass; 
    
    public Account generateSecureAccount() throws ClassFormatError, 
        InstantiationException, IllegalAccessException { 
        if (null == secureAccountClass) {            
            ClassReader cr = new ClassReader("Account"); 
            ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS); 
            ClassAdapter classAdapter = new AddSecurityCheckClassAdapter(cw);
            cr.accept(classAdapter, ClassReader.SKIP_DEBUG); 
            byte[] data = cw.toByteArray(); 
            secureAccountClass = classLoader.defineClassFromClassFile( 
               "Account$EnhancedByASM",data); 
        } 
        return (Account) secureAccountClass.newInstance(); 
    } 
    
    private static class AccountGeneratorClassLoader extends ClassLoader {
        public Class defineClassFromClassFile(String className, 
            byte[] classFile) throws ClassFormatError { 
            return defineClass("Account$EnhancedByASM", classFile, 0, 
        classFile.length());
        } 
    } 
}

静态方法 SecureAccountGenerator.generateSecureAccount()在运行时动态生成一个加上了安全检查的 Account子类。著名的 Hibernate 和 Spring 框架，就是使用这种技术实现了 AOP 的“无损注入”。

小结

最后，我们比较一下 ASM 和其他实现 AOP 的底层技术：

表 1. AOP 底层技术比较

AOP 底层技术	功能	性能	面向接口编程	编程难度
直接改写 class 文件	完全控制类	无明显性能代价	不要求	高，要求对 class 文件结构和 Java 字节码有深刻了解
JDK Instrument	完全控制类	无论是否改写，每个类装入时都要执行 hook 程序	不要求	高，要求对 class 文件结构和 Java 字节码有深刻了解
JDK Proxy	只能改写 method	反射引入性能代价	要求	低
ASM	几乎能完全控制类	无明显性能代价	不要求	中，能操纵需要改写部分的 Java 字节码

posted on 2011-02-24 19:24 ZolRa 阅读(329) 评论(0) 收藏举报

刷新页面返回顶部

ZolRa

【转】AOP 的利器：ASM 3.0 介绍(二)

导航

公告