天天看点
返回

java动态代理之 asm字节码编辑器

ASM是一个Java字节码操纵框架，它能被用来动态生成类或者增强既有类的功能。ASM可以直接产生二进制class文件，也可以在类被加载入Java虚拟机之前动态改变类行为。Java class被存储在严格格式定义的.class文件里，这些类文件拥有足够的元数据来解析类中的所有元素：类名称、方法、属性以及 Java 字节码（指令）。ASM从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。

目前许多框架如cglib、Hibernate、Spring都直接或间接地使用ASM操作字节码，有些语言如Jython、JRuby、Groovy也是如此。而类ASM字节码工具还有：

  1. BCEL：Byte Code Engineering Library (BCEL)，这是Apache Software Foundation 的Jakarta 项目的一部分。BCEL是 Java classworking 最广泛使用的一种框架,它可以让您深入 JVM 汇编语言进行类操作的细节。BCEL与Javassist 有不同的处理字节码方法，BCEL在实际的JVM 指令层次上进行操作(BCEL拥有丰富的JVM 指令级支持)而Javassist 所强调的源代码级别的工作。
  2. JBET：通过JBET(Java Binary Enhancement Tool )的API可对Class文件进行分解，重新组合，或被编辑。JBET也可以创建新的Class文件。JBET用一种结构化的方式来展现Javabinary (.class)文件的内容，并且可以很容易的进行修改。
  3. Javassist：Javassist是一个开源的分析、编辑和创建Java字节码的类库。是由东京技术学院的数学和计算机科学系的 Shigeru Chiba 所创建的。它已加入了开放源代码JBoss 应用服务器项目,通过使用Javassist对字节码操作为JBoss实现动态AOP框架。
  4. cglib：是一个强大的,高性能,高质量的Code生成类库。它可以在运行期扩展Java类与实现Java接口，cglib封装了asm，可以在运行期动态生成新的 class，Hibernate和Spring都用到过它。cglib用于AOP，jdk中的proxy必须基于接口，cglib却没有这个限制。

而ASM与cglib、serp和BCEL相比，ASM有以下的优点 :

  • ASM 具有简单、设计良好的 API，这些 API 易于使用；
  • ASM 有非常良好的开发文档，以及可以帮助简化开发的 Eclipse 插件；
  • ASM 支持 Java 6(ASM3)、Java7(ASM4)、Java(ASM5)；
  • ASM 很小、很快、很健壮；
  • ASM 有很大的用户群，可以帮助新手解决开发过程中遇到的问题；
  • ASM 的开源许可可以让你几乎以任何方式使用它；

JVM指令

