asm解读

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的结构图

评论

1 楼 jerryfeng 2010-09-02  

请尊重他人劳动成果，转载请标明出处;
我是http://coder9527.appspot.com团队博客作者之一