使用Spoon在Java中分析、生成和转换代码

Kahen大约 8 分钟

使用Spoon在Java中分析、生成和转换代码

在本教程中，我们将展示如何使用Spoon库来解析、分析和转换Java源代码。

2. Spoon概述

在处理大型代码库时，我们通常需要为了特定目的而消化它们。例如：

生成聚合报告
查找给定类的用法，包括通过复杂的继承链间接使用
发现潜在的漏洞
自动重构

这个列表可以继续下去，但它们都有一个共同的模式。首先，它们需要我们扫描现有代码并为其构建内部表示。其次，我们将使用访问者模式或查询机制来查找我们感兴趣的元素。最后，我们将生成所需的输出。

Spoon库专注于前两个步骤，这样我们就可以专注于产生所需的结果。

当然，一个简单的基于文本的shell或Python管道可以为某些用例完成工作。然而，这种方法缺乏对扫描代码的深入理解，因此限制了我们能做的分析类型。

另一方面，Spoon创建了一个完整的代码库内存模型，允许以多种方式遍历它。在幕后，Spoon使用Eclipse的JDT编译器来解析源代码，结果是一个“高保真度”模型，不仅包括类、方法等，还包括所有语句和注释。

此外，Spoon可以处理语法无效的代码，并且不关心缺失的依赖，这很好，如果你必须深入到数百个git存储库的遗留代码中。

3.1. Maven依赖

要在我们的项目中使用Spoon库，我们需要将其添加为依赖项：

`<dependency>`
    `<groupId>`fr.inria.gforge.spoon`</groupId>`
    `<artifactId>`spoon-core`</artifactId>`
    `<version>`10.3.0`</version>`
`</dependency>`

最新版本可在Maven Central上找到。

请注意，从版本10开始，Spoon需要Java 11或更高版本才能运行。尽管如此，它可以解析并从Java源代码创建模型，直到版本16（截至本文撰写时）。

3.2. 解析代码

让我们从一个简单的示例开始。我们将使用Spoon来解析一个单独的Java类，并创建一个报告，统计公共、私有和受保护方法的数量。

_SpoonAPI_接口作为使用该库的主要入口点。获取此接口具体实现的标准方法是创建一个新的_Launcher_实例：

SpoonAPI spoon = new Launcher();

接下来，我们将使用_addInputResource()_告知我们想要分析的源代码的位置：

spoon.addInputResource("some/directory/SomeClass.java");

此方法接受单个类或目录的路径。在后一种情况下，将递归解析所有Java文件。此方法可以多次调用。例如，如果我们想一次解析多个存储库中的代码，就会这样调用。

现在，我们将使用_buildModel()_来创建_CtModel_实例，该实例保存有关所有处理过的代码的信息：

CtModel model = spoon.buildModel();

一种思考_CtModel_类的方式是，它在XML处理中扮演类似于_Document_类的角色：它是从树的根，可以从中到达任何其他元素。在我们的情况下，一个元素可以是一个类、方法、包变量声明，甚至是语句。

_CtModel_具有允许我们查找给定类型的元素并使用访问者模式样式回调遍历它的方法。在我们的例子中，我们将使用这两种方法来获取方法计数：

MethodSummary report = new MethodSummary();
model.filterChildren((el) -> el instanceof CtClass````````<?>````````)
  .forEach((CtClass````````<?>```````` clazz) -> processMethods(report, clazz));

首先，我们使用_filterChildren()_返回一个_CtQuery_实例，该实例仅匹配模型中的_CtClass_元素。接下来，我们使用_forEach()_处理每个匹配的条目。参数是一个lambda函数，调用_processMethods()_以类似模式评估类的方法是：

private void processMethods(MethodSummary report, CtClass````````<?>```````` ctClass) {
    ctClass.filterChildren((c) -> c instanceof CtMethod````````<?>````````)
      .forEach((CtMethod````````<?>```````` m) -> {
          if (m.isPublic()) {
              report.addPublicMethod();
          } else if (m.isPrivate()) {
              report.addPrivateMethod();
          } else if (m.isProtected()) {
              report.addProtectedMethod();
          } else {
              report.addPackagePrivateMethod();
          }
      });
}

在这里，根元素是正在分析的类，我们将遍历每个_CtMethod_，并根据其可见性更新报告计数器。

要测试此代码，我们将传递一个简单的类（可在线获取）并验证我们是否为每种方法可见性获得了正确的计数：

@Test
public void whenGenerateReport_thenSuccess() {
    ClassReporter reporter = new ClassReporter();
    MethodSummary report = reporter.generateMethodSummaryReport("src/test/resources/spoon/SpoonClassToTest.java");
    assertThat(report).isNotNull();
    assertThat(report.getPackagePrivateMethodCount()).isEqualTo(1);
    assertThat(report.getPublicMethodCount()).isEqualTo(1);
    assertThat(report.getPrivateMethodCount()).isEqualTo(1);
}

此代码也适用于解析的类具有语法错误。例如，给定这个语法无效的类：