如果使用ASM框架，需要对JVM指令和Java字节码文件的结构都需要有点概念。JVM指令总结如下（详细看参考本文底部的PS）

  1. 凡是带const的表示将什么数据压操作数栈；如：
  2. iconst_2 将int型数据2压入到操作数栈；
  3. aconst_null  将null值压入栈；
  4. bipush和sipush  表示将单字节或者短整形的常量值压入操作数栈；
  5. 带ldc的表示将什么类型数据从常量池中压入到操作数栈；如：
  6. ldc_w  将int或者flat或者string类型的数据压入到操作数栈；
  7. ldc2_w  将long或者double类型的数据压入到操作数栈；
  8. 凡是带load的指令表示将某类型的局部变量数据压入到操作数栈的栈顶；如：
  9. iload 表示将int类型的局部变量压入到操作数栈的栈顶；
  10. aload  以a开头的表示将引用类型的局部变量压入到操作数栈的栈顶；
  11. iload_1 将局部变量数组里面下标为1的int类型的数据压入到操作数栈；
  12. iaload   将int型数组的指定索引的值压入到操作数栈；
  13. 凡是带有store指令的表示将操作数栈顶的某类型的值存入指定的局部变量中；如：
  14. istore  表示将栈顶int类型的数据存入到指定的局部变量中；
  15. istore_3  表示将栈int类型的数据存入到局部变量数组的下标为3的元素中；
  16. pop  将栈顶数据弹出；pop2将栈顶的一个long或者double数据从栈顶弹出来；
  17. dup  复制栈顶的数据并将复制的值也压入到栈顶；
  18. dup2  复制栈顶一个long或者是double的数据并将复制的值也压入到栈顶；
  19. swap  将栈最顶端的两个值互换；
  20. iadd 将栈顶两个int型的数据相加然后将结果再次的压入到栈顶；
  21. isub 将栈顶两个int型的数据相减然后将结果再次的压入到栈顶；   
  22. imul 将栈顶两个int型的数据相乘然后将结果再次的压入到栈顶；
  23. idiv  将栈顶两个int型的数据相除然后将结果再次的压入到栈顶；
  24. irem 将栈顶两个int型的数据取模运算然后将结果再次的压入到栈顶；
  25. ineg 将栈顶的int数据取负将结果压入到栈顶；
  26. iinc  将指定的int变量增加指定值(i++,i--,i+=2)；
  27. i2l   将栈顶int类型数据强制转换成long型将结果压入到栈顶；
  28. lcmp  将栈顶两long型数据的大小进行比较，并将结果(1,0,-1)压入栈顶；
  29. 以if开头的指令都是跳转指令；
  30. tableswitch、lookupswitch  表示用switch条件跳转；
  31. ireturn  从当前方法返回int型数据；
  32. getstatic  获取指定类的静态域，将将结果压入到栈顶；
  33. putstatic 为指定的类的静态域赋值；
  34. getfield   获取指定类的实例变量，将结果压入到栈顶；
  35. putfield   为指定类的实例变量赋值；
  36. invokevirtual  调用实例方法；
  37. invokespacial  调用超类构造方法，实例初始化方法，私有方法；
  38. invokestatic  调用静态方法；
  39. invokeinterface  调用接口方法； 
  40. new 创建一个对象，并将其引用压入到栈顶；
  41. newarray  创建一个原始类型的数组，并将其引用压入到栈顶；
  42. arraylength   获得一个数组的长度，将将结果压入到栈顶；
  43. athrow   将栈顶的异常抛出；
  44. checkcast  检验类型转换，转换未通过，将抛出ClassCastException.
  45. instanceof 检验对象是否是指定的类的实例，如果是将1压入栈顶，否则将0压入栈顶 
  46. monitorenter   获得对象的锁，用于同步方法或同步块  
  47. monitorexit    释放对象的锁，用于同步方法或同步块
  48. ifnull    为null时跳转 
  49. ifnonnull   不为null时跳转

Java字节码文件

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

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

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

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

从上图中可以看到，一个 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编程模型

ASM 提供了两种编程模型：

  • Core API，提供了基于事件形式的编程模型。该模型不需要一次性将整个类的结构读取到内存中，因此这种方式更快，需要更少的内存。但这种编程方式难度较大。
  • Tree API，提供了基于树形的编程模型。该模型需要一次性将一个类的完整结构全部读取到内存当中，所以这种方法需要更多的内存。这种编程方式较简单。

Core API 中操纵字节码的功能基于 ClassVisitor 接口。这个接口中的每个方法对应了 class 文件中的每一项。Class 文件中的简单项的访问使用一个单独的方法，方法参数描述了这个项的内容。而那些具有任意长度和复杂度的项，使用另外一类方法，这类方法会返回一个辅助的 Visitor 接口，通过这些辅助接口的对象来完成具体内容的访问。例如 visitField 方法和 visitMethod 方法，分别返回 FieldVisitor 和 MethodVisitor 接口的对象。

