ASM

原文地址：https://www.jianshu.com/p/a1e6b3abd789

今天介绍下ASM3.0，开始之前先思考几个问题：

1.ASM是什么？
2.ASM 跟传说中的AOP三剑客APT、aspectJ、Javassit有什么关系？
3.ASM是怎样修改class文件的？

带着问题开始今天的分享：

• 1.ASM是什么？

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

• 2.ASM 跟传说中的AOP三剑客APT、aspectJ、Javassit有什么关系？

分别解释下这几个名词

APT:APT(Annotation Processing Tool)即注解处理器，是一种处理注解的工具，确切的说它是javac的一个工具，它用来在编译时扫描和处理注解。注解处理器以Java代码(或者编译过的字节码)作为输入，生成.java文件作为输出。简单来说就是在编译期，通过注解生成.java文件

aspectJ:AspectJ是一个面向切面的框架，它扩展了Java语言。AspectJ定义了AOP语法，所以它有一个专门的[编译器]用来生成遵守Java字节编码规范的Class文件。适合在某一个方法前后插入部分代码，处理某些逻辑：比如方法运行时间、插入动态权限检查等。问题会造成很多的冗余代码，产生很多代理类。简单来说就是在生成class时动态织入代码

Javassit: Javassist是一个开源的分析、编辑和创建Java字节码的类库。是由东京工业大学的数学和计算机科学系的 Shigeru Chiba(千叶滋)所创建的。简单来说就是源码级别的api去修改字节码

 

各种方式作用时机

• 3.ASM是怎样修改class文件的？

开始这个问题之前我们先学习几个东西。

• 字节码

这里的字节码主要说的是Java字节码，看之前的一篇文章java bytecode

• 访问者模式

一个称为元素（Element），另一个称为访问者（Visitor）。元素有一个accept方法，该方法接收访问者作为参数；accept()方法调用访问者的visit()方法，并且将元素自身作为参数传递给访问者。由元素本身决定是否访问

在ASM中元素（被访问者）ClassReader、MethodNode等等，访问者接口包含ClassVisitor、AnnotationVisitor、FieldVisitor、MethodVisitor

下面我们先简单实现一个插桩操作
有如下代码：

public class Main2Activity extends AppCompatActivity {

    private static int MESSAGE_KEY = 0x2019;
    @SuppressLint("HandlerLeak")
    private static Handler sHandler =new Handler() {
        @Override
        public void handleMessage(Message msg) {
            if (msg.what ==MESSAGE_KEY) {
                if (msg.obj!=null) {
                    Log.i("xmq", String.valueOf(msg.obj));
                }
            }
        }
    };
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        sendMessage(getClass().getSimpleName());
    }
    
    private void sendMessage(String string) {
        Message message = new Message();
        message.what =MESSAGE_KEY;
        sHandler.sendMessage(message);
    }
}

我们要在sendMessage方法中添加一行代码变为下列

private void sendMessage(String string) {
        Message message = new Message();
        message.what =MESSAGE_KEY;
        message.obj = string;
        sHandler.sendMessage(message);
}

• 1.我们这里使用一个Android studio的plugin (ASM ByteCode Outline)查看Main2Activity的ASM代码,看主要的sendMessage部分

{
            mv = cw.visitMethod(ACC_PRIVATE, "sendMessage", "(Ljava/lang/String;)V", null, null);
            mv.visitCode();
            Label l0 = new Label();
            mv.visitLabel(l0);
            mv.visitLineNumber(33, l0);
            mv.visitTypeInsn(NEW, "android/os/Message");
            mv.visitInsn(DUP);
            mv.visitMethodInsn(INVOKESPECIAL, "android/os/Message", "<init>", "()V", false);
            mv.visitVarInsn(ASTORE, 2);
            Label l1 = new Label();
            mv.visitLabel(l1);
            mv.visitLineNumber(34, l1);
            mv.visitVarInsn(ALOAD, 2);
            mv.visitFieldInsn(GETSTATIC, "com/lucky/lib/studyapp/Main2Activity", "MESSAGE_KEY", "I");
            mv.visitFieldInsn(PUTFIELD, "android/os/Message", "what", "I");
            Label l2 = new Label();
            mv.visitLabel(l2);
            mv.visitLineNumber(36, l2);
            mv.visitFieldInsn(GETSTATIC, "com/lucky/lib/studyapp/Main2Activity", "sHandler", "Landroid/os/Handler;");
            mv.visitVarInsn(ALOAD, 2);
            mv.visitMethodInsn(INVOKEVIRTUAL, "android/os/Handler", "sendMessage", "(Landroid/os/Message;)Z", false);
            mv.visitInsn(POP);
            Label l3 = new Label();
            mv.visitLabel(l3);
            mv.visitLineNumber(37, l3);
            mv.visitInsn(RETURN);
            Label l4 = new Label();
            mv.visitLabel(l4);
            mv.visitLocalVariable("this", "Lcom/lucky/lib/studyapp/Main2Activity;", null, l0, l4, 0);
            mv.visitLocalVariable("string", "Ljava/lang/String;", null, l0, l4, 1);
            mv.visitLocalVariable("message", "Landroid/os/Message;", null, l1, l4, 2);
            mv.visitMaxs(2, 3);
            mv.visitEnd();
        }

看起来很懵逼，其实这里只不过是ASM帮助我们调用java bytecode罢了。

• 2. 修改你想要的代码，同样使用ASM ByteCode Outlineplugin对比差异代码

