[转]Hello, ASM——代码生成

版权声明：转载时请以超链接形式标明文章原始出处和作者信息及本声明
http://dreamhead.blogbus.com/logs/4007513.html

这里要说的ASM，并不是指汇编语言，而是一个操作Java bytecode的框架。对于Java平台而言，bytecode便是它的“汇编语言”，所以，ASM这个名字倒也算是实至名归。ASM本身很强大，有不少软件和框架选择它作为底层的实现，比如cglib。在这篇blog中，主要来关注一下它在代码生成方面的威力。

在起步阶段，Hello World总是一个很好的选择，也就是说，我们生成的目标代码是这样的：
public class AsmExample {
    public static void main(String[] args) {
        System.out.println("Hello, World");
    }
}

在Java中，代码是以类的形式进行组织的，.class文件便是bytecode的载体。对照上面这段代码，首先，我们需要一个类。
public class AsmMain {
    public static void main(String[] args) {
        ClassWriter cw = new ClassWriter(true);
        cw.visit(Opcodes.V1_1, Opcodes.ACC_PUBLIC, "AsmExample", null, "java/lang/Object", null);

        ...

        cw.visitEnd();
    }
}

在上面这段代码中，ClassWriter就是ASM中用来生成bytecode形式的类。在这里，我们要为我们生成的类设置一些属性，比如类名、访问级别和超类，以及在bytecode层次上需要的版本号等等。至此，对应的Java代码如下：
public class AsmExample {
}

有了类，接下来就是对应的方法了，先来看看基本的结构：
        Method m = Method.getMethod("void main (String[])");
        GeneratorAdapter mg = new GeneratorAdapter(Opcodes.ACC_PUBLIC + Opcodes.ACC_STATIC, m, null, null, cw);
        ...
        mg.returnValue();
        mg.endMethod();
首先我们设置了一个方法的签名，包括方法名，参数和返回类型。我们要生成这个方法，还需要设置一些方法的属性，比如访问级别等等，通过cw这个参数，方法同类关联在了一起。到这里，对应的Java代码是这样的：
public class AsmExample {
    public static void main(String args[]) {
    }
}

前面所做的都是搭建静态结构的工作，接下来，我们要进入的才是让程序动起来的部分。
    mg.getStatic(Type.getType(System.class), "out", Type.getType(PrintStream.class));
    mg.push("Hello world!");
    mg.invokeVirtual(Type.getType(PrintStream.class), Method.getMethod("void println (String)"));

在这里，我们面对的实际上是JVM的指令，所以，如果面对汇编一样，所有的一切都一步一步说清楚。

首 先是获得System.out。我们通过getStatic这个方法实现，它表示从哪个类中取出哪个static字段，其类型是什么。而且实际上，这条指 令执行的结果是将这个取出的字段推到了堆栈上。随后，我们在把“Hello world!”也推入堆栈之中，很显然，这一切都是在为调用方法做准备。

对 于参数（这里的“Hello world!”）入栈，我们很容易接受，但为什么要把System.out也送入堆栈呢？再次提醒一下，这里我们是在JVM一级进行思考，在这里，方法调 用被打回了最原始的形态，在Java程序中被隐藏的this这时也要作为参数显式传递，也就是说，方法调用变成了这样：
    println(System.out, "Hello world!");

万 事俱备，调用方法。在Java中，方法调用需要区分类方法和实例方法，它们在虚拟机中有着不同的指令，这里我们要调用的是实例的方法，所以，这里用的是 invokeVirtual，指定了类型，指定了方法，方法就可以调用了。如果要调用类的方法，也就是static方法，那就需要让 invokeStatic上阵了。

对比一下invokeVirtual和invokeStatic的API定义，我们不难发现，它们之间实 际上没有什么区别，之所以要弄出两个来，与Java的设计不无关系，它把属于类的东西看作了一种特殊的东西，没有统一到对象体系之中。如果为Ruby设计 虚拟机，可以消除这样的问题，因为在Ruby中，类的方法就是类对象的实例方法，这样将类的东西统一到对象体系之中，不必额外区分。

到这里，我们的目标便已完全实现：
public class AsmExample {
    public static void main(String args[]) {
        System.out.println("Hello world!");
    }
}

之后，我们可以把定义的类转为字节，至于是加载到虚拟机中运行，还是保存到文件中，那就由自己的喜好了。
    byte[] code = cw.toByteArray();

和 ASM打交道，需要我们放低自己姿态，站在指令一级进行思考。比如，在这个层次上，实现判断语句，就需要设置label，然后进行相应的跳转；这里没有循 环语句，需要自己用判断加跳转打造循环结构。不过，总的来说，很容易同Java程序对应上，就像我们上面所做的那样。《深入Java虚拟机》可以让我们更 好的了解JVM，也可以让帮助我们更好的理解ASM的程序。

有几个帮手可以让我们更好进行bytecode生成这个游戏。 javap，JDK带的一个工具，可以用来反汇编Java bytecode。在接触ASM的最初，我们对指令不是很熟悉的时候，可以考虑先把自己的目标写成Java程序，编译之后用“javap -c”来查看，所有的指令便一览无余，我们就可以照方抓药了。jad，它为我们提供了一个将Java class文件反编译为Java文件，通过它，我们就可以知道生成的bytecode究竟是不是自己想要的，我所展示与生成过程对应的Java代码便是借助于jad的力量完成的。

ASM很强大，这里只介绍了ASM中的代码生成，实际上，就连代码生成这一项工作介绍的都不那么完整，ASM还提供了另外一种生成方式，不过，用起来不如这里的GeneratorAdapter，需要更多的JVM指令的智慧，优势在于速度稍快一些。