ASM 提供了三个基于 ClassVisitor 接口的类来实现 class 文件的生成和转换：

  • ClassReader：ClassReader 解析一个类的 class 字节码，该类的 accept 方法接受一个 ClassVisitor 的对象，在 accept 方法中，会按上文描述的顺序逐个调用 ClassVisitor 对象的方法。它可以被看做事件的生产者。
  • ClassAdapter：ClassAdapter 是 ClassVisitor 的实现类。它的构造方法中需要一个 ClassVisitor 对象，并保存为字段 protected ClassVisitor cv。在它的实现中，每个方法都是原封不动的直接调用 cv 的对应方法，并传递同样的参数。可以通过继承 ClassAdapter 并修改其中的部分方法达到过滤的作用。它可以看做是事件的过滤器。
  • ClassWriter：ClassWriter 也是 ClassVisitor 的实现类。ClassWriter 可以用来以二进制的方式创建一个类的字节码。对于 ClassWriter 的每个方法的调用会创建类的相应部分。例如：调用 visit 方法就是创建一个类的声明部分，每调用一次 visitMethod 方法就会在这个类中创建一个新的方法。在调用 visitEnd 方法后即表明该类的创建已经完成。它最终生成一个字节数组，这个字节数组中包含了一个类的 class 文件的完整字节码内容 。可以通过 toByteArray 方法获取生成的字节数组。ClassWriter 可以看做事件的消费者。

通常情况下，它们是组合起来使用的。

ASM示例

项目结构如下：

HelloWorld.java代码如下：

  1. package net.oseye.demoasm;
  2. public class HelloWorld {
  3. public void sayHello() {
  4. System.out.println("Hello World!");
  5. }
  6. }

如果我们想动态地在HelloWorld.java的sayHello方法中加入打印时间如：

  1. package net.oseye.demoasm;
  2. public class HelloWorld {
  3. public void sayHello() {
  4. System.out.println(System.currentTimeMillis());
  5. System.out.println("Hello World!");
  6. }
  7. }

怎么做呢？

直接编码ASM其实对于新手来说是很困难的事，但幸运的是ASM给我们提供了ASMifer工具。一般我们会使用ASM的ASMifer工具生成ASM结构来对比，使用命令：

  1. java org.objectweb.asm.util.ASMifier net.oseye.demoasm.HelloWorld

记得"asm-util-x.x.jar"需要在classpath中，如果没有记得设置classpath，生成没加入打印时间的HelloWorld.Class的ASM结构如下：

  1. package asm.net.oseye.demoasm;
  2. import java.util.*;
  3. import org.objectweb.asm.*;
  4. import org.objectweb.asm.attrs.*;
  5. public class HelloWorldDump implements Opcodes {
  6. public static byte[] dump () throws Exception {
  7. ClassWriter cw = new ClassWriter(0);
  8. FieldVisitor fv;
  9. MethodVisitor mv;
  10. AnnotationVisitor av0;
  11. cw.visit(V1_5, ACC_PUBLIC + ACC_SUPER, "net/oseye/demoasm/HelloWorld", null, "ja
  12. va/lang/Object", null);
  13. {
  14. mv = cw.visitMethod(ACC_PUBLIC, "<init>", "()V", null, null);
  15. mv.visitCode();
  16. mv.visitVarInsn(ALOAD, 0);
  17. mv.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "<init>", "()V");
  18. mv.visitInsn(RETURN);
  19. mv.visitMaxs(1, 1);
  20. mv.visitEnd();
  21. }
  22. {
  23. mv = cw.visitMethod(ACC_PUBLIC, "sayHello", "()V", null, null);
  24. mv.visitCode();
  25. mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
  26. ;
  27. mv.visitLdcInsn("Hello World!");
  28. mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang
  29. /String;)V");
  30. mv.visitInsn(RETURN);
  31. mv.visitMaxs(2, 1);
  32. mv.visitEnd();
  33. }
  34. cw.visitEnd();
  35. return cw.toByteArray();
  36. }
  37. }