***
mv.visitFieldInsn(GETSTATIC, "com/lucky/lib/studyapp/Main2Activity", "MESSAGE_KEY", "I");
mv.visitFieldInsn(PUTFIELD, "android/os/Message", "what", "I");
Label l2 = new Label();
mv.visitLabel(l2);
mv.visitLineNumber(35, l2);
mv.visitVarInsn(ALOAD, 2);
mv.visitVarInsn(ALOAD, 1);
mv.visitFieldInsn(PUTFIELD, "android/os/Message", "obj", "Ljava/lang/Object;");
Label l3 = new Label();
mv.visitLabel(l3);
mv.visitLineNumber(36, l3);
***

看的出我们在mv.visitFieldInsn(PUTFIELD, "android/os/Message", "what", "I");后边插入了三行代码（其中的Label以及行数设置可以不用理），那么这三行代码什么意思呢？这里就用到了上边提到的java bytecode知识，意思是：将变量2，1分别入栈，并将2变量赋值给message的obj。

好了那么我们开始写ASM，这里我们使用android transform api作为前置条件扫描文件。（有关于transform api后期分享）

开始之前先解释几个类：

1.Opcodes接口定义了一些常量，尤其是版本号，访问标示符，字节码等信息；
2.ClassReader用于读取Class文件，主要用于Class文件的分析，可接受一个ClassVisitor;ClassReader会将解析过程中产生的类的部分信息，比如访问标识符，字段，方法逐个送入ClassVisitor,后者在接收到对应的信息后，进行各自的处理；
3.ClassVisitor的子类ClassWriter: 负责进行Class文件的输出和生成。ClassVisitor在进行字段和方法处理的时候，会委托给FieldVistor和MethodVisitor进行处理；在类的处理过程中，会创建对应的FieldVisitor和MethodVisitor对象；FieldVisitor和MethodVisitor类也各自有1个重要的子类，FieldWriter和MethodWriter；当ClassWriter进行字段和方法的处理时，也是依赖这两个类进行的;
4.ClassVisitor,FieldVisitor,MethodVisitor都可以使用委托的方式，将实际的处理工作交给内部的委托类进行；它们内部有一些列的visitXXX方法,这些方法就是ASM 的实际方法code。

创建元素跟访问者

private static byte [] scanClass(InputStream inputStream) {
        //被访问者（元素）
        ClassReader cr = new ClassReader(inputStream)
        //访问者
        ClassWriter cw = new ClassWriter(cr, 0)
        ScanClassVisitor cv = new ScanClassVisitor(Opcodes.ASM5,cw) //ClassWriter 的代理类
        cr.accept(cv, ClassReader.EXPAND_FRAMES)
        return cw.toByteArray()
    }

这里的访问者ScanClassVisitor继承了ClassVisitor,这里我们要修改某一个方法，所以实现了visitMethod方法，并筛选其中的sendMessage方法

    static class ScanClassVisitor extends ClassVisitor{
        ScanClassVisitor(int api, ClassVisitor cv) { //这里很奇怪我无法使用继承Opcodes，内部直接调用ASM5，只能传参数
            super(api, cv)
        }
        @Override
        MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
            MethodVisitor mv =  cv.visitMethod(access, name, desc, signature, exceptions)
            if (name == "sendMessage") {
                mv = new ScanMethodVisitor(Opcodes.ASM5,mv)
            }
            return mv
        }
    }

上边的ScanMethodVisitor是实现了MethodVisitor访问者，看ASM代码，我们需要在mv.visitFieldInsn(PUTFIELD, "android/os/Message", "what", "I");行后插入代码，所以需要实现visitFieldInsn方法

opcode: PUTFIELD
owner: "android/os/Message"
name:"what"
desc:"I"

static class ScanMethodVisitor extends MethodVisitor {
        ScanMethodVisitor(int api, MethodVisitor mv) {
            super(api, mv)
        }
        @Override
        void visitFieldInsn(int opcode, String owner, String name, String desc) {
            if (opcode == Opcodes.PUTFIELD && owner.equals("android/os/Message")) {
                mv.visitFieldInsn(opcode, owner, name, desc)
                mv.visitVarInsn(Opcodes.ALOAD, 2)
                mv.visitVarInsn(Opcodes.ALOAD, 1)
                mv.visitFieldInsn(Opcodes.PUTFIELD, "android/os/Message", "obj", "Ljava/lang/Object;")
            } else {
                mv.visitFieldInsn(opcode, owner, name, desc)
            }
        }
    }

好了接下来运行代码transform看效果

public class Main2Activity extends AppCompatActivity {
    private static int MESSAGE_KEY = 8217;
    @SuppressLint({"HandlerLeak"})
    private static Handler sHandler = new Handler() {
        public void handleMessage(Message msg) {
            if (msg.what == Main2Activity.MESSAGE_KEY && msg.obj != null) {
                Log.i("xmq", String.valueOf(msg.obj));
            }

        }
    };

    public Main2Activity() {
    }

    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        this.setContentView(2131296284);
        this.sendMessage(this.getClass().getSimpleName());
    }

    private void sendMessage(String string) {
        Message message = new Message();
        message.what = MESSAGE_KEY;
        message.obj = string;
        sHandler.sendMessage(message);
    }
}

总结：ASM直接修改class文件确实效率很高，但因直接操作字节码，需要有字节码知识，不适合直接上手，相比较来Javassit源码级修改class文件更方便些。
demo

作者：heiheiwanne
链接：https://www.jianshu.com/p/a1e6b3abd789
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。