动态 Java 字节码操作框架比较

Question

有一些用于动态字节码生成、操作和编织的框架（BCEL、CGLIB、javassist、ASM、MPS）。我想了解它们，但由于我没有太多时间了解它们的所有细节，我希望看到一种比较图表，说明其中一个与其他的优缺点以及解释为什么。

在 SO 中，我发现很多问题都提出类似的问题，答案通常是“你可以使用 cglib 或 ASM”，或者“javassist 比 cglib 更好”，或者“BCEL 已经过时了，正在消亡”或者“ASM 正在消失”。最好的，因为它给出了 X 和 Y”。这些答案很有用，但并没有在我想要的范围内完全回答问题，更深入地比较它们并给出每个答案的优点和缺点。

Answer 1

字节码库分析

正如我从您在此处获得的答案以及您所查看的问题中的答案可以看出的那样，这些答案并未以您所说的明确方式正式解决该问题。您要求进行比较，同时这些答案已经模糊地说明了根据您的目标可能想要什么（例如，您需要知道字节码吗？[y/n]），或者太狭窄。

这个答案是对每个字节码框架的简短分析，并在最后提供了快速比较。

Javassist

• 微小（javassist.jar (3.21.0) 约为 707KB / javassist-rel_3_22_0_cr1.zip 约为 1.5MB）
• 高（/低）级别
• 简单明了
• 功能完整
• 需要最少甚至不需要类文件格式知识
• 需要中等的 Java 指令集知识
• 最少的学习工作量
• 在单行/多行编译和插入字节码方法中有一些怪癖

我个人更喜欢 Javassist，只是因为速度快您可以开始使用它并用它构建和操作类。 教程简单易懂。 jar 文件只有 707KB，非常方便携带；使其适合独立应用程序。

---

ASM

• 大 (asm-6.0_ALPHA-bin.zip 约为 2.9MB / asm-svn-latest.tar.gz (10/15/2016) 约为 41MB)
• 低（/高）级
• 综合
• 功能完整
• 推荐精通类文件格式的知识
• 需要精通 Java 指令集
• 中等学习努力（有点复杂）

ObjectWeb 的 ASM 是一个非常全面的库，它不缺少与构建、生成和加载类相关的任何内容。事实上，它甚至具有带有预定义分析器的类分析工具。据说这是字节码操作的行业标准。这也是我回避它的原因。

当我看到 ASM 的示例时，它似乎是一项繁琐的任务，需要大量的行来修改或加载一个类。甚至某些方法的某些参数对于 Java 来说似乎有点神秘和不合适。有了像 ACC_PUBLIC 这样的东西，以及到处都有 null 的大量方法调用，老实说，它看起来确实更适合像 C 这样的低级语言。为什么不简单地直接使用传递一个像“public”这样的字符串文字，还是一个枚举Modifier.PUBLIC？它更加友好且易于使用。然而，这是我的意见。

作为参考，这里有一个 ASM (4.0) 教程： https://www.javacodegeeks.com/2012/02/manipulated-java-class-files-with-asm.html

---

BCEL

• 小 (bcel-6.0-bin.zip 为 7.3MB / bcel-6.0-src.zip 为 1.4MB)
• 低级
• 足够
• 完成工作
• 需要精通 Java 指令集
• 易于学习

据我所知，这个库是您的基本类库，它可以让您完成您需要做的一切 — 如果您能抽出几个月或几个月的时间的话 年。

这里有一个 BCEL 教程，真正说明了这一点：http://www.geekyarticles.com/2011/08/manipulated-java-class-files-with-bcel.html?m=1

---

cglib

• 非常小（cglib-3.2.5.jar 为 295KB/源代码)
• 取决于 ASM
• 高级
• 功能完整（字节码生成）
• 很少或没有所需的 Java 字节码知识
• 易于学习
• 深奥的库

尽管您可以从类中读取信息，并且可以转换类，但该库似乎是为代理量身定制的。 教程都是关于代理的bean，它甚至提到它被使用通过“数据访问框架生成动态代理对象并拦截字段访问”。尽管如此，我认为您没有理由不能将它用于字节码操作而不是代理的更简单的目的。

