java字節碼框架ASM的學習
一、什么是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生成類的字節碼
package com.asm3;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.Opcodes;
/**
* 通過asm生成類的字節碼
* @author Administrator
*
*/
public class GeneratorClass {
public static void main(String[] args) throws IOException {
//生成一個類只需要ClassWriter組件即可
ClassWriter cw = new ClassWriter(0);
//通過visit方法確定類的頭部信息
cw.visit(Opcodes.V1_5, Opcodes.ACC_PUBLIC+Opcodes.ACC_ABSTRACT+Opcodes.ACC_INTERFACE,
"com/asm3/Comparable", null, "java/lang/Object", new String[]{"com/asm3/Mesurable"});
//定義類的屬性
cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
"LESS", "I", null, new Integer(-1)).visitEnd();
cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
"EQUAL", "I", null, new Integer(0)).visitEnd();
cw.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_FINAL+Opcodes.ACC_STATIC,
"GREATER", "I", null, new Integer(1)).visitEnd();
//定義類的方法
cw.visitMethod(Opcodes.ACC_PUBLIC+Opcodes.ACC_ABSTRACT, "compareTo",
"(Ljava/lang/Object;)I", null, null).visitEnd();
cw.visitEnd(); //使cw類已經完成
//將cw轉換成字節數組寫到文件里面去
byte[] data = cw.toByteArray();
File file = new File("D://Comparable.class");
FileOutputStream fout = new FileOutputStream(file);
fout.write(data);
fout.close();
}
}
生成一個類的字節碼文件只需要用到ClassWriter類即可,生成Comparable.class后用javap指令對其進行反編譯:javap -c Comparable.class >test.txt ,編譯后的結果如下:
package com.asm5;
public class C {
public void m() throws InterruptedException{
Thread.sleep(100);
}
}
注:一個編譯后的java類不包含package和import段,因此在class文件中所有的類型都使用的是全路徑。
示例2.修改類的字節碼文件
C.java
package com.asm5;
public class C {
public static long timer;
public void m() throws InterruptedException{
timer -= System.currentTimeMillis();
Thread.sleep(100);
timer += System.currentTimeMillis();
}
}將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
package com.asm5;
import org.objectweb.asm.ClassAdapter;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodAdapter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
public class AddTimeClassAdapter extends ClassAdapter {
private String owner;
private boolean isInterface;
public AddTimeClassAdapter(ClassVisitor cv) {
super(cv);
}
@Override
public void visit(int version, int access, String name, String signature,
String superName, String[] interfaces) {
cv.visit(version, access, name, signature, superName, interfaces);
owner = name;
isInterface = (access & Opcodes.ACC_INTERFACE) != 0;
}
@Override
public MethodVisitor visitMethod(int access, String name, String desc,
String signature, String[] exceptions) {
MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
if(!name.equals("<init>") && !isInterface && mv!=null){
//為方法添加計時功能
mv = new AddTimeMethodAdapter(mv);
}
return mv;
}
@Override
public void visitEnd() {
//添加字段
if(!isInterface){
FieldVisitor fv = cv.visitField(Opcodes.ACC_PUBLIC+Opcodes.ACC_STATIC, "timer", "J", null, null);
if(fv!=null){
fv.visitEnd();
}
}
cv.visitEnd();
}
class AddTimeMethodAdapter extends MethodAdapter{
public AddTimeMethodAdapter(MethodVisitor mv) {
super(mv);
}
@Override
public void visitCode() {
mv.visitCode();
mv.visitFieldInsn(Opcodes.GETSTATIC, owner, "timer", "J");
mv.visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J");
mv.visitInsn(Opcodes.LSUB);
mv.visitFieldInsn(Opcodes.PUTSTATIC, owner, "timer", "J");
}
@Override
public void visitInsn(int opcode) {
if((opcode>=Opcodes.IRETURN && opcode<=Opcodes.RETURN) || opcode==Opcodes.ATHROW){
mv.visitFieldInsn(Opcodes.GETSTATIC, owner, "timer", "J");
mv.visitMethodInsn(Opcodes.INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J");
mv.visitInsn(Opcodes.LADD);
mv.visitFieldInsn(Opcodes.PUTSTATIC, owner, "timer", "J");
}
mv.visitInsn(opcode);
}
@Override
public void visitMaxs(int maxStack, int maxLocal) {
mv.visitMaxs(maxStack+4, maxLocal);
}
}
}
Generator.java
package com.asm5;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import org.objectweb.asm.ClassAdapter;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassWriter;
public class Generator {
public static void main(String[] args){
try {
ClassReader cr = new ClassReader("com/asm5/C");
ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);
ClassAdapter classAdapter = new AddTimeClassAdapter(cw);
//使給定的訪問者訪問Java類的ClassReader
cr.accept(classAdapter, ClassReader.SKIP_DEBUG);
byte[] data = cw.toByteArray();
File file = new File(System.getProperty("user.dir") + "\\WebRoot\\WEB-INF\\classes\\com\\asm5\\C.class");
FileOutputStream fout = new FileOutputStream(file);
fout.write(data);
fout.close();
System.out.println("success!");
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}下面是一個測試類:
package com.asm5;
public class Test {
public static void main(String[] args) throws InterruptedException, NoSuchFieldException, SecurityException, IllegalArgumentException, IllegalAccessException {
C c = new C();
c.m();
Class cc = c.getClass();
System.out.println(cc.getField("timer").get(c));
}
}
輸出結果為:100
來自:http://www.cnblogs.com/liuling/archive/2013/05/25/asm.html
