ASM的操作类属性

我们看到了ASM中的Core API中使用的是XXXVisitor操作类中的对应部分。本文将展示如何使用ASM中的Core API对类的属性的操作。

首先，我们定义一个原类Student，如下：

public class Student {
	public String name = "Jimmy";
	public String address = "China";
}

 这里，我们将属性定义为public类型，目的是为了我们使用反射去调用这个属性，接下来我们要为这个类添加一个int类型的属性，名字叫age。

    第一个问题，ASM的Core API允许我们在那些方法中来添加属性？

    在ASM的Core API中你要为类添加属性就必须要自己去实现ClassVisitor这个接口，这个接口中的visitInnerClass、visitField、visitMethod和visitEnd方法允许我们进行添加一个类属性操作，其余的方法是不允许的。这里我们依然使用Core API中的ClassAdapter类，我们继承这个类，定义一个去添加属性的类，ClassAdapter实现了ClassVisitor。

    第二个问题，我们要在这些方法中写什么样的代码才能添加一个属性？

    在使用ASM的Core API添加一个属性时只需要调用一句语句就可以，如下：

Java代码  

1. classVisitor.visitField(Opcodes.ACC_PUBLIC, "age", Type.getDescriptor(int.class),  
2.                 null, null);  

 第一个参数指定的是这个属性的操作权限，第二个参数是属性名，第三个参数是类型描述，第四个参数是泛型类型，第五个参数是初始化的值，这里需要注意一下的是第五个参数，这个参数只有属性为static时才有效，也就是数只有为static时，这个值才真正会赋值给我们添加的属性上，对于非static属性，它将被忽略。

我们现在用两种方式来添加一个名字为age的属性：

第一种方式：

用ClassWriter直接创建

ClassReader cr = new ClassReader(Student.class.getName());
		ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS);
		ClassVisitor cv = new AddFieldClassAdapter(cw);
		cr.accept(cv, Opcodes.ASM4);
		byte[] code = cw.toByteArray();
		AddField loader = new AddField();
		Class<?> exampleClass = loader.defineClass(Student.class.getName(), code, 0, code.length);
		Object obj = exampleClass.newInstance();
		System.out.println(exampleClass.getField("name").get(obj));
		System.out.println(exampleClass.getField("age").get(obj));

 在这里，如果我们的age没有被添加进去那么(2)这个地方将会报错，看一下结果：

Jimmy
0

public class AddFieldClassAdapter extends ClassVisitor implements Opcodes{

	public AddFieldClassAdapter(ClassVisitor cv) {
		super(Opcodes.ASM4, cv);
	}
	
	
	@Override
	public void visitEnd() {
		cv.visitField(Opcodes.ACC_PUBLIC, "age", Type.getDescriptor(int.class),  
                null, null);
		super.visitEnd();
	}

}

public class AddField extends ClassLoader implements Opcodes{
	public static void main(String args[]) throws IOException, SecurityException, NoSuchFieldException, InstantiationException, IllegalAccessException{
		ClassReader cr = new ClassReader(Student.class.getName());
		ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS);
		ClassVisitor cv = new AddFieldClassAdapter(cw);
		cr.accept(cv, Opcodes.ASM4);

		byte[] code = cw.toByteArray();
		AddField loader = new AddField();
		Class<?> exampleClass = loader.defineClass(Student.class.getName(), code, 0, code.length);
		Object obj = exampleClass.newInstance();
		System.out.println(exampleClass.getField("name").get(obj));
		System.out.println(exampleClass.getField("age").get(obj));
	}
}

 结果如下：

Jimmy
0

接下来，我们在visitField方法中在次添加age属性，如下：

public class AddFieldClassAdapter extends ClassVisitor implements Opcodes{

	public AddFieldClassAdapter(ClassVisitor cv) {
		super(Opcodes.ASM4, cv);
	}
	
	@Override
	public FieldVisitor visitField(int access, String name, String desc,
            String signature, Object value) {
		cv.visitField(Opcodes.ACC_PUBLIC, "age", Type.getDescriptor(int.class),  
              null, null);
		return super.visitField(access, name, desc, signature, value);
    }
	


}

 这时，我们再次运行测试类，结果如下：

Exception in thread "main" java.lang.ClassFormatError: Duplicate field name&signature in class file field/Student
	at java.lang.ClassLoader.defineClass1(Native Method)
	at java.lang.ClassLoader.defineClassCond(ClassLoader.java:631)
	at java.lang.ClassLoader.defineClass(ClassLoader.java:615)
	at java.lang.ClassLoader.defineClass(ClassLoader.java:465)
	at field.AddField.main(AddField.java:21)

 很奇怪，怎么会属性名重复，我们看一下原类，

Java代码  

1. public String name = "Jimmy";  
2. public String address = "China" ;  

 没有重复的名字，而我们添加的是age也不重复，为什么会报重复属性名错误呢？

原因是，在我们的Transform类中的visitField方法，这个方法会在每次属性被访问时调用，而ASM在对这个类操作时会遍历到每个属性，也就是说有一个属性就会调用一次visitField方法，有两个属性就会调用两次visitField方法，所以当我们原类中有两个属性时visitField方法被调用了两次，因此创建了两个同名的age属性。

为了验证visitField是被多次调用， 我那么可以做一个实验，在visitField()方法中加入System.out.println("name:" + name);把每次调用的属性名称都打印出来。

public class AddFieldClassAdapter extends ClassVisitor implements Opcodes{

	public AddFieldClassAdapter(ClassVisitor cv) {
		super(Opcodes.ASM4, cv);
	}
	
	@Override
	public FieldVisitor visitField(int access, String name, String desc,
            String signature, Object value) {
		System.out.println("name:" + name);

		return super.visitField(access, name, desc, signature, value);
    }
	


}

 结果：

name:name
name:address

 会把Student所有的属性都打印出来，这证明了visitField()是被多次调用的！

从这个例子中我们可以将visitInnerClass、visitField、visitMethod和visitEnd这些方法分成两组，一组是visitInnerClass、visitField、visitMethod，这些方法有可能会被多次调用，因此在这些方法中创建属性时要注意会重复创建；另一组是visitEnd，这个方法只有在最后才会被调用且只调用一次，所以在这个方法中添加属性是唯一的，因此一般添加属性选择在这个方法里编码。

    当然这里只给出了如何创建一个属性，其实修改，删除也都一样，根据上述知识大家可以参考ASM的源码即可掌握修改删除等操作。