而加入打印时间的ASM结构如下：

  1. package asm.net.oseye.demoasm;
  2. import java.util.*;
  3. import org.objectweb.asm.*;
  4. import org.objectweb.asm.attrs.*;
  5. public class HelloWorldDump implements Opcodes {
  6. public static byte[] dump () throws Exception {
  7. ClassWriter cw = new ClassWriter(0);
  8. FieldVisitor fv;
  9. MethodVisitor mv;
  10. AnnotationVisitor av0;
  11. cw.visit(V1_5, ACC_PUBLIC + ACC_SUPER, "net/oseye/demoasm/HelloWorld", null, "ja
  12. va/lang/Object", null);
  13. {
  14. mv = cw.visitMethod(ACC_PUBLIC, "<init>", "()V", null, null);
  15. mv.visitCode();
  16. mv.visitVarInsn(ALOAD, 0);
  17. mv.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "<init>", "()V");
  18. mv.visitInsn(RETURN);
  19. mv.visitMaxs(1, 1);
  20. mv.visitEnd();
  21. }
  22. {
  23. mv = cw.visitMethod(ACC_PUBLIC, "sayHello", "()V", null, null);
  24. mv.visitCode();
  25. mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
  26. ;
  27. mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J")
  28. ;
  29. mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(J)V");
  30. mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
  31. ;
  32. mv.visitLdcInsn("Hello World!");
  33. mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang
  34. /String;)V");
  35. mv.visitInsn(RETURN);
  36. mv.visitMaxs(3, 1);
  37. mv.visitEnd();
  38. }
  39. cw.visitEnd();
  40. return cw.toByteArray();
  41. }
  42. }

对比我们发现后者比前者多了：

  1. mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
  2. ;
  3. mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J")
  4. ;
  5. mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(J)V");

因此App.java可以这样编码：

  1. package net.oseye.demoasm;
  2. import java.io.IOException;
  3. import java.lang.reflect.InvocationTargetException;
  4. import org.objectweb.asm.ClassReader;
  5. import org.objectweb.asm.ClassVisitor;
  6. import org.objectweb.asm.ClassWriter;
  7. import org.objectweb.asm.MethodVisitor;
  8. import org.objectweb.asm.Opcodes;
  9. public class App extends ClassLoader implements Opcodes {
  10. public static void main(String[] args) throws IOException, IllegalAccessException, IllegalArgumentException, InvocationTargetException, SecurityException, InstantiationException {
  11. ClassReader cr=new ClassReader(HelloWorld.class.getName());
  12. ClassWriter cw=new ClassWriter(ClassWriter.COMPUTE_MAXS);
  13. CustomVisitor myv=new CustomVisitor(Opcodes.ASM4,cw);
  14. cr.accept(myv, 0);
  15. byte[] code=cw.toByteArray();
  16. //自定义加载器
  17. App loader=new App();
  18. Class<?> appClass=loader.defineClass(null, code, 0,code.length);
  19. appClass.getMethods()[0].invoke(appClass.newInstance(), new Object[]{});
  20. // FileOutputStream f=new FileOutputStream(new File("d:"+File.separator+"ok2.class"));
  21. // f.write(code);;
  22. // f.close();
  23. }
  24. }
  25. class CustomVisitor extends ClassVisitor implements Opcodes {
  26. public CustomVisitor(int api, ClassVisitor cv) {
  27. super(api, cv);
  28. }
  29. @Override
  30. public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
  31. MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
  32. if (name.equals("sayHello")) {
  33. mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
  34. mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J");
  35. mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(J)V");
  36. }
  37. return mv;
  38. }
  39. }

运行可以看到类似这样的输出：

1405587042484

Hello World!

当然你也可以把通过ASM生成的class保存到磁盘然后加载。

字节码 代理
上一篇: APP不适合做数字化运维？其实不然，APP可以在巡检维修上报方面发挥良好作用[灵光一闪][灵光一闪]
下一篇: Javassist学习总结1

继续阅读