public class BrokenClass {
    // 语法错误
    pluvic void brokenMethod() {}

    // 语法错误
    protected void protectedMethod() thraws Exception {}

    // 有效方法
    public void publicMethod() {}
}

我们仍然为公共、受保护和私有方法获得了正确的答案。至于破坏的方法，内部表示尝试获取尽可能多的信息。如果我们在_processMethods()_中设置断点，我们将能够看到_forEach()最终将接收到一个_CtMethod，其中包含有关无效方法的信息。

3.3. 转换代码

我们从_buildModel()_获得的_CtModel_实例直接支持转换。我们所要做的就是使用任何_CtElement_派生对象中可用的mutator方法。例如，我们可以通过使用_setSimpleName()_简单地重命名一个由_CtMethod_表示的方法：

CtMethod method = ...
method.setSimpleName("newname");

CtModel model = // ... 省略模型创建逻辑

model.filterChildren((el) -> el instanceof CtClass````````<?>````````)
  .forEach((CtClass````````<?>```````` cl) -> {
      CtComment comment = cl.getFactory()
        .createComment("Copyright(c) 2023 etc", CommentType.JAVADOC);
      cl.addComment(comment);
  });

模型修改发生在传递给_forEach_的lambda中。我们使用当前元素的_getFactory()并使用它来创建一个新的_CtComment，它代表一个“分离”的元素。然后我们使用_addComment()_将此注释添加到类中。

更改其他代码方面的模式是相同的。我们可以首先创建相应的_CtElement_，然后使用可用的mutator之一将其插入到适当的位置。

一旦我们完成了转换，我们使用_setOutputDirectory()_和_prettyprint()_将模型写回到文件系统：

spoon.setSourceOutputDirectory("./target");
spoon.prettyprint();

现在生成的代码将在类声明之前包含一个注释块：

// ... 省略包和导入声明
/**
 * Copyright(c) 2023 etc
 */
public class SpoonClassToTest {
    // ... 省略类代码
}

3.4. 使用处理器

在前面的示例中，代码检查和修改以一种临时的方式发生：我们获得一个模型实例并开始处理它。Spoon支持一种更有结构化的方式来使用_Processor_遍历代码。

这种方法的主要优点是它易于组合，允许主处理序列与分析/转换代码隔离。让我们通过将版权示例重写为_Processor_来展示这种方法：

public class AddCopyrightProcessor extends AbstractProcessor<CtClass````````<?>````````> {
    @Override
    public void process(CtClass````````<?>```````` clazz) {
        CtComment comment = getFactory().createComment("Copyright(c) 2023 etc", CommentType.JAVADOC);
        clazz.addComment(comment);
    }
}

_Processor_接口有几个方法，但Spoon提供了一个方便的基类，我们可以扩展：AbstractProcessor。这个类实现了Spoon需要的所有内容，但我们仍然必须实现一个方法：process()。Spoon将在模型处理阶段为模型中的每个匹配元素调用此方法。

现在，我们必须使用SpoonAPI中的_addProcessor()_方法告知Spoon我们的处理器：

spoon.addProcessor(new AddCopyrightProcessor());

最后，我们可以像以前一样运行Spoon。这次，顶层代码不必显式调用处理代码：

spoon.addInputResource("src/test/resources/spoon/SpoonClassToTest.java");
spoon.setSourceOutputDirectory("./target/spoon-processed");
spoon.buildModel();
spoon.process();
spoon.prettyprint();

实际上，这段代码几乎与Spoon从命令行使用时的代码相同。

3.5. 调整Spoon的_环境_

Spoon有一些处理选项，我们可以调整以适应我们的需求。开箱即用，这些选项假设合理的默认值，因此通常我们可以不改变它们。这是这些选项的简要列表：

启用/禁用严格的语法检查
Java合规级别
源文件编码
日志设置
源代码输出位置
Java输出编写器实现

要更改这些选项中的任何一个，我们首先使用_getEnvironment()访问Spoon的_环境，然后使用它来修改我们想要自定义的选项。例如，这就是我们如何在生成的文件中使用制表符而不是空格的方式：

spoon.getEnvironment().useTabulations(true);

另一个有趣的用例是替换默认的Java代码生成器。Spoon带有一个名为_SniperJavaPrettyPrinter_的替代生成器，它在生成输出时尽可能保留原始代码。

这个生成器的主要优点是它产生的代码与原始代码相比，只有在处理器进行更改的地方才会有所不同。要替换默认生成器，我们使用_setPrettyPrintGenerator()，它接受一个_Supplier，用于Spoon将使用的_PrettyPrinter_：

spoon.getEnvironment().setPrettyPrinterCreator(() -> new SniperJavaPrettyPrinter(spoon.getEnvironment()));

4. 结论

在本文中，我们展示了如何使用Spoon库来分析和修改Java源代码。

像往常一样，完整的代码可以在GitHub上找到。

Baeldung Logo Gravatar Image Gravatar Image Announcement Icon Baeldung REST API Post Footer Baeldung REST API Post Footer Icon