---

ByteBuddy

• 小 bin/“巨大”src（相比之下） (byte-buddy-dep-1.8.12.jar 约为 2.72 MB / 1.8.12 (zip) 为 124.537 MB（确切的大小） ))
• 取决于 ASM
• 高级
• 功能完整
• 就个人而言，服务模式类的特殊名称 (ByteBuddy.class)
• 需要很少或不需要 Java 字节码知识
• 易于学习

长话短说，其中 BCEL缺乏，ByteBuddy 丰富。它使用一个名为 ByteBuddy 的主类，该类使用服务设计模式。您创建 ByteBuddy 的一个新实例，它代表您要修改的类。完成修改后，您可以使用 make() 创建一个 DynamicType。

他们的网站上有完整的教程和 API 文档。目的似乎是为了进行相当高级的修改。当谈到方法时，除了委托方法之外，官方教程或任何第三方教程中似乎没有任何关于从头开始创建方法的内容（编辑，如果你知道这个方法在哪里）已解释）。

您可以在其网站上找到他们的教程。可以在此处找到一些示例。

---

Java 类助手 (jCLA)

我正在构建自己的字节码库，它将称为 Java 类Assistant，简称 jCLA，因为我正在开发的另一个项目以及 Javassist 的上述怪癖，但在完成之前我不会将其发布到 GitHub，但该项目目前可供浏览GitHub 并提供反馈，因为它目前处于 alpha 阶段，但仍然足以作为一个基本的类库（目前正在编译器上工作；如果可以的话请帮助我！它将很快发布！）。

它将具有从 JAR 文件读取和写入类文件的能力，以及从源代码和类文件编译和反编译字节码的能力，这将是相当简单的。

整体使用模式使得使用 jCLA 相当容易，尽管可能需要一些时间来适应，并且在用于类修改的方法和方法参数风格上显然与 ByteBuddy 非常相似：

import jcla.ClassPool;
import jcla.ClassBuilder;
import jcla.ClassDefinition;
import jcla.MethodBuilder;
import jcla.FieldBuilder;

import jcla.jar.JavaArchive;

import jcla.classfile.ClassFile;

import jcla.io.ClassFileOutputStream;

public class JCLADemo {

    public static void main(String... args) {
        // get the class pool for this JVM instance
        ClassPool classes = ClassPool.getLocal();
        // get a class that is loaded in the JVM
        ClassDefinition classDefinition = classes.get("my.package.MyNumberPrinter");
        // create a class builder to modify the class
        ClassBuilder clMyNumberPrinter= new ClassBuilder(classDefinition);

        // create a new method with name printNumber
        MethodBuilder printNumber = new MethodBuilder("printNumber");
        // add access modifiers (use modifiers() for convenience)
        printNumber.modifier(Modifier.PUBLIC);
        // set return type (void)
        printNumber.returns("void");
        // add a parameter (use parameters() for convenience)
        printNumber.parameter("int", "number");
        // set the body of the method (compiled to bytecode)
        // use body(byte[]) or insert(byte[]) for bytecode
        // insert(String) also compiles to bytecode
        printNumber.body("System.out.println(\"the number is: \" + number\");");
        // add the method to the class
        // you can use method(MethodDefinition) or method(MethodBuilder)
        clMyNumberPrinter.method(printNumber.build());

        // add a field to the class
        FieldBuilder HELLO = new FieldBuilder("HELLO");
        // set the modifiers for hello; convenience method example
        HELLO.modifiers(Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL);
        // set the type of this field
        HELLO.type("java.lang.String");
        // set the actual value of this field
        // this overloaded method expects a VariableInitializer production
        HELLO.value("\"Hello from \" + getClass().getSimpleName() + \"!\"");

        // add the field to the class (same overloads as clMyNumberPrinter.method())
        clMyNumberPrinter.field(HELLO.build());

        // redefine
        classDefinition = clMyNumberPrinter.build();
        // update the class definition in the JVM's ClassPool
        // (this updates the actual JVM's loaded class)
        classes.update(classDefinition);

        // write to disk
        JavaArchive archive = new JavaArchive("myjar.jar");
        ClassFile classFile = new ClassFile(classDefinition);
        ClassFileOutputStream stream = new ClassFileOutputStream(archive);

        try {
            stream.write(classFile);
        } catch(IOException e) {
            // print to System.out
        } finally {
            stream.close();
        }
    }

}

