关于asm
xcjing 2016-08-26
asm解读
目的：
程序分析：用于分析程序，动态生成proxy等。
程序生成:可在内存中生成java类并编译，所谓的just in time complie
程序转换：优化程序插入debugging或平台观察代码(AOP)
ASM库提供生成、转换类的2种API，一直API是基于事件一种是基于数的。基于事件的就类似于xml的SAX，而基于树的就像DOM.这2种 API都有各自的有点与缺点。基于事件的API快速并且需要的内存比基于树的少。
组织结构：
org.objectweb.asm与org.objectweb.asm.signature是定义基于事件的API并提供了class的读写 组建。
org.objectweb.asm.util是工具包。
org.objectweb.asm.commons定义了预定义类的转行器
org.objectweb.asm.tree定义了基于树的API
org.objectweb.asm.tree.analysis定义了基于树API的分析框架和预定义类的分析器
java字节码的结构
+----------------------------------------------------+
|Modifiers, name, super class, interfaces |
+----------------------------------------------------+
|Constant pool: numeric, string and type constants |
+----------------------------------------------------+
|Source file name (optional) |
+----------------------------------------------------+
|Enclosing class reference |
+----------------------------------------------------+
|Annotation* |
+----------------------------------------------------+
|Attribute* |
+----------------------------------------------------+
|Inner class* Name |
+----------------------------------------------------+
|Field* Modifiers, name, type |
| Annotation* |
| Attribute* |
+----------------------------------------------------+
|Method* Modifiers, name, return and parameter types |
| Annotation* |
| Attribute* |
| Compiled code |
+----------------------------------------------------+
内部名
在class文件里面使用的是内部名，如String的内部名是 java/lang/String
类型描述：
java类型->类型描述
boolean->Z
char->C
byte->B
short->S
int->I
float->F
long->J
double->D
Object->Ljava/lang/Object;
int[]->[I
Object[][]->[[Ljava/lang/Object;
方法描述：
方法描述是类型描述列表，用于描述方法的参数类型以及返回值类型
方法声明->方法描述
void m(int i, float f)->(IF)V
int m(Object o)->(Ljava/lang/Object;)I
int[] m(int i, String s)->(ILjava/lang/String;)[I
Object m(int[] i)->([I)Ljava/lang/Object;
生成和解析编译好的类文件是基于ClassVisitor接口。这个接口的每个方法对应类文件相同的段名如下:
public interface ClassVisitor {
void visit(int version, int access, String name, String signature,
String superName, String[] interfaces);
void visitSource(String source, String debug);
void visitOuterClass(String owner, String name, String desc);
AnnotationVisitor visitAnnotation(String desc, boolean visible);
void visitAttribute(Attribute attr);
void visitInnerClass(String name, String outerName, String innerName,
int access);
FieldVisitor visitField(int access, String name, String desc,
String signature, Object value);
MethodVisitor visitMethod(int access, String name, String desc,
String signature, String[] exceptions);
void visitEnd();
}
使用方法必须符合下面规则:
visit visitSource? visitOuterClass? ( visitAnnotation | visitAttribute )*
( visitInnerClass | visitField | visitMethod )*
visitEnd
visit必须是第一个被调用的方法，然后调用visitOuterClass,接着调用visitAnnotation和 visitAttribute依次类推，最后调用visitEnd
ASM提供3个核心基于ClassVisitor的3个核心组件用于产生解析类:
1、ClassReader解析已经编译好的类文件，调用对应的VisitXxx方法
2、ClassWriter实现了ClassVisitor接口,生成类
3、ClassAdapter实现了ClassVisitor接口，代理调用接口的所有方法
以下是类解析的例子相关信息，通过Visitor打印类
package com.appspot.coder9527;
import java.io.IOException;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
public class ClassInfoVisitor implements ClassVisitor {
@Override
public void visit( int version, int access, String name, String signature,
String superName, String[] interfaces) {
System.out.println(name + " extends " + superName + " {" );
}
@Override
public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
return null ;
}
@Override
public void visitAttribute(Attribute attr) {
}
@Override
public void visitEnd() {
System.out.println("}" );
}
@Override
public FieldVisitor visitField( int access, String name, String desc,
String signature, Object value) {
System.out.println(" " + desc + " " + name);
return null ;
}
@Override
public void visitInnerClass(String name, String outerName,
String innerName, int access) {
}
@Override
public MethodVisitor visitMethod( int access, String name, String desc,
String signature, String[] exceptions) {
System.out.println(" " + name + desc);
return null ;
}
@Override
public void visitOuterClass(String owner, String name, String desc) {
}
@Override
public void visitSource(String source, String debug) {
}
public static void main(String argv[]) throws IOException {
ClassReader reader = new ClassReader( "com.appspot.coder9527.ClassInfoVisitor" );
ClassInfoVisitor visitor = new ClassInfoVisitor();
reader.accept(visitor, 0 );
}
} package com.appspot.coder9527;
import java.io.IOException;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
public class ClassInfoVisitor implements ClassVisitor {
@Override
public void visit(int version, int access, String name, String signature,
String superName, String[] interfaces) {
System.out.println(name + " extends " + superName + " {");
}
@Override
public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
return null;
}
@Override
public void visitAttribute(Attribute attr) {
}
@Override
public void visitEnd() {
System.out.println("}");
}
@Override
public FieldVisitor visitField(int access, String name, String desc,
String signature, Object value) {
System.out.println(" " + desc + " " + name);
return null;
}
@Override
public void visitInnerClass(String name, String outerName,
String innerName, int access) {
}
@Override
public MethodVisitor visitMethod(int access, String name, String desc,
String signature, String[] exceptions) {
System.out.println(" " + name + desc);
return null;
}
@Override
public void visitOuterClass(String owner, String name, String desc) {
}
@Override
public void visitSource(String source, String debug) {
}
public static void main(String argv[]) throws IOException {
ClassReader reader = new ClassReader("com.appspot.coder9527.ClassInfoVisitor");
ClassInfoVisitor visitor = new ClassInfoVisitor();
reader.accept(visitor, 0);
}
}
来看看ClassReader,要了解ClassReader.
首先要理解要理解Class文件定义的格式
struct Class_File_Format {
u4 magic_number; //4个字节的魔幻数 是16进制的0xcafe 0xbabe cafe呵呵有点好耍
u2 minor_version; //2个字节的主版本号
u2 major_version; //2个字节次版本号
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];//类附加属性数据，包括源文件名等。
};
看看常量表cp_info的定义。
cp_info {
u1 tag;
u1 info[];
}
cp_info的tag保存着类型信息，如下：
类型 值
CONSTANT_Class 7
CONSTANT_Fieldref 9
CONSTANT_Methodref 10
CONSTANT_InterfaceMethodref 11
CONSTANT_String 8
CONSTANT_Integer 3
CONSTANT_Float 4
CONSTANT_Long 5
CONSTANT_Double 6
CONSTANT_NameAndType 12
CONSTANT_Utf8 1
指定的类型又显示了info指向的每种结构，比如CONSTANT_Class这种类型的指向的结构是
CONSTANT_Class_info {
u1 tag;
u2 name_index;
}
以下是Class_File_Format的结构图
------------------------------
一、什么是ASM
ASM是一个java字节码操纵框架，它能被用来动态生成类或者增强既有类的功能。ASM 可以直接产生二进制 class 文件，也可以在类被加载入 Java 虚拟机之前动态改变类行为。Java class 被存储在严格格式定义的 .class文件里，这些类文件拥有足够的元数据来解析类中的所有元素：类名称、方法、属性以及 Java 字节码（指令）。ASM从类文件中读入信息后，能够改变类行为，分析类信息，甚至能够根据用户要求生成新类。
使用ASM框架需要导入asm的jar包，下载链接：asm-3.2.jar。
二、如何使用ASM
ASM框架中的核心类有以下几个：
① ClassReader:该类用来解析编译过的class字节码文件。
② ClassWriter:该类用来重新构建编译后的类，比如说修改类名、属性以及方法，甚至可以生成新的类的字节码文件。
③ ClassAdapter:该类也实现了ClassVisitor接口，它将对它的方法调用委托给另一个ClassVisitor对象。
示例1.通过asm生成类的字节码
1 package com.asm3;
2
3 import java.io.File;
4 import java.io.FileNotFoundException;
5 import java.io.FileOutputStream;
6 import java.io.IOException;
7
8 import org.objectweb.asm.ClassWriter;
9 import org.objectweb.asm.Opcodes;
10
11 /**
12 * 通过asm生成类的字节码
13 * @author Administrator
14 *
15 */
16 public class GeneratorClass {
17
18 public static void main(String[] args) throws IOException {
19 //生成一个类只需要ClassWriter组件即可
20 ClassWriter cw = new ClassWriter(0);
21 //通过visit方法确定类的头部信息
22 cw.visit(Opcodes.V1_5, Opcodes.ACC_PUBLIC+Opcodes.ACC_ABSTRACT+Opcodes.ACC_INTERFACE,
23 "com/asm3/Comparable", null, "java/lang/Object", new String[]{"com/asm3/Mesurable"});
24 //定义类的属性
25 cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
26 "LESS", "I", null, new Integer(-1)).visitEnd();
27 cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
28 "EQUAL", "I", null, new Integer(0)).visitEnd();
29 cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
30 "GREATER", "I", null, new Integer(1)).visitEnd();
31 //定义类的方法
32 cw.visitMethod(Opcodes.ACC_PUBLIC+Opcodes.ACC_ABSTRACT, "compareTo",
33 "(Ljava/lang/Object;)I", null, null).visitEnd();
34 cw.visitEnd(); //使cw类已经完成
35 //将cw转换成字节数组写到文件里面去
36 byte[] data = cw.toByteArray();
37 File file = new File("D://Comparable.class");
38 FileOutputStream fout = new FileOutputStream(file);
39 fout.write(data);
40 fout.close();
41 }
42 }生成一个类的字节码文件只需要用到ClassWriter类即可，生成Comparable.class后用javap指令对其进行反编译：javap -c Comparable.class >test.txt ,编译后的结果如下：
1 public interface com.asm3.Comparable extends com.asm3.Mesurable {
2 public static final int LESS;
3
4 public static final int EQUAL;
5
6 public static final int GREATER;
7
8 public abstract int compareTo(java.lang.Object);
9 }注：一个编译后的java类不包含package和import段，因此在class文件中所有的类型都使用的是全路径。
示例2.修改类的字节码文件
C.java
1 package com.asm5;
2
3 public class C {
4 public void m() throws InterruptedException{
5 Thread.sleep(100);
6 }
7 }将C.java类的内容改为如下：
1 package com.asm5;
2
3 public class C {
4 public static long timer;
5 public void m() throws InterruptedException{
6 timer -= System.currentTimeMillis();
7 Thread.sleep(100);
8 timer += System.currentTimeMillis();
9 }
10 }为了弄清楚ASM是如何实现的，我们先编译这两个类，然后比对它们的TraceClassVisitor的输出，我们可以发现如下的不同（粗体表示）
GETSTATIC C.timer : J
INVOKESTATIC java/lang/System.currentTimilis()J
LSUB
PUTSTATIC C.timer : J
LDC 100
INVOKESTATIC java/lang/Thread.sleep(J)V
GETSTATIC C.timer : J
INVOKESTATIC java/lang/System.currentTimilis()J
LADD
PUTSTATIC C.timer : J
RETURN
MAXSTACK=4
MAXLOCALS=1
通过比对上面的指令，我们可以发现必须在m()方法的最前面增加四条指令，在RETURN指令前也增加四条指令，同时这四条必须位于xRETURN和ATHROW之前，因为这些指令都会结束方法的执行。
具体代码如下：
AddTimeClassAdapter.java
1 package com.asm5;
2
3 import org.objectweb.asm.ClassAdapter;
4 import org.objectweb.asm.ClassVisitor;
5 import org.objectweb.asm.FieldVisitor;
6 import org.objectweb.asm.MethodAdapter;
7 import org.objectweb.asm.MethodVisitor;
8 import org.objectweb.asm.Opcodes;
9
10 public class AddTimeClassAdapter extends ClassAdapter {
11 private String owner;
12 private boolean isInterface;
13 public AddTimeClassAdapter(ClassVisitor cv) {
14 super(cv);
15 }
16 @Override
17 public void visit(int version, int access, String name, String signature,
18 String superName, String[] interfaces) {
19 cv.visit(version, access, name, signature, superName, interfaces);
20 owner = name;
21 isInterface = (access & Opcodes.ACC_INTERFACE) != 0;
22 }
23 @Override
24 public MethodVisitor visitMethod(int access, String name, String desc,
25 String signature, String[] exceptions) {
26 MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
27 if(!name.equals("<init>") && !isInterface && mv!=null){
28 //为方法添加计时功能
29 mv = new AddTimeMethodAdapter(mv);
30 }
31 return mv;
32 }
33 @Override
34 public void visitEnd() {
35 //添加字段
36 if(!isInterface){
37 FieldVisitor fv = cv.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_STATIC, "timer", "J", null, null);
38 if(fv!=null){
39 fv.visitEnd();
40 }
41 }
42 cv.visitEnd();
43 }
44
45 class AddTimeMethodAdapter extends MethodAdapter{
46 public AddTimeMethodAdapter(MethodVisitor mv) {
47 super(mv);
48 }
49 @Override
50 public void visitCode() {
51 mv.visitCode();
52 mv.visitFieldInsn(Opcodes.GETSTATIC, owner, "timer", "J");
53 mv.visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J");
54 mv.visitInsn(Opcodes.LSUB);
55 mv.visitFieldInsn(Opcodes.PUTSTATIC, owner, "timer", "J");
56 }
57 @Override
58 public void visitInsn(int opcode) {
59 if((opcode>=Opcodes.IRETURN && opcode<=Opcodes.RETURN) || opcode==Opcodes.ATHROW){
60 mv.visitFieldInsn(Opcodes.GETSTATIC, owner, "timer", "J");
61 mv.visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J");
62 mv.visitInsn(Opcodes.LADD);
63 mv.visitFieldInsn(Opcodes.PUTSTATIC, owner, "timer", "J");
64 }
65 mv.visitInsn(opcode);
66 }
67 @Override
68 public void visitMaxs(int maxStack, int maxLocal) {
69 mv.visitMaxs(maxStack+4, maxLocal);
70 }
71 }
72
73 }Generator.java
1 package com.asm5;
2
3 import java.io.File;
4 import java.io.FileNotFoundException;
5 import java.io.FileOutputStream;
6 import java.io.IOException;
7
8 import org.objectweb.asm.ClassAdapter;
9 import org.objectweb.asm.ClassReader;
10 import org.objectweb.asm.ClassWriter;
11
12
13
14 public class Generator {
15
16 public static void main(String[] args){
17 try {
18 ClassReader cr = new ClassReader("com/asm5/C");
19 ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
20 ClassAdapter classAdapter = new AddTimeClassAdapter(cw);
21 //使给定的访问者访问Java类的ClassReader
22 cr.accept(classAdapter, ClassReader.SKIP_DEBUG);
23 byte[] data = cw.toByteArray();
24 File file = new File(System.getProperty("user.dir") + "\\WebRoot\\WEB-INF\\classes\\com\\asm5\\C.class");
25 FileOutputStream fout = new FileOutputStream(file);
26 fout.write(data);
27 fout.close();
28 System.out.println("success!");
29 } catch (FileNotFoundException e) {
30 e.printStackTrace();
31 } catch (IOException e) {
32 e.printStackTrace();
33 }
34 }
35
36 }下面是一个测试类：
1 package com.asm5;
2
3 public class Test {
4 public static void main(String[] args) throws InterruptedException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
5 C c = new C();
6 c.m();
7 Class cc = c.getClass();
8 System.out.println(cc.getField("timer").get(c));
9 }
10 }http://www.cnblogs.com/liuling/archive/2013/05/25/asm.html