(VariableInitializer 生产规范方便起见。）

正如上面的代码片段所暗示的那样，每个ClassDefinition都是不可变的。这使得 jCLA 更加安全、线程安全、网络安全且易于使用。该系统主要围绕 ClassDefinitions 作为以高级方式查询类信息的选择对象，并且该系统的构建方式是 ClassDefinition 与目标类型（例如 ClassBuilder 和 ClassFile）之间进行转换。

jCLA 对类数据使用分层系统。在底部，您有不可变的 ClassFile：类文件的结构或软件表示。然后，您就拥有了不可变的 ClassDefinition，它们从 ClassFile 转换为对修改或从类中读取数据的程序员来说更不那么神秘、更易于管理和有用的东西，并且与通过 访问的信息相当java.lang.Class。最后，您有可变的 ClassBuilder。 ClassBuilder 是修改或创建类的方式。它允许您直接从构建器的当前状态创建一个ClassDefinition。没有必要为每个类创建新的构建器，因为 reset() 方法将清除变量。

（该库的分析将在准备好发布后立即提供。）

但在那之前，截至今天：

• 小（src：227.704 KB，精确，2018 年 6 月 2 日）
• 自给自足（除了 Java 附带的库之外没有任何依赖项） )
• 高级
• 无需了解 java 字节码或类文件（对于第 1 层 API，例如 ClassBuilder、ClassDefinition 等）
• 易于学习（如果来自 ByteBuddy，则更容易）

我仍然不过建议学习一下java字节码。这将使调试更加容易。

---

比较

考虑到所有这些分析（目前不包括 jCLA），最广泛的框架是 ASM，最容易使用的是 Javassist，最基本的实现是 BCEL，最高级的字节码生成和代理是 cglib。

ByteBuddy 值得有自己的解释。它像 Javassist 一样易于使用，但似乎缺乏一些使 Javassist 变得出色的功能，例如从头开始创建方法，因此您显然需要使用 ASM。如果您需要对类进行一些轻量级修改，ByteBuddy 是不错的选择，但如果要在保持高级抽象的同时对类进行更高级的修改，Javassist 是更好的选择。

注意：如果我错过了图书馆，请编辑此答案或在评论中提及。

Answer 2

如果您对字节码生成的兴趣只是使用它，那么比较图就变得相当简单：

您需要了解字节码吗？

对于 javassist ：否

对于所有其他人：是

当然，即使使用 javassist，您也可能在某些时候遇到字节码概念。同样，其他一些库（例如 ASM）具有更高级的 API 和/或工具支持，可以让您免受许多字节码详细信息的影响。

javassist 的真正区别在于它包含一个基本的 java 编译器。这使得编写复杂的类转换变得非常容易：您只需将 java 片段放入 String 中，并使用该库将其插入到程序中的特定点。包含的编译器将构建等效的字节码，然后将其插入到现有的类中。

Answer 3

首先，这完全取决于您的任务。您想要生成新代码还是分析现有字节码以及您可能需要多复杂的分析。还有你想投入多少时间来学习 Java 字节码。您可以将字节码框架分解为提供高级 API 的框架，这样当您需要了解 JVM 或使用一些字节码时，您就可以摆脱学习低级操作码和 JVM 内部结构（例如 javaassist 和 CGLIB）和低级框架的麻烦。生成工具（ASM 和 BCEL）。对于分析，BCEL 历史上发展得更多一些，但 ASM 提供了易于扩展的不错的功能。另请注意，ASM 可能是唯一为 Java 7 中默认启用的新字节码验证器所需的 STACK_MAP 信息提供最高级支持的框架。